Click or drag to resize
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 Hierarchy
SystemObject
  Bloomberglp.BlpapiSessionOptions

Namespace:  Bloomberglp.Blpapi
Assembly:  Bloomberglp.Blpapi (in Bloomberglp.Blpapi.dll) Version: 3.10.3.1
Syntax
Copy
[SerializableAttribute]
public class SessionOptions

The SessionOptions type exposes the following members.

Constructors
  NameDescription
Public methodSessionOptions
Construct a SessionOption with well defined defaults for various options
Top
Properties
  NameDescription
Public propertyAllowMultipleCorrelatorsPerMsg
Public propertyAuthenticationOptions
Public propertyAutoRestartOnDisconnection
Public propertyClientMode
Public propertyConnectTimeout
Public propertyDefaultKeepAliveInactivityTime
Public propertyDefaultKeepAliveResponseTimeout
Public propertyDefaultSubscriptionService
Public propertyDefaultTopicPrefix
Public propertyKeepaliveEnabled
Public propertyMaxEventQueueSize
Public propertyMaxOutstandingRequests
Public propertyMaxPendingRequests
Public propertyMaxSendCacheSize
Public propertyNumStartAttempts
Public propertyRecordSubscriptionDataReceiveTimes
Gets or sets if the receipt time (accessed via TimeReceived) should be recorded for subscription data messages.
Public propertyServerAddresses
Gets or Sets the list of server address. Behavior is undefined if the specified 'value' contains any serverAddress whose hostname is an empty string.
Public propertyServerHost
Gets or sets the API server host to connect to. The default is "127.0.0.1". For settor, behavior is undefined if the specified 'value' is an empty string.
Public propertyServerPort
Public propertyServiceCheckTimeout
Public propertyServiceDownloadTimeout
Public propertySlowConsumerWarningHiWaterMark
Public propertySlowConsumerWarningLoWaterMark
Top
Remarks
Currently the following options are supported:
OptionDescription
ServerHostThe hostname or the ip address of where the ServerAPI is running
ServerPortThe port number of the ServerAPI process
MaxSendCacheSizeMaximum number of bytes that will be cached by the Session before requests will fail.
MaxEventQueueSizeThe maximum number of events that can be buffered by the Session. The value of MaxEventQueueSize must be greater than zero.
MaxPendingRequestsThe maximum number of requests that can be pending
AllowMultipleCorrelatorsPerMsgIf a message is to be delivered for multiple correlators then deliver one message with all correlators folded into that one message
SlowConsumerWarningHiWaterMarkSet 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'.
SlowConsumerWarningLoWaterMarkSet 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'.
DefaultSubscriptionServiceThe name of the service to be used by default for subscriptions.
DefaultTopicPrefixThe name of the topic prefix to be used for subscriptions if one is not provided.
ConnectTimeoutTimeout 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.
ServiceCheckTimeoutTimeout, 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.
ServiceDownloadTimeoutTimeout, 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.
Thread Safety
Instance members of this type are not safe for multi-threaded operations.
See Also