Package com.apama.session

Event summary
ConnectionHeartbeatThe ConnectionHeartbeat event is sent at a configurable interval so that a data source that is external to the correlator (e.g. an IAF adapter) knows that the correlator is still running.
ConnectionHeartbeatResponseThe ConnectionHeartbeatResponse event is sent in response to the ConnectionHeartbeat event so that the correlator knows that a data source that is external to the correlator (e.g. an IAF adapter) is still running.
CPThe Control parameter describes a single instance of a configurable control parameter that is supported by the Source/Adapter.
CreateUserSessionAn event requesting a new user session.
CtrlParamsControl Parameter event that is passed back to the Source/Adapter on connection.
CtrlParamsSchemaThe Control Parameter Schema event is passed from the Source/Adapter on initialization. This event describes the control parameters (CP) that can (or must) be set on connection to the Source/Adapter.
DataSourceErrorError events from a data source, these are handled ONLY by the Session Manager Service which will translate these errors into SessionError which will then be forwarded on to all clients that are interested in this error.
EndUserSessionAn event requesting a user session terminate.
ExternalSessionRegistrationThe ExternalSessionRegistration event is sent by a data source that is external to the correlator (e.g. an IAF adapter) and contains information about a specific session that it supports.
HandlerErrorConstantsError Constants event for the Session Handler. These provide the possible values for the errorType parameter in the Error Callback of the Subscription Handlers, and the possible keys for the extraParams dictionary.
LegacyMDToSessionThis event is sent by the user to construct a table specifying how to convert from the legacy market data key to the new market data key.
LocalSessionRegistrationThe LocalSessionRegistration event is sent by a data source that is internal to the correlator (e.g. the simulator) and contains information about a specific session that it supports.
SCPThe Session Config parameter describes a single instance of a configurable Session Config parameter that is supported by the Source/Adapter.
SessionConfigParamsSession Config Parameter event that is passed back to the Source/Adapter on Session Start.
SessionConfigSchemaThe Session Config Parameter Schema event is passed from the Source/Adapter on registration. This event describes the control parameters (CP) that can (or must) be set on SessionStart to the Source/Adapter.
SessionControlErrorThe SessionControlError event is sent from the data source when a Session Control event (i.e. SessionStart, SessionStop, SessionReconfigure, or SessionDeregistration) is unsuccessful, and a relevant error string is returned.
SessionControlSuccessThe SessionControlSuccess event is sent from the data source when a Session Control event (i.e. SessionStart, SessionStop, SessionReconfigure, and SessionDeregistration) is successful.
SessionDeregisterSelf-reflecting action used to Deregister a specified session with a set of configuration parameters.
SessionErrorSessionError events indicate that a problem occurred with the current session and will be forwarded on to all clients that are interested in this event.
SessionErrorConstantsThis event defines a set of constants that be used by the SessionError object and applications that are interrogating the SessionError object.
SessionHandlerA helper interface event for connecting and administrating an MDA Session. The interface must be constructed using the com.apama.session.SessionHandlerFactory.
SessionHandlerFactoryFactory event to construct fully initialized SessionHandler interface events. It also provides helper actions to allow commonly used functionality from the Handler to be run in a single line, such as connecting.
SessionInfoThe SessionInfo object contains all information relating to a specific registered Session, including its current state and configuration.
SessionKeyThe SessionKey is a subset of the information in the SessionInfo object, and contains all the information necessary for applications to communicate with a specific Session.
SessionManagerThe Session Manager event is used to control and configure Sessions, and also allows applications to interrogate what sessions are currently available, and what they support.
SessionManagerFactory  
SessionManagerInterfaceThe Session Manager Interface allows applications to control and configure Sessions, and also allows applications to interrogate what sessions are currently available, and what they support.
SessionManagerServiceConstsThe constants for the Session Manager Service.
SessionReconfigureSelf-reflecting action used to Reconfigure a specified session with a set of configuration parameters.
SessionRegistrationErrorThe SessionRegistrationSuccess event is sent to the data source if its session registration was unsuccessful.
SessionRegistrationSuccessThe SessionRegistrationSuccess event is sent to the data source if its session registration was successful, and it provides the data source with a unique sessionId that the data source should use for all communication with this session.
SessionResetThis event resets the data source session back to its initial state.
SessionStartSelf-reflecting action used to Start a specified session with a set of configuration parameters.
SessionStopSelf-reflecting action used to Stop a specified session with a set of configuration parameters.
SessionTransportKeyTuple containing the sessionName and TransportName.
UserAn event denoting a new user.
UserSessionAn event denoting the beginning of a user session.
UserSessionDataViewA user session dataview wrapper object.
UserSessionEndedAn event denoting the end of a user session.
UserSessionRequestAn event requesting details of a user session.
UserSessionResponseA user session request response.
UserSessionResponseErrorA user session request response error.
UserSessionUpdateA user session update.

 

 

 
Monitor summary
SessionManagerService  
UserSessionServiceThe user session service.