Caplin.DataSource.Blotter.IBlotterChannelListener Interface Reference

Register this listener on incoming channels from IBlotterApplicationListener.BlotterChannelOpened More...

Public Member Functions
void	OnBlotterItemRequest (Caplin.DataSource.Blotter.IBlotterChannel channel, string uniqueId)
	Called when a previously unsubmitted item in a blotter channel is requested. More...

Detailed Description

Register this listener on incoming channels from IBlotterApplicationListener.BlotterChannelOpened

A use case for two Integration Adapters providing for the same channel is having one publishing which items are available (BlotterItems with no fields set) and another providing the row contents (BlotterItems with fields set). These item requests would be received by the content-providing Integration Adapter for items submitted to the available-items-providing Integration Adapter. These requests would be delegated to the IBlotterChannelListener to be serviced by your application. Simply send the requested items through the above methods or submit a IBlotterChannel.SendBlotterItemNotFound to the channel received on the IBlotterChannelListener callback.

Refer to the BlotterConfiguration for how to configure the BlotterProvider for this use case.

Member Function Documentation

void Caplin.DataSource.Blotter.IBlotterChannelListener.OnBlotterItemRequest	(	Caplin.DataSource.Blotter.IBlotterChannel	channel,
		string	uniqueId
	)

Called when a previously unsubmitted item in a blotter channel is requested.

This callback enables a response to a blotter item request to be sent asynchronously, to respond to the request use IBlotterChannel.SendBlotterItem or if a not found is required use IBlotterChannel.SendBlotterItemNotFound both using the same uniqueId as an input.

Parameters

channel	The user's blotter channel
uniqueId	The unique identifier for the blotter item in the channel