Represents an event that is raised when there is a change in the status of the backend. More...

Inheritance diagram for Caplin.DataSource.IStatusEvent:

Properties
int	Code `[get]`
	Gets the subject status code. More...

string	Message `[get]`
	Gets the subject status message. More...

SubjectStatus	Status `[get]`
	Gets the status of the subject. More...

Detailed Description

Represents an event that is raised when there is a change in the status of the backend.

An Caplin.DataSource.IStatusEvent can be raised by an Caplin.DataSource.Publisher.IDataProvider to indicate to peers the status of their subscriptions to all subjects. For example, if the back end system that feeds data to an Caplin.DataSource.Publisher.IDataProvider goes down, the IDataProvider should raise a IStatusEvent with a Caplin.DataSource.IStatusEvent.Status of Caplin.DataSource.SubjectStatus.Stale to indicate to the peer that the data it has is not completely up-to-date. When an update is subsequently received from the backend data feed, then the IDataProvider should raise a IStatusEvent with a Caplin.DataSource.IStatusEvent.Status of Caplin.DataSource.SubjectStatus.Ok to indicate to the peer that the data it has is now up to date. See Caplin.DataSource.Messaging.IMessageFactory.CreateStatusEvent for an example.

Property Documentation

int Caplin.DataSource.IStatusEvent.Code

get

Gets the subject status code.

The status subject status code.

string Caplin.DataSource.IStatusEvent.Message

get

Gets the subject status message.

A string representing the subject status.

SubjectStatus Caplin.DataSource.IStatusEvent.Status

get

Gets the status of the subject.

The status of the subject.