Skip to content

Commit ae8becf

Browse files
cicoyleJoshVanL
andauthored
add note on unsubscribeConfiguration being deprecated (#457)
* add note on unsubscribeConfiguration being deprecated Signed-off-by: Cassandra Coyle <[email protected]> * Update client/client.go Co-authored-by: Josh van Leeuwen <[email protected]> Signed-off-by: Cassie Coyle <[email protected]> --------- Signed-off-by: Cassandra Coyle <[email protected]> Signed-off-by: Cassie Coyle <[email protected]> Co-authored-by: Josh van Leeuwen <[email protected]>
1 parent a0e6f2e commit ae8becf

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

client/client.go

+2
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,8 @@ type Client interface {
141141
// SubscribeConfigurationItems can subscribe the change of configuration items by storeName and keys, and return subscription id
142142
SubscribeConfigurationItems(ctx context.Context, storeName string, keys []string, handler ConfigurationHandleFunction, opts ...ConfigurationOpt) (string, error)
143143

144+
// UnsubscribeConfigurationItems stops the subscription with target store's and ID.
145+
// Deprecated: Closing the `SubscribeConfigurationItems` stream (closing the given context) will unsubscribe the client and should be used in favor of `UnsubscribeConfigurationItems`.
144146
// UnsubscribeConfigurationItems can stop the subscription with target store's and id
145147
UnsubscribeConfigurationItems(ctx context.Context, storeName string, id string, opts ...ConfigurationOpt) error
146148

0 commit comments

Comments
 (0)