Interface IConnection
IConnection interface.
public interface IConnection- Extension Methods
Properties
- ConnectionID
Gets the connection ID.
- IsReceiving
Gets a value indicating whether the receiving thread is active
- IsShuttingDown
Gets a value indicating whether the connection is shutting down.
- ServerDetails
Gets the server details.
- UserDomainName
Gets the user domain name.
Methods
- AddSubscription(string, params SubscriptionFilter[])
Adds the specified subscription filters to the specified set.
- ClearSubscriptions(string)
Clears the subscriptions for the specified set.
- GetProtocol(string, string)
Retrieves information about the specified protocol.
- HandleMessage(DMSMessage)
Handles the specified message.
- HandleMessages(DMSMessage[])
Handles the specified messages.
- HandleSingleResponseMessage(DMSMessage)
Handles the specified message.
- RemoveSubscription(string, params SubscriptionFilter[])
Removes the specified subscription filters from the specified set.
- ReplaceSubscription(string, params SubscriptionFilter[])
Replaces the subscriptions of the specified set with the specified subscription filters.
- Subscribe(params SubscriptionFilter[])
Creates a subscription using the specified subscription filters.
- TrackAddSubscription(string, params SubscriptionFilter[])
Tracks the add subscription.
- TrackClearSubscriptions(string)
Tracks clear subscription.
- TrackRemoveSubscription(string, params SubscriptionFilter[])
Tracks the remove subscription.
- TrackReplaceSubscription(string, params SubscriptionFilter[])
Tracks the replace subscriptions.
- TrackSubscribe(params SubscriptionFilter[])
Tracks the specified subscription.
- TrackUpdateSubscription(UpdateSubscriptionMultiMessage)
Tracks the update subscription.
- Unsubscribe()
Clears the subscriptions.
Events
- OnAbnormalClose
Occurs on an abnormal close.
- OnClose
Event that is raised when the connection gets closed. Useful when passing the connection to other threads that should be made aware when the connection is closed so that pending operations can be aborted.
- OnEventsDropped
Called when the server has dropped a series of events for a client. This happens when the server is unable to get the events to the client fast enough and typically indicates a problem on the server. The dropping of events does not close the connection. Instead, the Connection object is still valid. When this event has been fired on a connection, Cube will show a pop-up indicating that the state is incomplete.
- OnNewMessage
Occurs when a new message arrives. Main handler for incoming events.
- OnSubscriptionComplete
Fired after the server has completed applying a subscription update. If the client has launched multiple subscription updates after each other, there is no reference to which update is completed. Receiving this event also does not mean that all initial events from the cluster have been received by the client. It mainly means that the DataMiner Agent to which the client is directly connected is now aware of the subscription.
- OnSubscriptionState
Used internally for the Subscription Stages functionality. Using the TrackSubscribe API is preferred to using this event.