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.
Declaration Syntax| C# | Visual Basic | Visual C++ |
[SerializableAttribute] public class SessionOptions
<SerializableAttribute> Public Class SessionOptions
[SerializableAttribute] public ref class SessionOptions
Members| All Members | Constructors | Properties | |||
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 SessionOptions..::..ClientModeType.
|
| 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.
|
Thread SafetyInstance members of this type are not safe for multi-threaded operations.
Inheritance Hierarchy| Object | |
 | SessionOptions |
Assembly: Bloomberglp.Blpapi (Module: Bloomberglp.Blpapi.dll) Version: 3.7.4.1