Capital Markets Adapters 10.15 | Apama Capital Markets Adapters Documentation 10.15 | Reuters RFA Adapter | Event details | Data publishing events | Directory
 
Directory

com.apama.rfa.DIRECTORY_RESP(string TRANSPORT,string RespType
integer RespTypeNum,string IndicationMask,
sequence<integer> dataMask,
dictionary<string,com.apama.rfa.Service> ServicesMap,
dictionary<string,string> __payload)
Following are the parameter descriptions and default values
Parameter
Description
RespType
Response type can be REFRESH_RESP, STATUS_RESP, UPDATE_RESP
RespTypeNum
Response type number can be 0 (SOLICITED),1(UNSOLICITED)
IndicationMask
Indication mask can be ATTRIB_INFO_IN_UPDATES,
CONFLATION_INFO_IN_UPDATES, CLEAR_CACHE, DO_NOT_CACHE,
DO_NOT_CONFLATE, DO_NOT_RIPPLE, REFRESH_COMPLETE
dataMask
Data mask can be INFO, STATE, GROUP, LOAD, DATA, LINK
Parameter
Description
ServicesMap

com.apama.rfa.Service(SDInfoFilterEntry info,
SDStateFilterEntry state,SDGroupFilterEntry group,
SDLoadFilterEntry load,SDDataFilterEntry data,
SDLinkFilterEntry link)
SDInfoFilterEntry
Information about a service that does not update very often.

com.apama.rfa.SDInfoFilterEntry(string Name,
sequence <integer> Capabilities,
sequence <string> DictionariesProvided,
sequence <string> DictionariesUsed,
dictionary <string, string> __payload)
Name. Service name
Capabilities. MessageModelTypes that the service can provide. List of all message model types are
*MARKET_PRICE = 6
*MARKET_BY_ORDER = 7
*MARKET_BY_PRICE = 8
*MARKET_MAKER= 9
*SYMBOL_LIST = 10
DictionariesProvided. This field can be ignored as RMDS doesn't support dictionary publishing
DictionariesUsed. List of Dictionary names that may be required to process all of the data from this service.
SDStateFilterEntry
State of a service.

com.apama.rfa.SDStateFilterEntry(integer ServiceState,
integer AcceptingRequests,string Status)
ServiceState. 1 (Up/Yes), 0 (Down/No)
AcceptingRequests. 1 (Yes),0 (No). If the value is 0, then consuming applications should not send any requests to the service provider.
Status. State that should be fanned out to all open streams in all groups of the service. Format is {Stream,Data,Code,Text}. For example, Unspecified(0),Unspecified(0),None (0),"".
Stream can accept UNSPECIFIED, OPEN, NONSTREAMING, CLOSED_RECOVER, CLOSED, REDIRECT.
Data can accept UNSPECIFIED, OK, SUSPECT.
Code can accept NONE, NOT_FOUND, TIMEOUT, NOT_ENTITLED, INVALID_ARGUMENT, USAGE_ERROR, PREEMPTED, JIT_CONFLATION_STARTED, REALTIME_RESUMED, FAILOVER_STARTED, FAILOVER_COMPLETED, GAP_DETECTED, NO_RESOURCES, TOO_MANY_ITEMS, ALREADY_OPEN, SOURCE_UNKNOWN, NOT_OPEN, MAX_RESERVED
SDGroupFilterEntry
Used for transient groups messages for the service.

com.apama.rfa.SDGroupFilterEntry(string Group,
string MergedGroup,string Status)
Group. Group for this group status message
MergedGroup. Used to merge all of the items from one group into another group.
Status. State that should be fanned out to all open streams in specified group of this service.
SDLoadFilterEntry
Statistics about how many concurrent streaming requests the service can support and how many it is currently servicing.

com.apama.rfa.SDLoadFilterEntry(integer OpenLimit,
integer OpenWindow,integer LoadFactor)
OpenLimit. Maximum number of streaming items that the client is allowed to open to this service.
OpenWindow. Maximum number of outstanding new refresh requests (that is, requests for items which are not already open) service can receive at any given time.
LoadFactor. The load level specifies the current load on each source server.
SDDataFilterEntry
Broadcast data that applies to all items requested from that service.
com.apama.rfa.SDDataFilterEntry(integer Type,string Data)
Type. Explanation of the Data.Type is of UInt32.
Range is 0 to 1023. For example, Time(1), Alert (2), Headline (3), Status (4)
Data. Data that should be applied to all items from the service that have an ANSI_Page data type.
SDLinkFilterEntry
Provides information which RMDS can use for load balancing.

com.apama.rfa.SDLinkFilterEntry(integer Type,
integer LinkState,integer LinkCode,string Data)
Type. This tells us if the back link is interactive or broadcast. This does not describe if the service itself is interactive or broadcast. Range is 1 to 2 (1: Interactive , 2: Broadcast). Default value is 1.
LinkState. 0 (Down), 1 (Up)
LinkCode:
*0 (None)
*1 (Ok)
*2 (RecoveryStarted)
*3 (RecoveryCompleted)
Data. Explanation of the LinkState and LinkCode.