BlotterChannel is the entry point for sending out BlotterItems. It enters your application through the IBlotterApplicationListener.BlotterChannelOpened method and includes methods such as IBlotterChannel.SendBlotterItem for populating the IBlotterChannel with items. More...

Public Member Functions
void	CloseChannel ()
	Closes the channel. More...

void	RemoveBlotterItem (string uniqueId)
	Removes the BlotterItem from the internal cache and sends a container remove so that this item is no longer requested when the channel is subscribed to. More...

void	RemoveBlotterItems (IList< string > uniqueIds)
	Removes BlotterItems from the internal cache and sends a container remove so that these items are no longer requested when the channel is subscribed to. More...

void	SendBlotterItem (Caplin.DataSource.Blotter.BlotterItem item)
	Adds the BlotterItem to the internal cache and sends a container add so that this item is requested when the channel is subscribed to. More...

void	SendBlotterItemNotFound (string uniqueId)
	Sends a not found for a BlotterItem. More...

void	SendBlotterItems (IList< Caplin.DataSource.Blotter.BlotterItem > items)
	Adds BlotterItems to the internal cache and sends a container add so that these items are requested when the channel is subscribed to. More...

void	SendBlotterItemStatusOk (string uniqueId)
	Send status ok for a BlotterItem. More...

void	SendBlotterItemStatusStale (string uniqueId)
	Send status stale for a BlotterItem. More...

void	SendBlotterStatusOk ()
	Sends a status ok on the channel. More...

void	SendBlotterStatusStale ()
	Sends a status stale on the channel. More...

void	SendEmptyBlotter ()
	Sends an empty container on the channel. More...

void	SetBlotterChannelListener (Caplin.DataSource.Blotter.IBlotterChannelListener listener)
	Sets a IBlotterChannelListener on the channel. More...

Properties
string	Parameters `[get]`
	Returns the parameters for the channel More...

string	Subject `[get]`
	Returns the subject for the channel. More...

string	Username `[get]`
	Returns the username for the channel More...

Detailed Description

BlotterChannel is the entry point for sending out BlotterItems. It enters your application through the IBlotterApplicationListener.BlotterChannelOpened method and includes methods such as IBlotterChannel.SendBlotterItem for populating the IBlotterChannel with items.

Member Function Documentation

void Caplin.DataSource.Blotter.IBlotterChannel.CloseChannel ( )

Closes the channel.

Sends a Subject Not Found on the channel's subject to let subscribers know that it is no longer serviced.

void Caplin.DataSource.Blotter.IBlotterChannel.RemoveBlotterItem ( string uniqueId )

Removes the BlotterItem from the internal cache and sends a container remove so that this item is no longer requested when the channel is subscribed to.

Parameters

uniqueId of the item to remove

void Caplin.DataSource.Blotter.IBlotterChannel.RemoveBlotterItems ( IList< string > uniqueIds )

Removes BlotterItems from the internal cache and sends a container remove so that these items are no longer requested when the channel is subscribed to.

Parameters

uniqueIds of the items to remove

void Caplin.DataSource.Blotter.IBlotterChannel.SendBlotterItem ( Caplin.DataSource.Blotter.BlotterItem item )

Adds the BlotterItem to the internal cache and sends a container add so that this item is requested when the channel is subscribed to.

If an item with the same unique id already exists in the internal cache then that item's fields will be updated with this one. This will then trigger an update for any users currently subscribed to this item.

Parameters

item to send

void Caplin.DataSource.Blotter.IBlotterChannel.SendBlotterItemNotFound ( string uniqueId )

Sends a not found for a BlotterItem.

Specifically for the case where there is more than one Integration Adapter providing for the same channel subject.

Sent in response to a IBlotterChannelListener.OnBlotterItemRequest when the item requested is not serviceable by your application.

Parameters

uniqueId of item that cannot be serviced by your application.

void Caplin.DataSource.Blotter.IBlotterChannel.SendBlotterItems ( IList< Caplin.DataSource.Blotter.BlotterItem > items )

Adds BlotterItems to the internal cache and sends a container add so that these items are requested when the channel is subscribed to.

If any items with the same unique id already exists in the internal cache then these items fields will be updated with these one. This will then trigger an update for any users currently subscribed to these items.

Parameters

items to send

void Caplin.DataSource.Blotter.IBlotterChannel.SendBlotterItemStatusOk ( string uniqueId )

Send status ok for a BlotterItem.

Under normal circumstances this method is not used.

Parameters

uniqueId of the message whose status is OK

void Caplin.DataSource.Blotter.IBlotterChannel.SendBlotterItemStatusStale ( string uniqueId )

Send status stale for a BlotterItem.

Under normal circumstances this method is not used.

Parameters

uniqueId of the message whose status is STALE

void Caplin.DataSource.Blotter.IBlotterChannel.SendBlotterStatusOk ( )

Sends a status ok on the channel.

Under normal circumstances this method is not used.

void Caplin.DataSource.Blotter.IBlotterChannel.SendBlotterStatusStale ( )

Sends a status stale on the channel.

Under normal circumstances this method is not used.

void Caplin.DataSource.Blotter.IBlotterChannel.SendEmptyBlotter ( )

Sends an empty container on the channel.

Invoke when a IBlotterApplicationListener.BlotterChannelOpened callback is received and there are currently no BlotterItems to be added for the channel. I.e. A IBlotterApplicationListener.BlotterChannelOpened for a historic trade data BlotterChannel for a user who has not yet traded would be serviced with this method.

Note: This method is not required if the blotter Configuration option BlotterConfiguration#setAutoSendEmptyContainer() is turned on, in which case the API will send out an empty container for a blotter channel that was opened - unless it is materialized paths

void Caplin.DataSource.Blotter.IBlotterChannel.SetBlotterChannelListener ( Caplin.DataSource.Blotter.IBlotterChannelListener listener )

Sets a IBlotterChannelListener on the channel.

Specifically for the case where there is more than one Integration Adapter providing for the same channel subject.

See BlotterConfiguration for how to configure for this eventuality.

Parameters

listener to receive requests for items not already cached by the BlotterAPI

Property Documentation

string Caplin.DataSource.Blotter.IBlotterChannel.Parameters

get

Returns the parameters for the channel

parameters for the channel

string Caplin.DataSource.Blotter.IBlotterChannel.Subject

get

Returns the subject for the channel.

subject for the channel

string Caplin.DataSource.Blotter.IBlotterChannel.Username

get

Returns the username for the channel

username for the channel

Public Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation