DataSource.NET  7.1.32.168791-9652659d
Caplin.DataSource.Subscription.ISubscriptionListener Interface Reference

The ISubscriptionListener interface allows applications to receive events raised for an Caplin.DataSource.Subscription.ISubscription. More...

Inheritance diagram for Caplin.DataSource.Subscription.ISubscriptionListener:
Caplin.DataSource.Subscription.BaseSubscriptionListener

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 JsonUpdated (ISubscription subscription, IPeer peer, IJsonMessage update)
 Called when a JSON update 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...
 

Detailed Description

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.

Member Function Documentation

void Caplin.DataSource.Subscription.ISubscriptionListener.ContainerUpdated ( ISubscription  subscription,
IPeer  peer,
IContainerMessage  update 
)

Called when a container update is received.

Parameters
subscriptionThe subscription for which the update occurred.
peerThe DataSource peer supplying the update.
updateThe 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.

Parameters
subscriptionThe subscription for which the update occurred.
peerThe DataSource peer supplying the update.
updateThe message update.

Implemented in Caplin.DataSource.Subscription.BaseSubscriptionListener.

void Caplin.DataSource.Subscription.ISubscriptionListener.JsonUpdated ( ISubscription  subscription,
IPeer  peer,
IJsonMessage  update 
)

Called when a JSON update is received.

Parameters
subscriptionThe subscription for which the update occurred.
peerThe DataSource peer supplying the update.
updateThe JSON 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.

Parameters
subscriptionThe subscription for which the update occurred.
peerThe DataSource peer supplying the update.
updateThe 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.

Parameters
subscriptionThe subscription for which the update occurred.
peerThe DataSource peer supplying the update.
updateThe 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.

Parameters
subscriptionThe subscription for which the update occurred.
peerThe DataSource peer supplying the update.
updateThe 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.

Parameters
subscriptionThe subscription for which the update occurred.
peerThe DataSource peer supplying the update.
updateThe 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.

Parameters
subscriptionThe subscription for which the update occurred.
peerThe DataSource peer supplying the update.
updateThe 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.

Parameters
subscriptionThe subscription for which the update occurred.
peerThe DataSource peer supplying the update.
updateThe 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.

Parameters
subscriptionThe subscription for which the update occurred.
peerThe DataSource peer supplying the update.
updateThe 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.

Parameters
subscriptionThe subscription for which the error occurred.
peerThe DataSource peer that sent this subscription error.
evThe 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.

Parameters
subscriptionThe subscription for which the status change occurred.
peerThe DataSource peer that sent this change in subscription status.
evThe subscription status event.

Implemented in Caplin.DataSource.Subscription.BaseSubscriptionListener.


Generated on Wed Oct 18 2023 17:20:25 for DataSource.NET