DataSource.NET
7.1.5.312018
|
The ISubscriptionListener interface allows applications to receive events raised for an Caplin.DataSource.Subscription.ISubscription. More...
Public Member Functions | |
void | ContainerUpdated (ISubscription subscription, IPeer peer, IContainerMessage update) |
Called when a container update is received. More... | |
void | GenericMessageUpdated (ISubscription subscription, IPeer peer, IGenericMessage update) |
Called when an update to generic data in a message is received. More... | |
void | NewsUpdated (ISubscription subscription, IPeer peer, INewsMessage update) |
Called when a news headline update is received. More... | |
void | PageUpdated (ISubscription subscription, IPeer peer, IPageMessage update) |
Called when a page update is received. More... | |
void | PermissionUpdated (ISubscription subscription, IPeer peer, IPermissionMessage update) |
Called when when a permission update is received. More... | |
void | RecordType2Updated (ISubscription subscription, IPeer peer, IRecordType2Message update) |
Called when an update to type 2 data in a record is received. More... | |
void | RecordType3Updated (ISubscription subscription, IPeer peer, IRecordType3Message update) |
Called when an update to type3 data in a record is received. More... | |
void | RecordUpdated (ISubscription subscription, IPeer peer, IRecordType1Message update) |
Called when an update to type 1 data in a record is received. More... | |
void | StoryUpdated (ISubscription subscription, IPeer peer, IStoryMessage update) |
Called when a story update is received. More... | |
void | SubjectErrorReceived (ISubscription subscription, IPeer peer, ISubjectErrorEvent ev) |
Called when there is an error in a subscription. More... | |
void | SubjectStatusReceived (ISubscription subscription, IPeer peer, ISubjectStatusEvent ev) |
Called when there is a change in the status of a subscription. More... | |
The ISubscriptionListener interface allows applications to receive events raised for an Caplin.DataSource.Subscription.ISubscription.
Implement this interface to receive subscription events. You must implement all the callback methods; there is one for each subject type (Record, Pages, News, and so on). Alternatively, you can derive your ISubscriptionListener implementation from the Caplin.DataSource.Subscription.BaseSubscriptionListener class and then override
the methods corresponding to the subject types for which you want to handle events.
The ISubscriptionListener methods are not called on a dedicated worker thread. Therefore, if any of these methods are likely take a relatively long time to execute, they should be coded to run in a separate thread.
void Caplin.DataSource.Subscription.ISubscriptionListener.ContainerUpdated | ( | ISubscription | subscription, |
IPeer | peer, | ||
IContainerMessage | update | ||
) |
Called when a container update is received.
subscription | The subscription for which the update occurred. |
peer | The DataSource peer supplying the update. |
update | The container update. |
The operations on the IContainerMessage are not normalized: The message may contain contradictory messages, for example an add for an element followed by a delete for the same element.
Implemented in Caplin.DataSource.Subscription.BaseSubscriptionListener.
void Caplin.DataSource.Subscription.ISubscriptionListener.GenericMessageUpdated | ( | ISubscription | subscription, |
IPeer | peer, | ||
IGenericMessage | update | ||
) |
Called when an update to generic data in a message is received.
subscription | The subscription for which the update occurred. |
peer | The DataSource peer supplying the update. |
update | The message update. |
Implemented in Caplin.DataSource.Subscription.BaseSubscriptionListener.
void Caplin.DataSource.Subscription.ISubscriptionListener.NewsUpdated | ( | ISubscription | subscription, |
IPeer | peer, | ||
INewsMessage | update | ||
) |
Called when a news headline update is received.
subscription | The subscription for which the update occurred. |
peer | The DataSource peer supplying the update. |
update | The permission update. |
Implemented in Caplin.DataSource.Subscription.BaseSubscriptionListener.
void Caplin.DataSource.Subscription.ISubscriptionListener.PageUpdated | ( | ISubscription | subscription, |
IPeer | peer, | ||
IPageMessage | update | ||
) |
Called when a page update is received.
subscription | The subscription for which the update occurred. |
peer | The DataSource peer supplying the update. |
update | The page update. |
Implemented in Caplin.DataSource.Subscription.BaseSubscriptionListener.
void Caplin.DataSource.Subscription.ISubscriptionListener.PermissionUpdated | ( | ISubscription | subscription, |
IPeer | peer, | ||
IPermissionMessage | update | ||
) |
Called when when a permission update is received.
subscription | The subscription for which the update occurred. |
peer | The DataSource peer supplying the update. |
update | The permission update. |
Implemented in Caplin.DataSource.Subscription.BaseSubscriptionListener.
void Caplin.DataSource.Subscription.ISubscriptionListener.RecordType2Updated | ( | ISubscription | subscription, |
IPeer | peer, | ||
IRecordType2Message | update | ||
) |
Called when an update to type 2 data in a record is received.
subscription | The subscription for which the update occurred. |
peer | The DataSource peer supplying the update. |
update | The record update. |
Implemented in Caplin.DataSource.Subscription.BaseSubscriptionListener.
void Caplin.DataSource.Subscription.ISubscriptionListener.RecordType3Updated | ( | ISubscription | subscription, |
IPeer | peer, | ||
IRecordType3Message | update | ||
) |
Called when an update to type3 data in a record is received.
subscription | The subscription for which the update occurred. |
peer | The DataSource peer supplying the update. |
update | The record update. |
Implemented in Caplin.DataSource.Subscription.BaseSubscriptionListener.
void Caplin.DataSource.Subscription.ISubscriptionListener.RecordUpdated | ( | ISubscription | subscription, |
IPeer | peer, | ||
IRecordType1Message | update | ||
) |
Called when an update to type 1 data in a record is received.
subscription | The subscription for which the update occurred. |
peer | The DataSource peer supplying the update. |
update | The record update. |
Implemented in Caplin.DataSource.Subscription.BaseSubscriptionListener.
void Caplin.DataSource.Subscription.ISubscriptionListener.StoryUpdated | ( | ISubscription | subscription, |
IPeer | peer, | ||
IStoryMessage | update | ||
) |
Called when a story update is received.
subscription | The subscription for which the update occurred. |
peer | The DataSource peer supplying the update. |
update | The story update. |
Implemented in Caplin.DataSource.Subscription.BaseSubscriptionListener.
void Caplin.DataSource.Subscription.ISubscriptionListener.SubjectErrorReceived | ( | ISubscription | subscription, |
IPeer | peer, | ||
ISubjectErrorEvent | ev | ||
) |
Called when there is an error in a subscription.
subscription | The subscription for which the error occurred. |
peer | The DataSource peer that sent this subscription error. |
ev | The subscription error. |
Implemented in Caplin.DataSource.Subscription.BaseSubscriptionListener.
void Caplin.DataSource.Subscription.ISubscriptionListener.SubjectStatusReceived | ( | ISubscription | subscription, |
IPeer | peer, | ||
ISubjectStatusEvent | ev | ||
) |
Called when there is a change in the status of a subscription.
subscription | The subscription for which the status change occurred. |
peer | The DataSource peer that sent this change in subscription status. |
ev | The subscription status event. |
Implemented in Caplin.DataSource.Subscription.BaseSubscriptionListener.