Interface used to manage all subscriptions in AMPS. This includes: subscribing, unsubscribing and resubscribing. More...
Inheritance diagram for AMPS.Client.SubscriptionManager:
Public Member Functions | |
| void | subscribe (MessageHandler messageHandler, Message message) |
| Subscribe to a message using the provided message handler and message. More... | |
| void | unsubscribe (CommandId subId) |
| Unsubscribe from a subscription using the provided subscription ID. More... | |
| void | clear () |
| Clear all subscriptions. More... | |
| void | resubscribe (Client client) |
| Resubscribe to subscriptions using the provided client. More... | |
| void | setFailedResubscribeHandler (FailedResubscribeHandler failureHandler) |
| Set the handler for failed resubscribe attempts. More... | |
| FailedResubscribeHandler | getFailedResubscribeHandler () |
| Get the handler for failed resubscribe attempts. More... | |
Detailed Description
Interface used to manage all subscriptions in AMPS. This includes: subscribing, unsubscribing and resubscribing.
Member Function Documentation
◆ clear()
| void AMPS.Client.SubscriptionManager.clear | ( | ) |
Clear all subscriptions.
Implemented in AMPS.Client.MemorySubscriptionManager, and AMPS.Client.DefaultSubscriptionManager.
◆ getFailedResubscribeHandler()
| FailedResubscribeHandler AMPS.Client.SubscriptionManager.getFailedResubscribeHandler | ( | ) |
Get the handler for failed resubscribe attempts.
- Returns
- The handler for failed resubscribe attempts.
Implemented in AMPS.Client.MemorySubscriptionManager, and AMPS.Client.DefaultSubscriptionManager.
◆ resubscribe()
| void AMPS.Client.SubscriptionManager.resubscribe | ( | Client | client | ) |
Resubscribe to subscriptions using the provided client.
- Parameters
-
client The client to use for resubscribing.
Implemented in AMPS.Client.MemorySubscriptionManager, and AMPS.Client.DefaultSubscriptionManager.
◆ setFailedResubscribeHandler()
| void AMPS.Client.SubscriptionManager.setFailedResubscribeHandler | ( | FailedResubscribeHandler | failureHandler | ) |
Set the handler for failed resubscribe attempts.
- Parameters
-
failureHandler The handler for failed resubscribe attempts.
Implemented in AMPS.Client.MemorySubscriptionManager, and AMPS.Client.DefaultSubscriptionManager.
◆ subscribe()
| void AMPS.Client.SubscriptionManager.subscribe | ( | MessageHandler | messageHandler, |
| Message | message | ||
| ) |
Subscribe to a message using the provided message handler and message.
- Parameters
-
messageHandler The message handler to handle incoming messages. message The message to subscribe to.
Implemented in AMPS.Client.MemorySubscriptionManager, and AMPS.Client.DefaultSubscriptionManager.
◆ unsubscribe()
| void AMPS.Client.SubscriptionManager.unsubscribe | ( | CommandId | subId | ) |
Unsubscribe from a subscription using the provided subscription ID.
- Parameters
-
subId
Implemented in AMPS.Client.MemorySubscriptionManager, and AMPS.Client.DefaultSubscriptionManager.
The documentation for this interface was generated from the following file:
- AMPS.Client/SubscriptionManager.cs
