Engine::AdminApplication Class Reference

#include <B2BITS_AdminApplication.h>

Inheritance diagram for Engine::AdminApplication:

Inheritance graph
[legend]
Collaboration diagram for Engine::AdminApplication:

Collaboration graph
[legend]

List of all members.

Public Member Functions

void bindSession (Session *pSession)
void terminate ()

Protected Types

typedef std::map< std::string,
std::string > 
CommandTable

Protected Member Functions

virtual bool process (const std::string &action, const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *element, const Context &context)
void sendResponse (const XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *response, const Context &context) const
virtual void sendResponse (const std::string &response, const Context &context) const
void sendResponse (const std::string &resultCode, const std::string &description, const std::string &additionalData, const Context &context) const
virtual void getAvailableCommands (CommandTable *commands) const
virtual bool process (const FIXMessage &msg, const Session &sn)
virtual void OnBindAdminSession (const Session *pSession)
void sendReject (const Session &sn, const FIXMessage &msg, const std::string &text)
virtual void onLogonEvent (const LogonEvent *event, const Session &sn)
virtual void onLogoutEvent (const LogoutEvent *event, const Session &sn)
virtual void onUnexpectedMessageEvent (const UnexpectedMessageEvent *, const Session &)
virtual void onSequenceGapEvent (const SequenceGapEvent *event, const Session &sn)
virtual void onSessionLevelRejectEvent (const SessionLevelRejectEvent *event, const Session &sn)
virtual void onMsgRejectEvent (const MsgRejectEvent *event, const Session &sn)
virtual void onHeartbeatWithTestReqIDEvent (const HeartbeatWithTestReqIDEvent &event, const Session &sn)
virtual void onResendRequestEvent (const ResendRequestEvent &event, const Session &sn)
virtual void onNewStateEvent (const NewStateEvent &event, const Session &sn)
virtual void onUnableToRouteMessage (const UnableToRouteMessageEvent &event, const Session &sn)
virtual bool onResend (const FIXMessage &msg, const Session &sn)
void executeHelp (const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *element, const Context &context)
void executeSessionStatus (const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *element, const Context &context)
void executeSessionList (const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *element, const Context &context)
void executeSessionStat (const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *element, const Context &context)
void executeGeneralSessionsStat (const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *element, const Context &context)
void executeCreateAcceptor (const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *element, const Context &context)
void executeDelete (const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *element, const Context &context)
void executeAverageReceivedStat (const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *element, const Context &context)
void executeAverageSentStat (const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *element, const Context &context)
void executeAverageValidateStat (const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *element, const Context &context)
void executeReceivedStat (const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *element, const Context &context)
void executeSentStat (const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *element, const Context &context)
void executeProceedStat (const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *element, const Context &context)
void executeToBackup (const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *element, const Context &context)
void executeChangeSeqNum (const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *element, const Context &context)
void executeResetSeqNum (const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *element, const Context &context)
void executeTestRequest (const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *element, const Context &context)
void executeHeartbeat (const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *element, const Context &context)
void executeSendMessage (const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *element, const Context &context)
void executeDeleteAll (const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *element, const Context &context)
bool getChildNodeValue (const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *element, const XMLCh *name, std::string *value) const
bool getChildNodeValues (const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *parentNode, const XMLCh *subnodeName, const XMLCh *paramName, std::list< std::string > &values) const
bool getChildNodeValues (const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *element, const XMLCh *name, std::list< std::string > &values) const
bool getChildNodeValueInt (const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *element, const XMLCh *name, int *value, std::string *) const
bool getChildNodeValueBool (const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *element, const XMLCh *name, bool *value, std::string *) const

Classes

struct  Context


Detailed Description

Administrative application interface.

Member Typedef Documentation

typedef std::map<std::string, std::string> Engine::AdminApplication::CommandTable [protected]

Type is used to get description of available commands.

Parameters:
key command name
value command description in XML format: <[Command name]> [command description] <Parameter> <Name>[parameter name (required)]</Name> [parameter description (required)] <IsRequired>[true/false (required)]</IsRequired> <DefaultValue>[default value]</DefaultValue> </Parameter> ... </[Command name]>


Member Function Documentation

void Engine::AdminApplication::bindSession ( Session pSession  ) 

Binds session with AdminApplication. Application takes reference to the session

void Engine::AdminApplication::terminate (  ) 

Terminates all administrative sessions.

virtual bool Engine::AdminApplication::process ( const std::string &  action,
const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *  element,
const Context context 
) [protected, virtual]

Processes action.

Parameters:
action name.
element xml element of action.
Returns:
true if action was identify and succesfully executed.

