DataSource Blotter.NET  6.2.6-662-0db3f8d
 All Classes Namespaces Functions Properties Pages
Public Member Functions | Public Attributes | Properties | List of all members
Caplin.DataSource.Blotter.BlotterConfiguration Class Reference

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 SetAutoSendEmptyContainer ()
 Sets whether an empty container should automatically be sent or now when the channel opens
 
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 SetContainerThrottleMillis (int millis)
 Specify the millisecond delay used to throttle subsequent operations to a single container. This essentially combines multiple addElement calls into one single container update if all the adds happen within the throttle millisecond period 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 SetMoveItemToTopWhenModified (bool moveItemToTopWhenModified)
 Sets whether to move an existing item to the top of the container when sendBlotterItem with an Item with the same ID gets called again More...
 
virtual void SetPrefixIdWithIdentifier (bool prefixIdWithIdentifier)
 Set to false to turn off prefixing of ID's with the blotterIdentifier followed by a -. More...
 
virtual void SetSubcontainerMaxDepth (int subcontainerMaxDepth)
 Sets the subcontainer maximum depth. More...
 
virtual void SetUseGenericObjects (bool useGenericObjects)
 Set whether the API should use generic objects instead of Type1 records. 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 int ContainerThrottleMillis [get]
 Get the current millisecond delay used for container throttling More...
 
virtual bool IsAutoPermit [get]
 Gets whether automatically permitted. More...
 
virtual bool IsAutoSendEmptyContainer [get]
 Gets whether an empty container should be send automatically as a response to a request 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 IsItemUsingImageFlag [get]
 Returns true if image flags are used on each channel item for their initial messages, or false otherwise. More...
 
virtual bool IsMoveItemToTopWhenModified [get]
 Gets whether items should be moved to the top of the container upon modification More...
 
virtual bool IsPrefixIdWithIdentifier [get]
 When true then the ID will be prefixed with the blotterIdentifier followed by a dash. Default is true. More...
 
virtual bool IsUseGenericObjects [get]
 Gets whether generic objects should be used instead of Type1 Records 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 be 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, must be the last variable part of the namespace. E.g. 1234 and it will be prefixed with the BlotterIdentifier

Parameters
blotterIdentifierthe blotter identifier
channelNamespacethe channel namespace
itemNamespacethe item namespace
subContainerNamespacethe 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
autoPermitwhether 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
isChannelUsingImageFlagboolean used to set the channel image flag
Returns
Returns the BlotterConfiguration object
virtual void Caplin.DataSource.Blotter.BlotterConfiguration.SetContainerThrottleMillis ( int  millis)
inlinevirtual

Specify the millisecond delay used to throttle subsequent operations to a single container. This essentially combines multiple addElement calls into one single container update if all the adds happen within the throttle millisecond period

Parameters
millismillisecond delay used for throttling
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
isItemUsingImageFlagboolean used to set the channel items image flags
Returns
Returns the BlotterConfiguration object
virtual void Caplin.DataSource.Blotter.BlotterConfiguration.SetMoveItemToTopWhenModified ( bool  moveItemToTopWhenModified)
inlinevirtual

Sets whether to move an existing item to the top of the container when sendBlotterItem with an Item with the same ID gets called again

Default: false

Parameters
moveItemToTopWhenModifiedtrue to move item to the top, false to leave existing items where they are
virtual void Caplin.DataSource.Blotter.BlotterConfiguration.SetPrefixIdWithIdentifier ( bool  prefixIdWithIdentifier)
inlinevirtual

Set to false to turn off prefixing of ID's with the blotterIdentifier followed by a -.

Changing this to false breaks setups where two providers supply different rows of the same blotter

Parameters
prefixIdWithIdentifierdefault: true
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 Address field as if in actual subcontainers.

virtual void Caplin.DataSource.Blotter.BlotterConfiguration.SetUseGenericObjects ( bool  useGenericObjects)
inlinevirtual

Set whether the API should use generic objects instead of Type1 records.

Default: false

Parameters
useGenericObjectstrue for generic objects

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 int Caplin.DataSource.Blotter.BlotterConfiguration.ContainerThrottleMillis
get

Get the current millisecond delay used for container throttling

current millisecond delay for container throttling

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.IsAutoSendEmptyContainer
get

Gets whether an empty container should be send automatically as a response to a request

Default: true

true if an emtpy container should automatically be sent out

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.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 bool Caplin.DataSource.Blotter.BlotterConfiguration.IsMoveItemToTopWhenModified
get

Gets whether items should be moved to the top of the container upon modification

true to move item, false to leave it where it is

virtual bool Caplin.DataSource.Blotter.BlotterConfiguration.IsPrefixIdWithIdentifier
get

When true then the ID will be prefixed with the blotterIdentifier followed by a dash. Default is true.

Changing this to false breaks setups where two providers supply different rows of the same blotter!

true to prefix Blotter ID's with the blotterIdentifier followed by a -

virtual bool Caplin.DataSource.Blotter.BlotterConfiguration.IsUseGenericObjects
get

Gets whether generic objects should be used instead of Type1 Records

true for generic objects, false for Type1 records

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().


Generated on Thu Apr 6 2017 16:23:13 for DataSource Blotter.NET