|
| ObjectID: | XOBJ_SESSION_TICKER |
The first object created by the client application, establishes a connection with the appliance. See more...
FIELD GROUPS
EVENTS
XOBJ_EVENT_SESSION_STATUS
| DEPRECATED FIELDS | REPLACED WITH |
FIELD DESCRIPTIONS
XFLD_SESS_TURNKEY
Type: xuint64
Description: Client-specified turnaround key (set during object creation).
(click for example)
xerr status; xuint64 turnkey; status = xcGetField( session, XC_SESSION, XFLD_SESS_TURNKEY, &turnkey, sizeof(turnkey)); printf("%ld\n", turnkey);
XFLD_SESS_SESSION_TYPE
Type: XC_OBJECT_TYPE
Description: Type of Session object.
(click for example)
xerr status; XC_OBJECT_TYPE session_type; status = xcGetField( session, XC_SESSION, XFLD_SESS_SESSION_TYPE, &session_type, sizeof(session_type)); printf("%s\n", xcShowData(&session_type, XTYP_XC_OBJECT_TYPE));
XFLD_SESS_STATUS
Type: xerr
Description: Current session status.
(click for example)
xerr status; xerr status; status = xcGetField( session, XC_SESSION, XFLD_SESS_STATUS, &status, sizeof(status)); printf("%s\n", xcShowData(&status, XTYP_xerr));
XFLD_SESS_CLIENT_VERSION_STRING
Type: STRING_NUL_TERM[0]
Description: Client API version information as a NULL-terminated string.
(click for example)
xerr status; char client_version_string[512]; status = xcGetField( session, XC_SESSION, XFLD_SESS_CLIENT_VERSION_STRING, client_version_string, sizeof(client_version_string)); printf("%s\n", client_version_string);
XFLD_SESS_CLIENT_MAJOR_VERSION
Type: xuint32
Description: Major version of client API.
(click for example)
xerr status; xuint32 client_major_version; status = xcGetField( session, XC_SESSION, XFLD_SESS_CLIENT_MAJOR_VERSION, &client_major_version, sizeof(client_major_version)); printf("%d\n", client_major_version);
XFLD_SESS_CLIENT_MINOR_VERSION
Type: xuint32
Description: Minor version of client API.
(click for example)
xerr status; xuint32 client_minor_version; status = xcGetField( session, XC_SESSION, XFLD_SESS_CLIENT_MINOR_VERSION, &client_minor_version, sizeof(client_minor_version)); printf("%d\n", client_minor_version);
XFLD_SESS_CLIENT_REVISION
Type: xuint32
Description: Revision of client API.
(click for example)
xerr status; xuint32 client_revision; status = xcGetField( session, XC_SESSION, XFLD_SESS_CLIENT_REVISION, &client_revision, sizeof(client_revision)); printf("%d\n", client_revision);
XFLD_SESS_CLIENT_BUILD
Type: xuint32
Description: Build number of client API.
(click for example)
xerr status; xuint32 client_build; status = xcGetField( session, XC_SESSION, XFLD_SESS_CLIENT_BUILD, &client_build, sizeof(client_build)); printf("%d\n", client_build);
XFLD_SESS_CLIENT_CPU_COUNT
Type: xuint32
Description: Number of CPU cores on the client machine.
(click for example)
xerr status; xuint32 client_cpu_count; status = xcGetField( session, XC_SESSION, XFLD_SESS_CLIENT_CPU_COUNT, &client_cpu_count, sizeof(client_cpu_count)); printf("%d\n", client_cpu_count);
XFLD_SESS_CLIENT_AFFINITY_MASK
Type: xuint64
Attributes: array,settable
Description: Bit mask indicating which CPU core on the client machine to affine with the currently active thread. For instance, to set the affinity of the SessionTicker's primary processing thread (the "callback thread"), this field should be set inside the session listener (for Java) or inside the session callback function (for C). Note that reading this field returns the affinity of the thread from which the field retrieval is performed. Please see the "Threading Model" section of this guide (under "XCAPI Overview") for detailed information on setting thread affinity. Note also that the "CLIENT_THREAD_PRIORITY" field value affects performance for the affined thread. In addition, note that the "CLIENT_CPU_COUNT" field exposes the number of CPU cores on the client machine.
(click for example)
xerr status; xuint32 count = 5; xuint32 index = 0; xuint64 client_affinity_mask[5]; status = xcGetFieldArray( session, XC_SESSION, XFLD_SESS_CLIENT_AFFINITY_MASK + index, client_affinity_mask, sizeof(xuint64), &count); xuint32 n; for (n = 0; n < count; n++) { printf("%ld\n", client_affinity_mask[n]); } status = xcSetFieldArray( session, XC_SESSION, XFLD_SESS_CLIENT_AFFINITY_MASK + index, client_affinity_mask, sizeof(xuint64), &count);
XFLD_SESS_CLIENT_BG_THREAD_AFFINITY_MASK
Type: xuint64
Attributes: array,settable
Description: Bit mask indicating which CPU core on the client machine to affine with the XCAPI background thread. Please see the "Threading Model" section of this guide (under "XCAPI Overview") for detailed information on setting thread affinity. Note also that the "CLIENT_BG_THREAD_PRIORITY" field value affects performance for the affined thread. In addition, note that the "CLIENT_CPU_COUNT" field exposes the number of CPU cores on the client machine.
(click for example)
xerr status; xuint32 count = 5; xuint32 index = 0; xuint64 client_bg_thread_affinity_mask[5]; status = xcGetFieldArray( session, XC_SESSION, XFLD_SESS_CLIENT_BG_THREAD_AFFINITY_MASK + index, client_bg_thread_affinity_mask, sizeof(xuint64), &count); xuint32 n; for (n = 0; n < count; n++) { printf("%ld\n", client_bg_thread_affinity_mask[n]); } status = xcSetFieldArray( session, XC_SESSION, XFLD_SESS_CLIENT_BG_THREAD_AFFINITY_MASK + index, client_bg_thread_affinity_mask, sizeof(xuint64), &count);
XFLD_SESS_CLIENT_HB_THREAD_AFFINITY_MASK
Type: xuint64
Attributes: array,settable
Description:
(click for example)
xerr status; xuint32 count = 5; xuint32 index = 0; xuint64 client_hb_thread_affinity_mask[5]; status = xcGetFieldArray( session, XC_SESSION, XFLD_SESS_CLIENT_HB_THREAD_AFFINITY_MASK + index, client_hb_thread_affinity_mask, sizeof(xuint64), &count); xuint32 n; for (n = 0; n < count; n++) { printf("%ld\n", client_hb_thread_affinity_mask[n]); } status = xcSetFieldArray( session, XC_SESSION, XFLD_SESS_CLIENT_HB_THREAD_AFFINITY_MASK + index, client_hb_thread_affinity_mask, sizeof(xuint64), &count);
XFLD_SESS_CLIENT_THREAD_PRIORITY
Type: xint32
Attributes: settable
Description: A value from 0 to 99 indicating what priority the CPU core should give the affined processing thread. A higher value indicates a higher priority. (Also see the "CLIENT_AFFINITY_MASK" field and the "Threading Model" section of this guide for information on setting thread affinity.)
(click for example)
xerr status; xint32 client_thread_priority; status = xcGetField( session, XC_SESSION, XFLD_SESS_CLIENT_THREAD_PRIORITY, &client_thread_priority, sizeof(client_thread_priority)); printf("%d\n", client_thread_priority); status = xcSetField( session, XC_SESSION, XFLD_SESS_CLIENT_THREAD_PRIORITY, &client_thread_priority, sizeof(client_thread_priority));
XFLD_SESS_CLIENT_BG_THREAD_PRIORITY
Type: xint32
Attributes: settable
Description: A value from 0 to 99 indicating what priority the CPU core should give the affined background processing thread. A higher value indicates a higher priority. (Also see the "CLIENT_BG_THREAD_AFFINITY_MASK" field and the "Threading Model" section of this guide for information on setting thread affinity.)
(click for example)
xerr status; xint32 client_bg_thread_priority; status = xcGetField( session, XC_SESSION, XFLD_SESS_CLIENT_BG_THREAD_PRIORITY, &client_bg_thread_priority, sizeof(client_bg_thread_priority)); printf("%d\n", client_bg_thread_priority); status = xcSetField( session, XC_SESSION, XFLD_SESS_CLIENT_BG_THREAD_PRIORITY, &client_bg_thread_priority, sizeof(client_bg_thread_priority));
XFLD_SESS_CLIENT_HB_THREAD_PRIORITY
Type: xint32
Attributes: settable
Description:
(click for example)
xerr status; xint32 client_hb_thread_priority; status = xcGetField( session, XC_SESSION, XFLD_SESS_CLIENT_HB_THREAD_PRIORITY, &client_hb_thread_priority, sizeof(client_hb_thread_priority)); printf("%d\n", client_hb_thread_priority); status = xcSetField( session, XC_SESSION, XFLD_SESS_CLIENT_HB_THREAD_PRIORITY, &client_hb_thread_priority, sizeof(client_hb_thread_priority));
XFLD_SESS_SERVER_NAME
Type: STRING_NUL_TERM[0]
Description: Name of the appliance.
(click for example)
xerr status; char server_name[512]; status = xcGetField( session, XC_SESSION, XFLD_SESS_SERVER_NAME, server_name, sizeof(server_name)); printf("%s\n", server_name);
XFLD_SESS_SERVER_VERSION_STRING
Type: STRING_NUL_TERM[0]
Description: Ticker Plant or Base Appliance version information as a NULL-terminated string.
(click for example)
xerr status; char server_version_string[512]; status = xcGetField( session, XC_SESSION, XFLD_SESS_SERVER_VERSION_STRING, server_version_string, sizeof(server_version_string)); printf("%s\n", server_version_string);
XFLD_SESS_SERVER_MAJOR_VERSION
Type: xuint8
Description: Major version of appliance.
(click for example)
xerr status; xuint8 server_major_version; status = xcGetField( session, XC_SESSION, XFLD_SESS_SERVER_MAJOR_VERSION, &server_major_version, sizeof(server_major_version)); printf("%d\n", server_major_version);
XFLD_SESS_SERVER_MINOR_VERSION
Type: xuint8
Description: Minor version of appliance.
(click for example)
xerr status; xuint8 server_minor_version; status = xcGetField( session, XC_SESSION, XFLD_SESS_SERVER_MINOR_VERSION, &server_minor_version, sizeof(server_minor_version)); printf("%d\n", server_minor_version);
XFLD_SESS_SERVER_REVISION
Type: xuint8
Description: Revision of appliance.
(click for example)
xerr status; xuint8 server_revision; status = xcGetField( session, XC_SESSION, XFLD_SESS_SERVER_REVISION, &server_revision, sizeof(server_revision)); printf("%d\n", server_revision);
XFLD_SESS_SERVER_BUILD
Type: xuint32
Description: Build number of appliance software/firmware.
(click for example)
xerr status; xuint32 server_build; status = xcGetField( session, XC_SESSION, XFLD_SESS_SERVER_BUILD, &server_build, sizeof(server_build)); printf("%d\n", server_build);
XFLD_SESS_DISABLE_RECONNECT
Type: xbool
Attributes: settable
Description: Allows the client application to control the API's automatic reconnect/resubscribe behavior. The field defaults to XFALSE, which means that if a client disconnect occurs, the API's automatic reconnect/resubscribe mechanism will be in effect. If the field is set to XTRUE, however, automatic reconnect/resubscribe is disabled. See "XCAPI Overview > Client Disconnects" for detailed information on the API's reconnect/resubscribe mechanism. Note that disabling automatic reconnect/resubscribe prevents an XCAPI application from failing over to an alternative device in the event of a disconnection.
(click for example)
xerr status; xbool disable_reconnect; status = xcGetField( session, XC_SESSION, XFLD_SESS_DISABLE_RECONNECT, &disable_reconnect, sizeof(disable_reconnect)); printf("%s\n", xcShowData(&disable_reconnect, XTYP_xbool)); status = xcSetField( session, XC_SESSION, XFLD_SESS_DISABLE_RECONNECT, &disable_reconnect, sizeof(disable_reconnect));
XFLD_SESS_REPLAY_START
Type: xbool
Attributes: settable
Description: Supports replay functionality for Exegy Capture Replay (XCR) applications. Please see the Exegy Capture Replay (XCR) QuickStart Guide for further information.
(click for example)
xerr status; xbool replay_start; status = xcGetField( session, XC_SESSION, XFLD_SESS_REPLAY_START, &replay_start, sizeof(replay_start)); printf("%s\n", xcShowData(&replay_start, XTYP_xbool)); status = xcSetField( session, XC_SESSION, XFLD_SESS_REPLAY_START, &replay_start, sizeof(replay_start));
XFLD_SESS_REPLAY_QUOTE_MONTAGE
Type: STRING_NUL_TERM[0]
Attributes: settable
Description: Supports the setting of customized UQM exchange set constituents for Exegy Capture Replay (XCR) applications. Please see the Exegy Capture Replay (XCR) QuickStart Guide for further information.
(click for example)
xerr status; char replay_quote_montage[512]; status = xcGetField( session, XC_SESSION, XFLD_SESS_REPLAY_QUOTE_MONTAGE, replay_quote_montage, sizeof(replay_quote_montage)); printf("%s\n", replay_quote_montage); status = xcSetField( session, XC_SESSION, XFLD_SESS_REPLAY_QUOTE_MONTAGE, replay_quote_montage, sizeof(replay_quote_montage));
XFLD_SESS_REPLAY_L2_COMPOSITE
Type: STRING_NUL_TERM[0]
Attributes: settable
Description: Supports the setting of customized UCPB exchange set constituents Exegy Capture Replay (XCR) applications. Please see the Exegy Capture Replay (XCR) QuickStart Guide for further information.
(click for example)
xerr status; char replay_l2_composite[512]; status = xcGetField( session, XC_SESSION, XFLD_SESS_REPLAY_L2_COMPOSITE, replay_l2_composite, sizeof(replay_l2_composite)); printf("%s\n", replay_l2_composite); status = xcSetField( session, XC_SESSION, XFLD_SESS_REPLAY_L2_COMPOSITE, replay_l2_composite, sizeof(replay_l2_composite));
XFLD_SESS_REPLAY_UBBO
Type: STRING_NUL_TERM[0]
Attributes: settable
Description: Supports the setting of customized UBBO exchange set constituents for Exegy Capture Replay (XCR) applications. Please see the Exegy Capture Replay (XCR) QuickStart Guide for further information.
(click for example)
xerr status; char replay_ubbo[512]; status = xcGetField( session, XC_SESSION, XFLD_SESS_REPLAY_UBBO, replay_ubbo, sizeof(replay_ubbo)); printf("%s\n", replay_ubbo); status = xcSetField( session, XC_SESSION, XFLD_SESS_REPLAY_UBBO, replay_ubbo, sizeof(replay_ubbo));
XFLD_SESS_TKR_MAX_PRICE_BOOK_DEPTH
Type: xuint16
Description: Maximum price book depth for price-book objects that are created as children of this SessionTicker instance.
(click for example)
xerr status; xuint16 max_price_book_depth; status = xcGetField( event, XC_EVENT, XFLD_SESS_TKR_MAX_PRICE_BOOK_DEPTH, &max_price_book_depth, sizeof(max_price_book_depth)); printf("%d\n", max_price_book_depth);
XFLD_SESS_TKR_MARKET_STATUS_CALLBACKS
Type: xbool
Attributes: settable
Description: Controls event notification (callback) behavior associated with changes in market status. If the field is XTRUE, the client application receives a callback (and a TradingAction event) for each subscribed-to instrument within the relevant session whenever MARKET_STATUS changes for the instrument. (Note that this can induce latency during market open and close transitions.) Note also that in a disconnect/failover scenario, for users who desire market-status callbacks, the field must be re-set to XTRUE after the disconnect. In this case, the recommended practice is to set the field to XTRUE inside the session callback . Then the field will be set to the desired value automatically upon reconnection, when XCAPI invokes the session callback during the reestablishment of the previously existing session. Please see the "Client Disconnects" section of this guide (under "XCAPI Overview") for a more detailed discussion of the XCAPI disconnect/reconnect scenario. Also, for more information on events associated with status changes, see the Exegy Feature Brief: Market and Instrument Status .
(click for example)
xerr status; xbool market_status_callbacks; status = xcGetField( event, XC_EVENT, XFLD_SESS_TKR_MARKET_STATUS_CALLBACKS, &market_status_callbacks, sizeof(market_status_callbacks)); printf("%s\n", xcShowData(&market_status_callbacks, XTYP_xbool)); status = xcSetField( event, XC_EVENT, XFLD_SESS_TKR_MARKET_STATUS_CALLBACKS, &market_status_callbacks, sizeof(market_status_callbacks));
XFLD_SESS_TKR_MAX_PB_ROW_LEVEL
Type: xuint16
Description: Maximum price book row level that may be provided (in the XFLD_EVT_PBUPD_ROW_LEVEL field) for price book update events.
(click for example)
xerr status; xuint16 max_pb_row_level; status = xcGetField( event, XC_EVENT, XFLD_SESS_TKR_MAX_PB_ROW_LEVEL, &max_pb_row_level, sizeof(max_pb_row_level)); printf("%d\n", max_pb_row_level);