| SessionOptions Class |
To use non-default options on a Session, create a SessionOptions
instance and set the required options and then supply it when creating
a Session.
Inheritance HierarchySystemObject
Bloomberglp.BlpapiSessionOptions
Bloomberglp.BlpapiSessionOptions
Namespace: Bloomberglp.Blpapi
Assembly: Bloomberglp.Blpapi (in Bloomberglp.Blpapi.dll) Version: 3.24.11.1
SyntaxThe SessionOptions type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SessionOptions |
Construct a SessionOption with well defined defaults for various
options
|
Properties| Name | Description | |
|---|---|---|
 | AllowMultipleCorrelatorsPerMsg |
Gets or sets the allow multiple correlators per message flag.
The default is false.
|
| ApplicationIdentityKey |
Gets or sets the application identity key (AIK) which uniquely
identifies this application for this session.
|
| AuthenticationOptions |
Gets or sets the authentication options.
|
| AutoRestartOnDisconnection |
Gets or sets the auto restart flag.
The default is false.
|
| BandwidthSaveModeDisabled |
Gets or sets the flag indicating whether the client has
disabled bandwidth saving measures. By default it is false.
|
| ClientMode |
Gets or sets the client mode.
SessionOptionsClientModeType
The default is AUTO AUTO
|
| ConnectTimeout |
Gets or sets the connection timeout in milliseconds when connecting
to an endpoint.
The default value is 5000. The value must be greater than zero and less than or equal to 120000. |
| DefaultKeepAliveInactivityTime |
Gets or sets the default keep alive inactivity time in ms.
The default value is 20000 ms.
|
| DefaultKeepAliveResponseTimeout |
Gets or sets the keep alive response time in ms.
The default value is 5000 ms.
|
| DefaultSubscriptionService |
Gets or sets the default subscription service.
The default is "//blp/mktdata"
|
| DefaultTopicPrefix |
Gets or sets the default topic prefix.
The default is "ticker/"
|
| KeepaliveEnabled |
Gets or sets the keep alive enable flag.
The default value is true.
|
| MaxEventQueueSize | Max queue size for events.
|
| MaxOutstandingRequests | Return max outstanding requests.
|
| MaxPendingRequests | Max pending requests.
|
| MaxSendCacheSize |
Gets or sets the max send cache size.
The default value is 128MB.
|
| NumStartAttempts |
Gets or sets the max start attempts.
The default value is 3.
|
| RecordSubscriptionDataReceiveTimes |
Gets or sets if the receipt time (accessed via
TimeReceived) should be recorded for
subscription data messages.
|
| ServerAddresses |
Gets or Sets the list of server address.
Behavior is undefined if the specified 'value' contains
any serverAddress whose hostname is an empty string.
|
| ServerHost |
Gets or sets the API server host of the first element in the server
list.
The default is "127.0.0.1".
For setter, behavior is undefined if the specified
'value' is an empty string.
|
| ServerPort |
Gets or sets the API server port of the first element in the
server list.
The default is 8194.
|
| ServiceCheckTimeout |
Gets or sets the service check timeout in ms.
The default value is 60000 ms.
|
| ServiceDownloadTimeout |
Gets or sets the service download timeout in ms.
The default value is 120000 ms.
|
| SessionName |
Gets or sets the session name which can be used to identify
the log lines pertaining to the session.
|
| SlowConsumerWarningHiWaterMark |
Gets or sets the slow consumer warning high water mark limit
regarding to MaxSendCacheSize.
The default is 0.75.
|
| SlowConsumerWarningLoWaterMark |
Gets or sets the slow consumer warning low water mark limit
regarding to MaxSendCacheSizeMaxSendCacheSize.
The default is 0.50.
|
| TlsOptions |
Gets or sets TlsOptions to use for establishing
secure connection. By default its null.
|
Methods| Name | Description | |
|---|---|---|
| SetSessionIdentityOptions |
Sets the specified authOptions as the
AuthOptions for the session identity, enabling
automatic authorization of the session identity during startup.
The session identity lifetime is tied to the session's lifetime, so it is guaranteed that the session identity will remain authorized during the entire duration of the session. The identity will be authorized before the session starts. The session will terminate if the identity fails to authorize or is revoked. The session identity is used to send requests and make subscriptions if no other identity is provided. By default the session identity is not authorized. |
| ToString |
Return the string representation of this object.
(Overrides ObjectToString.) |
Remarks
Currently the following options are supported:
| Option | Description |
|---|---|
| ServerHost | The hostname or the ip address of where the ServerAPI is running |
| ServerPort | The port number of the ServerAPI process |
| MaxSendCacheSize | Maximum number of bytes that will be cached by the Session before requests will fail. |
| MaxEventQueueSize | The maximum number of events that can be buffered by the Session. The value of MaxEventQueueSize must be greater than zero. |
| MaxPendingRequests | The maximum number of requests that can be pending |
| AllowMultipleCorrelatorsPerMsg | If a message is to be delivered for multiple correlators then deliver one message with all correlators folded into that one message |
| SlowConsumerWarningHiWaterMark | Set the fraction of 'MaxEventQueueSize' at which "slow consumer" events will be generated. A warning event will be generated when the number of outstanding undelivered events passes above 'SlowConsumerWarningHiWaterMark * MaxEventQueueSize'. The following is applicable 0.0 < slowConsumerWarningHiWaterMark <= 1.0. Further, at the time that Session.Start() is called, it must be the case that 'SlowConsumerWarningLoWaterMark * MaxEventQueueSize' < 'SlowConsumerWarningHiWaterMark * MaxEventQueueSize'. |
| SlowConsumerWarningLoWaterMark | Set the fraction of 'MaxEventQueueSize' at which "slow consumer cleared" events will be generated. A warning cleared event will be generated when the number of outstanding undelivered events drops below 'SlowConsumerWarningLoWaterMark * MaxEventQueueSize'. The following is applicable 0.0 <= SlowConsumerWarningLoWaterMark < 1.0. Further, at the time that Session.Start() is called, it must be the case that 'SlowConsumerWarningLoWaterMark * MaxEventQueueSize' < 'SlowConsumerWarningHiWaterMark * MaxEventQueueSize'. |
| DefaultSubscriptionService | The name of the service to be used by default for subscriptions. |
| DefaultTopicPrefix | The name of the topic prefix to be used for subscriptions if one is not provided. |
| ConnectTimeout | Timeout in milliseconds for session to establish a connection |
| ClientMode | See SessionOptionsClientModeType. |
| DefaultKeepAliveInactivityTime | Amount of time in milliseconds without any read activity on the connection before the library will ping the peer (requires compatible server). Also see DefaultKeepAliveResponseTimeout. |
| DefaultKeepAliveResponseTimeout | Timeout for the ping response in milliseconds. The peer will be declared "dead" if no ping response (or other data) is received within response timeout interval after the ping (requires compatible server). Also see DefaultKeepAliveInactivityTime. |
| KeepAliveEnabled | Whether all keep-alive mechanisms, both from the client to the server and from the server to the client, should be enabled. |
| RecordSubscriptionDataReceiveTimes | Should the receipt time (accessed via TimeReceived be recorded for subscription data messages. |
| TlsOptions | Client credentials and trusted certificates to establish secure connection. By default plaintext connection is used. See TlsOptions. |
| ServiceCheckTimeout | Timeout, in milliseconds, for checking what version of the schema should be downloaded when opening a new service. The timeout value must be a positive integer. The default timeout is 60,000 milliseconds. |
| ServiceDownloadTimeout | Timeout, in milliseconds, for downloading the service schema when opening a new service. The timeout value must be a positive integer. The default timeout is 120,000 milliseconds. |
| BandwidthSaveModeDisabled | Flag indicating whether the client has requested to override bandwidth saving measures, such as conflation for snapshot subscriptions. By default it is false. |
| SessionIdentityOptions | Authorization options that enable automatic authorization of the session identity during startup. |
| ApplicationIdentityKey | The application identity key (AIK) which uniquely identifies this application for this session. |
| SessionName | The session name which can be used to identify the log lines pertaining to the session. |
Thread SafetyInstance members of this type are not safe for multi-threaded operations.
See Also