EMA C++ RDM Usage Guide : 3 Login Domain : 3.2 Usage : 3.2.5 Login Refresh Elements
 
3.2.5 Login Refresh Elements
The Login Attrib can be used to send additional authentication information and user preferences between components. The ReqMsg.Attrib is an ElementList, which can contain any of the following predefined elements (none of which are required):
 
Table 8: Login Refresh Attrib Elements  
ELEMENT NAME
DATA TYPE ENUMERATION
RANGE/EXAMPLE
DESCRIPTION
AllowSuspectData
UInt
0 | 1
Sets whether the provider application passes along suspect StreamState information.
1: The provider application passes along suspect StreamState information. 1 is the default setting.
0: The provider application does not pass along suspect data.
Any suspect stream will be closed with an OmmState.ClosedRecover state.
For more information, refer to Section 3.4.5.
ApplicationId
ASCII
1 - 65535
e.g., 256
Specifies the Data Access Control System application ID. If the server authenticates with the Data Access Control System, the consumer application may be required to pass in a valid ApplicationId. This should match whatever was sent in the request. This must be unique for each application. IDs from 1 to 256 are reserved for permanent market data applications. LSEG assigns these and they are uniform across all client systems. IDs from 257 to 65535 are available for site-specific use.
ApplicationName
ASCII
name of application
e.g., Enterprise Message API
 
Identifies the application sending the Login request or response message. When present, the application name in the Login request identifies the Open Message Model consumer and the application name in the Login response identifies the Open Message Model provider.
AuthenticationErrorCode
UInt
From 0 to 4294967296
Specifies the code for a specific LSEG Real-Time Distribution System Authentication error (or non-error) condition. 0 indicates no error condition and is the default setting.
AuthenticationErrorText
ASCII
User-defined value
Text accompanying and explaining the AuthenticationErrorCode.
AuthenticationExtendedResp
Buffer
User-defined value
This is a binary buffer. AuthenticationExtendedResp contains additional customer-defined data associated with the AuthenticationToken element sent in the original Login Request.
AuthenticationTTReissue
UInt
User-defined value
Indicates when a new authentication token needs to be reissued (in UNIX epoch time).
Position
ASCII
ip addr/hostname or ip addr/net
e.g.:
192.168.1.1/net
Specifies the Data Access Control System location. If the server authenticates with the Data Access Control System, the consumer application might be required to pass in a valid position. If present, this should match whatever was sent in the request or be set to the IP address of the connected client.
ProvidePermissionExpressions
UInt
0 | 1
If specified on a Login Refresh, indicates that a provider will send permission expression information with its responses. ProvidePermissionExpressions is typically present because the login request message requested this information. Permission expressions allow for items to be proxy permissioned by a consumer via content-based entitlements.
ProvidePermissionExpressions defaults to 1.
ProvidePermissionProfile
UInt
0 | 1
If specified on the Login Refresh, indicates that the permission profile is provided. This is typically present because the login request message requested this information. An application can use the permission profile to perform proxy permissioning.
ProvidePermissionProfile defaults to 1.
RoundTripLatency
UInt
2
Indicates support for RoundTripLatency monitoring by the provider. If the element is missing, the provider might still support the feature.
SingleOpen
UInt
0 | 1
Specifies whether the provider drives stream recovery:
1: The provider drives stream recovery. 1 is the default setting.
0: The provider does not drive stream recovery; it is the responsibility of the downstream application.
For more information, refer to Section 3.4.5.
SupportBatchRequests
UInt
0, 7
Indicates whether the provider supports batch messages. Consumers use batch messages to specify multiple items or streams in the same request or close message. For more information on batch requesting, refer to the Enterprise Message API C++ Edition Developers Guide.
0x0 (or if absent): The provider does not support batch messages. 0 is the default setting.
0x1: The provider supports batch request.
0x2: The provider supports batch reissue.
0x4: The provider supports batch close.
For instance, if value is set to 7, then based on combination of bits set (0x1 + 0x2 + 0x4), provider supports batch request, reissue, and close.
SupportEnhancedSymbolList
UInt
0 | 1
Indicates whether the provider supports enhanced symbol list functionality.
0: The provider does not support Symbol List enhancements. 0 is the default setting.
1: The provider supports Symbol List data streams.
SupportOMMPost
UInt
0 | 1
Indicates whether the provider supports Open Message Model posting and whether the user is permissioned to post:
1: The provider supports Open Message Model posting and the user is permissioned.
0: The provider supports the Open Message Model posting feature, but the user is not permissioned. 0 is the default setting.
If absent, the server does not support the Open Message Model Post feature.
For more information on Posting, refer to the Enterprise Message API C++ Edition Developers Guide.
SupportOptimizedPauseResume
UInt
0 | 1
Indicates whether the provider supports Optimized Pause and Resume. Optimized Pause and Resume allows for pausing/resuming of individual item streams or pausing all item streams (by pausing the Login stream). For more information on Pause and Resume, refer to the Enterprise Message API C++ Edition Developers Guide.
1: The server supports optimized pause and resume.
0 (or if absent): The server does not support optimized pause and resume. 0 is the default setting.
SupportPauseResume
UInt
0 | 1
Indicates whether the server supports pause and resume.
1: The server supports pause and resume.
0: (or if absent): The server does not support pause and resume. 0 is the default setting.
SupportProviderDictionaryDownload
UInt
0 | 1
Indicates whether the server supports the Provider Dictionary Download feature:
1: The server supports the provider dictionary download.
0: The server does not support the provider dictionary download feature. 0 is the default setting.
If this element is missing, the server does not support the provider dictionary download feature.
For more information on the provider dictionary download feature, refer to the Enterprise Message API C++ Edition Developers Guide.
SupportStandby
UInt
0 | 1
Indicates whether the provider supports Warm Standby functionality. If supported, a provider can be told to run as an active or a standby server, where the active will behave as usual. The standby will respond to item requests only with the message header and will forward any state changing information. If informed that the active server failed, the standby begins sending responses and assumes active functionality.
1: The provider supports a Warm Standby group setup.
0 (or if absent): The provider does not support warm standby functionality. 0 is the default setting.
For more information on Warm Standby functionality, refer to Section 3.2.12.
SupportStandbyMode
UInt
0 | 1 | 2 | 3
Indicates the Warm Standby modes supported by the provider. SupportStandby needs to be set to 1 in addition to SupportStandbyMode.
1: The provider supports Login-based Warm Standby.
2: The provider supports Service-based Warm Standby.
3: The provider supports both Login and Service-based Warm Standby.
0 (or if absent): The provider does not support warm standby functionality. 0 is the default setting.
SupportViewRequests
UInt
0 | 1
Indicates whether the provider supports requesting with Dynamic View information. Using Dynamic Views, a user can request only the specific contents of the response information in which they are interested. For more information on using Dynamic Views, refer to the Enterprise Message API C++ Edition Developers Guide.
1: The provider supports Dynamic Views specified on request messages.
0 (or if absent): The provider does not support Dynamic Views specified on request messages. 0 is the default setting.