void Engine::AdminApplication::sendResponse ( const XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *  response,
const Context context 
) const [protected]

Sends response message to client.

Parameters:
response response body.

virtual void Engine::AdminApplication::sendResponse ( const std::string &  response,
const Context context 
) const [protected, virtual]

Sends response message to client.

Parameters:
response response body.

void Engine::AdminApplication::sendResponse ( const std::string &  resultCode,
const std::string &  description,
const std::string &  additionalData,
const Context context 
) const [protected]

Sends response message to client in format: <?xml version="1.0"?> <Response resultcode="[resultCode]"> [description] [additionalData] </Response>

virtual void Engine::AdminApplication::getAvailableCommands ( CommandTable commands  )  const [protected, virtual]

Returns description of commands. Derived class can modify list of commands at its discretion.

virtual bool Engine::AdminApplication::process ( const FIXMessage msg,
const Session sn 
) [protected, virtual]

A call-back method to process incoming messages. If the application can not process the given message, the FIX Engine will try to deliver it later according to "Delayed Processing Algorithm".

Warning:
This method should complete as quickly as possible. Do not perform time-consuming tasks inside it.
Parameters:
msg the incoming message.
sn The corresponding FIX session.
Returns:
true if the application can process the given message, otherwise false.

Implements Engine::Application.

virtual void Engine::AdminApplication::OnBindAdminSession ( const Session pSession  )  [inline, protected, virtual]

Method is called when application is binded with new session.

void Engine::AdminApplication::sendReject ( const Session sn,
const FIXMessage msg,
const std::string &  text 
) [protected]

Sends Reject message into the session.

virtual void Engine::AdminApplication::onLogonEvent ( const LogonEvent event,
const Session sn 
) [protected, virtual]

This call-back method is called to notify that the Logon message has been received from the counterpart.

Parameters:
event Event information.
sn The corresponding FIX session.

Implements Engine::Application.

virtual void Engine::AdminApplication::onLogoutEvent ( const LogoutEvent event,
const Session sn 
) [inline, protected, virtual]

This call-back method is called to notify that the Logout message has been received from the counterpart or the session was disconnected.

Parameters:
event Information about occured event.
sn The corresponding FIX session.

Implements Engine::Application.

virtual void Engine::AdminApplication::onUnexpectedMessageEvent ( const UnexpectedMessageEvent ,
const Session  
) [inline, protected, virtual]

This call-back method is called to notify about recevied unexpected message. For example - when first message in session is not a Logon.

Parameters:
event Information about occured event.
sn The corresponding FIX session.

Reimplemented from Engine::Application.

virtual void Engine::AdminApplication::onSequenceGapEvent ( const SequenceGapEvent event,
const Session sn 
) [inline, protected, virtual]

This call-back method is called when a message gap is detected in incoming messages.

Parameters:
event Information about occured event.
sn The corresponding FIX session.

Implements Engine::Application.

virtual void Engine::AdminApplication::onSessionLevelRejectEvent ( const SessionLevelRejectEvent event,
const Session sn 
) [inline, protected, virtual]

This call-back method is called when a session-level Reject message (MsgType = 3) is received.

Parameters:
event Information about occured event.
sn The corresponding FIX session.

Implements Engine::Application.

virtual void Engine::AdminApplication::onMsgRejectEvent ( const MsgRejectEvent event,
const Session sn 
) [inline, protected, virtual]

This call-back method is called when a message have to be rejected.

Parameters:
event - object that incapsulates rejected message
sn - session object that rejects message

Implements Engine::Application.

virtual void Engine::AdminApplication::onHeartbeatWithTestReqIDEvent ( const HeartbeatWithTestReqIDEvent event,
const Session sn 
) [inline, protected, virtual]

This call-back method is called when a Heartbeat message (MsgType = 0) with the TestReqID field (tag = 112) has been received.

Usually such a message is sent in reply to a Test Request (MsgType = 1) message.

Parameters:
event Information about occured event.
sn The corresponding FIX session.

Implements Engine::Application.

virtual void Engine::AdminApplication::onResendRequestEvent ( const ResendRequestEvent event,
const Session sn 
) [inline, protected, virtual]

This call-back method is called when a Resend Request (MsgType = 2) has been received.

Parameters:
event Information about occured event.
sn The corresponding FIX session.

Implements Engine::Application.

virtual void Engine::AdminApplication::onNewStateEvent ( const NewStateEvent event,
const Session sn 
) [inline, protected, virtual]

This call-back method is called when the session has changed its state.

Parameters:
event Information about occured event.
sn The corresponding FIX session.

Implements Engine::Application.

