![]() |
Diffusion .NET Classic API - Core and Common
5.9.4
|
The interface for a Diffusion topic connector. More...
Public Member Functions | |
void | AddGlobalTopicListener (ITopicListener listener) |
Adds a 'global' topic listener, i.e. a listener that monitors ALL topics. More... | |
void | AddTopicListener (Action< TopicMessageImpl > listener, TopicSet topics, Regex topicRegex) |
Adds a topic listener with an Action method. More... | |
void | AddTopicListener (ITopicListener listener, TopicSet topics) |
Adds a topic listener with an interface method. More... | |
void | AddTopicListener (ITopicListener listener, params string[] topics) |
Adds a topic listener with an interface method. More... | |
void | AddServerConnectionListener (IServerConnectionListener listener) |
Adds a server connection listener with an interface method. More... | |
void | RemoveTopicListener (ITopicListener listener) |
Removes a topic listener. More... | |
IServiceTopicHandler | CreateServiceTopicHandler (ITopicMessage message, IServiceTopicListener listener) |
Creates a handler object for a 'service' topic. More... | |
IPagedTopicHandler | CreatePagedTopicHandler (ITopicMessage message, IPagedTopicListener listener) |
Creates a handler object for a 'paged' Topic. More... | |
ITopicNotifyTopicHandler | CreateTopicNotifyTopicHandler (ITopicMessage message, ITopicNotifyTopicListener listener) |
Creates a handler for a 'topic notify' topic. More... | |
![]() | |
void | Connect () |
Attempts to establish a connection to a Diffusion server. More... | |
void | Connect (EventHandler< MessageEventArgs< TopicMessageImpl >> successEvent, EventHandler< ServerClosedEventArgs > failureEvent, EventHandler< ServerClosedEventArgs > disconnectedEvent, EventHandler< MessageEventArgs< TopicMessageImpl >> messageReceivedEvent) |
Attempts to establish a connection to a Diffusion server with callbacks. More... | |
void | Reconnect () |
Attempts to re-establish a connection to a Diffusion server. More... | |
void | Disconnect () |
Closes the connection to the Diffusion server. More... | |
Properties | |
DateTime | LastInteraction [get] |
Returns the time of the last interaction (send or receive) with the Diffusion server. More... | |
![]() | |
V4Credentials | Credentials [get, set] |
Get/set the credentials. More... | |
IConnectionDetails | ConnectionDetails [get, set] |
Get/set the connection details. More... | |
IServerDetails | ActiveServerDetails [get] |
Get the server details object currently in use. More... | |
int | MaxPacketSize [get, set] |
Get/set the maximum packet size. More... | |
bool | IsConnected [get] |
Returns whether this connector is connected to a Diffusion server. More... | |
string | ClientId [get] |
Gets the client Id. More... | |
ConnectionCapabilities | Capabilities [get, set] |
Get/set the connection capabilities. More... | |
![]() | |
ReadOnlyCollection < IServerConnectionListener > | ServerConnectionListeners [get] |
Get/set the server listeners. More... | |
IServerPingResponseListener | PingListener [get, set] |
Get/set the ping listener. More... | |
IServerAckListener | AckListener [get, set] |
Get/set the ack listener. More... | |
![]() | |
bool | RestoreState [get, set] |
Indicates whether to attempt to restore state with an accordingly-configured Diffusion server upon loss of connection and subsequent reconnection. More... | |
Additional Inherited Members | |
![]() | |
EventHandler < ServerDetailsEventArgs > | ConnectionDetailsAcquired |
The event which is fired when a set of server details is acquired from the list. More... | |
EventHandler< EventArgs > | ConnectionServiceStopped |
The event raised when the connection service is stopped. More... | |
The interface for a Diffusion topic connector.
void PushTechnology.DiffusionCore.Connection.IDiffusionTopicConnector.AddGlobalTopicListener | ( | ITopicListener | listener | ) |
Adds a 'global' topic listener, i.e. a listener that monitors ALL topics.
listener |
void PushTechnology.DiffusionCore.Connection.IDiffusionTopicConnector.AddServerConnectionListener | ( | IServerConnectionListener | listener | ) |
Adds a server connection listener with an interface method.
listener |
void PushTechnology.DiffusionCore.Connection.IDiffusionTopicConnector.AddTopicListener | ( | Action< TopicMessageImpl > | listener, |
TopicSet | topics, | ||
Regex | topicRegex | ||
) |
Adds a topic listener with an Action method.
listener | |
topics | |
topicRegex |
void PushTechnology.DiffusionCore.Connection.IDiffusionTopicConnector.AddTopicListener | ( | ITopicListener | listener, |
TopicSet | topics | ||
) |
Adds a topic listener with an interface method.
listener | |
topics |
void PushTechnology.DiffusionCore.Connection.IDiffusionTopicConnector.AddTopicListener | ( | ITopicListener | listener, |
params string[] | topics | ||
) |
Adds a topic listener with an interface method.
listener | |
topics |
IPagedTopicHandler PushTechnology.DiffusionCore.Connection.IDiffusionTopicConnector.CreatePagedTopicHandler | ( | ITopicMessage | message, |
IPagedTopicListener | listener | ||
) |
Creates a handler object for a 'paged' Topic.
This would be called in response to receiving an ITopicMessage.IsPagedLoad message from a paged topic as a result of subscribing to it. Note that no other messages would be received from a paged topic until the returned handler is used to IPagedTopicHandler.Open( int, int ) the topic.
message | The load message received from the topic. |
listener | An object that is to receive all notifications from the topic. |
IServiceTopicHandler PushTechnology.DiffusionCore.Connection.IDiffusionTopicConnector.CreateServiceTopicHandler | ( | ITopicMessage | message, |
IServiceTopicListener | listener | ||
) |
Creates a handler object for a 'service' topic.
This would be called in response to receiving an ITopicMessage.IsServiceLoad message from a service topic as a result of subscribing to it. Note that no other messages would be received from a service topic other than via the specified IServiceTopicListener.
message | The load message received from the topic. |
listener | An object that is to receive all service replies and notifications. |
ITopicNotifyTopicHandler PushTechnology.DiffusionCore.Connection.IDiffusionTopicConnector.CreateTopicNotifyTopicHandler | ( | ITopicMessage | message, |
ITopicNotifyTopicListener | listener | ||
) |
Creates a handler for a 'topic notify' topic.
This would be called in response to receiving an ITopicMessage.IsTopicNotifyLoad load message from a topic notify topic as a result of subscribing to it. Note that no other messages would be received from a topic notify topic until the returned handler is used to select notifications required.
message | The load message received from the topic. |
listener | An object that is to receive all notifications from the topic. |
void PushTechnology.DiffusionCore.Connection.IDiffusionTopicConnector.RemoveTopicListener | ( | ITopicListener | listener | ) |
Removes a topic listener.
listener |
|
get |
Returns the time of the last interaction (send or receive) with the Diffusion server.