DataSource.NET  7.1.12.29475-aead280
Caplin.DataSource.Subscription.BaseSubscriptionListener Class Reference

An implementation of Caplin.DataSource.Subscription.ISubscriptionListener containing empty callback methods. you can derivce your implementation of Caplin.DataSource.Subscription.ISubscriptionListener from this class, and override selected callback methods with full implementations as required. More...

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

Public Member Functions

virtual void ContainerUpdated (ISubscription subscription, IPeer peer, IContainerMessage update)
 Called when a container update is received. More...
 
virtual void GenericMessageUpdated (ISubscription subscription, IPeer peer, IGenericMessage update)
 Called when an update to generic data in a message is received. More...
 
virtual void JsonUpdated (ISubscription subscription, IPeer peer, IJsonMessage update)
 Called when a JSON update is received. More...
 
virtual void NewsUpdated (ISubscription subscription, IPeer peer, INewsMessage update)
 Called when a news headline update is received. More...
 
virtual void PageUpdated (ISubscription subscription, IPeer peer, IPageMessage update)
 Called when a page update is received. More...
 
virtual void PermissionUpdated (ISubscription subscription, IPeer peer, IPermissionMessage update)
 Called when when a permission update is received. More...
 
virtual void RecordType2Updated (ISubscription subscription, IPeer peer, IRecordType2Message update)
 Called when an update to type 2 data in a record is received. More...
 
virtual void RecordType3Updated (ISubscription subscription, IPeer peer, IRecordType3Message update)
 Called when an update to type3 data in a record is received. More...
 
virtual void RecordUpdated (ISubscription subscription, IPeer peer, IRecordType1Message update)
 Called when an update to type 1 data in a record is received. More...
 
virtual void StoryUpdated (ISubscription subscription, IPeer peer, IStoryMessage update)
 Called when a story update is received. More...
 
virtual void SubjectErrorReceived (ISubscription subscription, IPeer peer, ISubjectErrorEvent ev)
 Called when there is an error in a subscription. More...
 
virtual void SubjectStatusReceived (ISubscription subscription, IPeer peer, ISubjectStatusEvent ev)
 Called when there is a change in the status of a subscription. More...
 

Detailed Description

An implementation of Caplin.DataSource.Subscription.ISubscriptionListener containing empty callback methods. you can derivce your implementation of Caplin.DataSource.Subscription.ISubscriptionListener from this class, and override selected callback methods with full implementations as required.

The following example provides an example of overriding the RecordUpdated member and providing a custom implementation.

using System;
using System.Collections.Generic;
using System.Text;
namespace DataSourceExamples.Subscriber
{
class ExampleSubscriptionListenerFromBase : BaseSubscriptionListener
{
public override void RecordUpdated(ISubscription sub, IPeer peer, IRecordType1Message msg)
{
Console.WriteLine("Received: " + msg.ToString());
}
}
}

/remarks>

Member Function Documentation

virtual void Caplin.DataSource.Subscription.BaseSubscriptionListener.ContainerUpdated ( ISubscription  subscription,
IPeer  peer,
IContainerMessage  update 
)
inlinevirtual

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.

You should override this method if you have derived your Caplin.DataSource.Subscription.ISubscriptionListener implementation from BaseSubscriptionListener and want to handle container updates.

Implements Caplin.DataSource.Subscription.ISubscriptionListener.

virtual void Caplin.DataSource.Subscription.BaseSubscriptionListener.GenericMessageUpdated ( ISubscription  subscription,
IPeer  peer,
IGenericMessage  update 
)
inlinevirtual

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.

You should override this method if you have derived your Caplin.DataSource.Subscription.ISubscriptionListener implementation from BaseSubscriptionListener and want to handle generic message updates.

Implements Caplin.DataSource.Subscription.ISubscriptionListener.

virtual void Caplin.DataSource.Subscription.BaseSubscriptionListener.JsonUpdated ( ISubscription  subscription,
IPeer  peer,
IJsonMessage  update 
)
inlinevirtual

Called when a JSON update is received.

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

You should override this method if you have derived your Caplin.DataSource.Subscription.ISubscriptionListener implementation from BaseSubscriptionListener and want to handle JSON updates.