virtual void Engine::AdminApplication::onUnableToRouteMessage ( const UnableToRouteMessageEvent event,
const Session sn 
) [inline, protected, virtual]

This call-back method is called when the message has to be routed to the session, which does not exist.

Parameters:
event Information about occured event.
sn The corresponding FIX session.

Implements Engine::Application.

virtual bool Engine::AdminApplication::onResend ( const FIXMessage msg,
const Session sn 
) [inline, protected, virtual]

This call-back method is called when an outgoing message is about to be resent as a reply to the incoming ResendRequest message.

If the method returns 'true' then the Engine resends the message to counterpart, otherwise it sends the SequenceReset Gap Fill message.

Parameters:
msg Outgoing message.
sn FIX session.
Returns:
true if the message should be resent, otherwise false.

Implements Engine::Application.

void Engine::AdminApplication::executeHelp ( const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *  element,
const Context context 
) [protected]

Process the help command.

void Engine::AdminApplication::executeSessionStatus ( const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *  element,
const Context context 
) [protected]

Process the SessionStatus command.

void Engine::AdminApplication::executeSessionList ( const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *  element,
const Context context 
) [protected]

Process the SessionList command.

void Engine::AdminApplication::executeSessionStat ( const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *  element,
const Context context 
) [protected]

Process the SessionStat command.

void Engine::AdminApplication::executeGeneralSessionsStat ( const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *  element,
const Context context 
) [protected]

Process the GeneralSessionStat command.

void Engine::AdminApplication::executeCreateAcceptor ( const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *  element,
const Context context 
) [protected]

Process the CreateAcceptor command.

void Engine::AdminApplication::executeDelete ( const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *  element,
const Context context 
) [protected]

Process the Delete command.

void Engine::AdminApplication::executeAverageReceivedStat ( const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *  element,
const Context context 
) [protected]

Process the AverageReceivedStat command.

void Engine::AdminApplication::executeAverageSentStat ( const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *  element,
const Context context 
) [protected]

Process the AverageSentStat command.

void Engine::AdminApplication::executeAverageValidateStat ( const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *  element,
const Context context 
) [protected]

Process the AverageValidateStat command.

void Engine::AdminApplication::executeReceivedStat ( const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *  element,
const Context context 
) [protected]

Process the ReceivedStat command.

void Engine::AdminApplication::executeSentStat ( const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *  element,
const Context context 
) [protected]

Process the SentStat command.

void Engine::AdminApplication::executeProceedStat ( const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *  element,
const Context context 
) [protected]

Process the Proceed command.

void Engine::AdminApplication::executeToBackup ( const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *  element,
const Context context 
) [protected]

Process the ToBackup command.

void Engine::AdminApplication::executeChangeSeqNum ( const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *  element,
const Context context 
) [protected]

Process the ChangeSeqNum command.

void Engine::AdminApplication::executeResetSeqNum ( const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *  element,
const Context context 
) [protected]

Process the ResetSeqNum command.

void Engine::AdminApplication::executeTestRequest ( const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *  element,
const Context context 
) [protected]

Process the TestRequest command.

void Engine::AdminApplication::executeHeartbeat ( const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *  element,
const Context context 
) [protected]

Process the HeartBeat command.

void Engine::AdminApplication::executeSendMessage ( const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *  element,
const Context context 
) [protected]

Process the SendMessage command.

void Engine::AdminApplication::executeDeleteAll ( const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *  element,
const Context context 
) [protected]

Process the DeleteAll command.

bool Engine::AdminApplication::getChildNodeValue ( const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *  element,
const XMLCh *  name,
std::string *  value 
) const [protected]

Method locates child node and returns it's value

bool Engine::AdminApplication::getChildNodeValues ( const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *  parentNode,
const XMLCh *  subnodeName,
const XMLCh *  paramName,
std::list< std::string > &  values 
) const [protected]

Method locates child nodes and returns values

bool Engine::AdminApplication::getChildNodeValues ( const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *  element,
const XMLCh *  name,
std::list< std::string > &  values 
) const [protected]

Method locates child nodes and returns values

bool Engine::AdminApplication::getChildNodeValueInt ( const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *  element,
const XMLCh *  name,
int *  value,
std::string *   
) const [protected]

Method locates child node and returns integer value

bool Engine::AdminApplication::getChildNodeValueBool ( const XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *  element,
const XMLCh *  name,
bool *  value,
std::string *   
) const [protected]

Method locates child node and returns boolearn value


The documentation for this class was generated from the following file:

Generated on Fri Apr 17 12:26:51 2009 for B2BITS FIX Antenna C++ by  doxygen 1.5.6