Caplin.DataSource.Publisher.ICachingPublisher Interface Reference

Inherited by Caplin.DataSource.Publisher.CachingPublisher.

Public Member Functions
ICachedMessageFactory	getCachedMessageFactory ()
void	publish (IMessage message)
void	publishSubjectErrorEvent (ISubjectErrorEvent subjectErrorEvent)
void	publishSubjectStatusEvent (ISubjectStatusEvent subjectStatusEvent)

Detailed Description

An instance of CachingPublisher publishes messages to remote DataSource peers on behalf of a CachingDataProvider. It also provides access to a CachedMessageFactory that creates the messages to be published. Messages once published are internally cached, so requests from additional peers can be serviced without further calls to the provider.

Member Function Documentation

ICachedMessageFactory Caplin.DataSource.Publisher.ICachingPublisher.getCachedMessageFactory

(

)

Gets the CachedMessageFactory used to create the messages that are published via this Publisher.

Returns

The message factory.

void Caplin.DataSource.Publisher.ICachingPublisher.publish

(

IMessage

message

)

Publishes the data for a subject to peers that have just requested (subscribed to) that subject.

Parameters

message

The message.

void Caplin.DataSource.Publisher.ICachingPublisher.publishSubjectErrorEvent

(

ISubjectErrorEvent

subjectErrorEvent

)

Publishes to all peers subscribed to a subject an event detailing an error in the subscription for that subject. Typically a CachingDataProvider will use this to notify the remote peers that the data they are subscribed to is no longer available.

Parameters

subjectErrorEvent

The error event to be published.

void Caplin.DataSource.Publisher.ICachingPublisher.publishSubjectStatusEvent

(

ISubjectStatusEvent

subjectStatusEvent

)

Publishes to all subscribed peers an event about the change in status of a subject.

Parameters

subjectStatusEvent

The subject status event to be published.