Implements Caplin.DataSource.Subscription.ISubscriptionListener.

virtual void Caplin.DataSource.Subscription.BaseSubscriptionListener.NewsUpdated ( ISubscription  subscription,
IPeer  peer,
INewsMessage  update 
)
inlinevirtual

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.

You should override this method if you have derived your Caplin.DataSource.Subscription.ISubscriptionListener implementation from BaseSubscriptionListener and want to handle news updates.

Implements Caplin.DataSource.Subscription.ISubscriptionListener.

virtual void Caplin.DataSource.Subscription.BaseSubscriptionListener.PageUpdated ( ISubscription  subscription,
IPeer  peer,
IPageMessage  update 
)
inlinevirtual

Called when a page update is received.

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

You should override this method if you have derived your Caplin.DataSource.Subscription.ISubscriptionListener implementation from BaseSubscriptionListener and want to handle page updates.

Implements Caplin.DataSource.Subscription.ISubscriptionListener.

virtual void Caplin.DataSource.Subscription.BaseSubscriptionListener.PermissionUpdated ( ISubscription  subscription,
IPeer  peer,
IPermissionMessage  update 
)
inlinevirtual

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.

You should override this method if you have derived your Caplin.DataSource.Subscription.ISubscriptionListener implementation from BaseSubscriptionListener and want to handle permission updates.

Implements Caplin.DataSource.Subscription.ISubscriptionListener.

virtual void Caplin.DataSource.Subscription.BaseSubscriptionListener.RecordType2Updated ( ISubscription  subscription,
IPeer  peer,
IRecordType2Message  update 
)
inlinevirtual

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.

You should override this method if you have derived your Caplin.DataSource.Subscription.ISubscriptionListener implementation from BaseSubscriptionListener and want to handle type 2 record updates.

Implements Caplin.DataSource.Subscription.ISubscriptionListener.

virtual void Caplin.DataSource.Subscription.BaseSubscriptionListener.RecordType3Updated ( ISubscription  subscription,
IPeer  peer,
IRecordType3Message  update 
)
inlinevirtual

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.

You should override this method if you have derived your Caplin.DataSource.Subscription.ISubscriptionListener implementation from BaseSubscriptionListener and want to handle type 3 record updates.

Implements Caplin.DataSource.Subscription.ISubscriptionListener.

virtual void Caplin.DataSource.Subscription.BaseSubscriptionListener.RecordUpdated ( ISubscription  subscription,
IPeer  peer,
IRecordType1Message  update 
)
inlinevirtual

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.

You should override this method if you have derived your Caplin.DataSource.Subscription.ISubscriptionListener implementation from BaseSubscriptionListener and want to handle type 1 record updates.

Implements Caplin.DataSource.Subscription.ISubscriptionListener.

virtual void Caplin.DataSource.Subscription.BaseSubscriptionListener.StoryUpdated ( ISubscription  subscription,
IPeer  peer,
IStoryMessage  update 
)
inlinevirtual

Called when a story update is received.

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

You should override this method if you have derived your Caplin.DataSource.Subscription.ISubscriptionListener implementation from BaseSubscriptionListener and want to handle story updates.

Implements Caplin.DataSource.Subscription.ISubscriptionListener.

virtual void Caplin.DataSource.Subscription.BaseSubscriptionListener.SubjectErrorReceived ( ISubscription  subscription,
IPeer  peer,
ISubjectErrorEvent  ev 
)
inlinevirtual

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.

You should override this method if you have derived your Caplin.DataSource.Subscription.ISubscriptionListener implementation from BaseSubscriptionListener and want to handle subscription errors.

Implements Caplin.DataSource.Subscription.ISubscriptionListener.

virtual void Caplin.DataSource.Subscription.BaseSubscriptionListener.SubjectStatusReceived ( ISubscription  subscription,
IPeer  peer,
ISubjectStatusEvent  ev 
)
inlinevirtual

Called when there is a change in the status of a subscription.

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

You should override this method if you have derived your Caplin.DataSource.Subscription.ISubscriptionListener implementation from BaseSubscriptionListener and want to handle subscription status changes.

Implements Caplin.DataSource.Subscription.ISubscriptionListener.


Generated on Fri Feb 14 2020 17:46:10 for DataSource.NET