The type Blotter configuration, which can be used to create a BlotterProvider instance. More...

Public Member Functions
	BlotterConfiguration (string blotterIdentifier, string channelNamespace, string itemNamespace)

	BlotterConfiguration (string blotterIdentifier, string channelNamespace, string itemNamespace, string subContainerNamespace)
	Instantiates a new Blotter configuration. More...

virtual void	SetAutoPermit (bool autoPermit)
	Sets auto permit enabled/disabled. More...

virtual void	SetChannelUsingImageFlag (bool isChannelUsingImageFlag)
	Set to true and the channel container will use an image flag when sending the initial message More...

virtual void	SetDeltaUpdatesEnabled (bool deltaUpdatesEnabled)
	Sets delta updates enabled/disabled. More...

virtual void	SetItemUsingImageFlag (bool isItemUsingImageFlag)
	Set to true and the channel items will use image flags when sending their initial messages More...

virtual void	SetSubcontainerMaxDepth (int subcontainerMaxDepth)
	Sets the subcontainer maximum depth. More...

override string	ToString ()

Public Attributes
Caplin.XLang.Container.Configuration	internalConfiguration

Properties
virtual string	BlotterIdentifier `[get]`
	Gets the blotter identifier name. More...

virtual string	ChannelNamespace `[get]`
	Gets the channel namespace. More...

virtual bool	IsAutoPermit `[get]`
	Gets whether automatically permitted. More...

virtual bool	IsChannelUsingImageFlag `[get]`
	Returns true if image flags are used in the channel for its initial message, or false otherwise. More...

virtual bool	IsDeltaUpdatesEnabled `[get]`
	Gets delta updates enabled/disabled. More...

virtual bool	IsItemUsingImageFlag `[get]`
	Returns true if image flags are used on each channel item for their initial messages, or false otherwise. More...

virtual string	ItemNamespace `[get]`
	Gets the item namespace. More...

virtual int	SubContainerMaxDepth `[get]`
	Gets the max depth of the sub containers. More...

virtual string	SubContainerNamespace `[get]`
	Gets the sub channel namespace. More...

Detailed Description

The type Blotter configuration, which can be used to create a BlotterProvider instance.

Constructor & Destructor Documentation

Caplin.DataSource.Blotter.BlotterConfiguration.BlotterConfiguration	(	string	blotterIdentifier,
		string	channelNamespace,
		string	itemNamespace,
		string	subContainerNamespace
	)

inline

Instantiates a new Blotter configuration.

The blotter identifier can anything but its recommended it is the name of your blotter, e.g. OrderBlotter, HistoricBlotter, ActivityBlotter. As this identifier will appear in the logging

The channel namespace must be a namespace subject which contains u or U. E.g. /BLOTTER/u/CHANNEL

The item namespace must be a namespace subject which contains both u or U and i. E.g. /BLOTTER/u/ITEM/i

U = username with session that requested the subject. E.g. admin-0
u = username that requested the subject. E.g. admin
i = unique id relating to the blotter item requested. E.g. 1234

Parameters

blotterIdentifier	the blotter identifier
channelNamespace	the channel namespace
itemNamespace	the item namespace
subContainerNamespace	the sub channel namespace

Member Function Documentation

virtual void Caplin.DataSource.Blotter.BlotterConfiguration.SetAutoPermit ( bool autoPermit )

inlinevirtual

Sets auto permit enabled/disabled.

Configures whether Liberator should automatically allow subscriptions to every Blotter item within a BlotterChannel or it should check the permissions for every BlotterItem. If the DataSource is trusted, it should only send out updates that that user is permissioned for so checking isn't strictly necessary.

Parameters

autoPermit whether to automatically permit BlotterItems or not.

virtual void Caplin.DataSource.Blotter.BlotterConfiguration.SetChannelUsingImageFlag ( bool isChannelUsingImageFlag )

inlinevirtual

Set to true and the channel container will use an image flag when sending the initial message

The default, recommended setting is true. The use case for setting to false is to prevent blotter channel contents being overwritten when two providers provide to the same channel

Parameters

isChannelUsingImageFlag boolean used to set the channel image flag

Returns: Returns the BlotterConfiguration object

virtual void Caplin.DataSource.Blotter.BlotterConfiguration.SetDeltaUpdatesEnabled ( bool deltaUpdatesEnabled )

inlinevirtual

Sets delta updates enabled/disabled.

Parameters

deltaUpdatesEnabled whether to enable or disable delta updates

virtual void Caplin.DataSource.Blotter.BlotterConfiguration.SetItemUsingImageFlag ( bool isItemUsingImageFlag )

inlinevirtual

Set to true and the channel items will use image flags when sending their initial messages

The default, recommended setting is true. The use case for setting to false is to prevent items being overwritten when two providers provide for the same channel

Parameters

isItemUsingImageFlag boolean used to set the channel items image flags

Returns: Returns the BlotterConfiguration object

virtual void Caplin.DataSource.Blotter.BlotterConfiguration.SetSubcontainerMaxDepth ( int subcontainerMaxDepth )

inlinevirtual

Sets the subcontainer maximum depth.

Specify at which level in the tree to start using materialised path representation of subcontainers rather than separate containers. A subscription to a container at the level of maximum depth will return all items below it in the tree. Each item's location in the tree will be represented TreePath field as if in actual subcontainers.

Property Documentation

virtual string Caplin.DataSource.Blotter.BlotterConfiguration.BlotterIdentifier

get

Gets the blotter identifier name.

the blotter identifier in the blotter configuration

virtual string Caplin.DataSource.Blotter.BlotterConfiguration.ChannelNamespace

get

Gets the channel namespace.

the channel namespace in the blotter configuration

Referenced by Caplin.DataSource.Blotter.BlotterProvider.BlotterProvider().

virtual bool Caplin.DataSource.Blotter.BlotterConfiguration.IsAutoPermit

get

Gets whether automatically permitted.

whether BlotterItems are automatically permitted or not.

Referenced by Caplin.DataSource.Blotter.BlotterProvider.BlotterProvider().

virtual bool Caplin.DataSource.Blotter.BlotterConfiguration.IsChannelUsingImageFlag

get

Returns true if image flags are used in the channel for its initial message, or false otherwise.

Returns true if the channel uses image flags

virtual bool Caplin.DataSource.Blotter.BlotterConfiguration.IsDeltaUpdatesEnabled

get

Gets delta updates enabled/disabled.

whether delta updates are enabled or disabled

virtual bool Caplin.DataSource.Blotter.BlotterConfiguration.IsItemUsingImageFlag

get

Returns true if image flags are used on each channel item for their initial messages, or false otherwise.

Returns true if channel items use image flags

virtual string Caplin.DataSource.Blotter.BlotterConfiguration.ItemNamespace

get

Gets the item namespace.

the item namespace in the blotter configuration

Referenced by Caplin.DataSource.Blotter.BlotterProvider.BlotterProvider().

virtual int Caplin.DataSource.Blotter.BlotterConfiguration.SubContainerMaxDepth

get

Gets the max depth of the sub containers.

the max depth of the sub containers

virtual string Caplin.DataSource.Blotter.BlotterConfiguration.SubContainerNamespace

get

Gets the sub channel namespace.

the sub channel namespace in the blotter configuration

Referenced by Caplin.DataSource.Blotter.BlotterProvider.BlotterProvider().

Public Member Functions

Public Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation