Skip to content

Commit

Permalink
Update client/client.go
Browse files Browse the repository at this point in the history
Co-authored-by: Josh van Leeuwen <[email protected]>
Signed-off-by: Cassie Coyle <[email protected]>
  • Loading branch information
cicoyle and JoshVanL authored Sep 26, 2023
1 parent 33379d2 commit e2a8b2d
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions client/client.go
Original file line number Diff line number Diff line change
Expand Up @@ -142,8 +142,8 @@ type Client interface {
// SubscribeConfigurationItems can subscribe the change of configuration items by storeName and keys, and return subscription id
SubscribeConfigurationItems(ctx context.Context, storeName string, keys []string, handler ConfigurationHandleFunction, opts ...ConfigurationOpt) (string, error)

// This function calls UnsubscribeConfiguration which is deprecated and exists for backwards-compatibility only
// The unsubscribe occurs when closing the subscription stream
// UnsubscribeConfigurationItems stops the subscription with target store's and ID.
// Deprecated: Closing the `SubscribeConfigurationItems` stream (closing the given context) will unsubscribe the client and should be used in favor of `UnsubscribeConfigurationItems`.
// UnsubscribeConfigurationItems can stop the subscription with target store's and id
UnsubscribeConfigurationItems(ctx context.Context, storeName string, id string, opts ...ConfigurationOpt) error

Expand Down

0 comments on commit e2a8b2d

Please sign in to comment.