Session.h

Go to the documentation of this file.

/*
* (c) Onix Solutions.
*/

#ifndef Session_h
#define Session_h

#include <string>

#include "FIXEngineDefines.h"

namespace FIXForge{
namespace FIX{

class FF_API Message;
class FF_API ISessionListener;

/// FIX Session - a bi-directional stream of ordered messages between two parties within a continuous sequence number series.
class FF_API Session{
public: 
    /// Constructor.
    Session(const std::string& senderCompID, const std::string& targetCompID, Version version, bool keepSequenceNumbersAfterLogout, ISessionListener* listener);

    /// Constructor.
    Session(const std::string& senderCompID, const std::string& targetCompID, Version version, ISessionListener* listener);

    /// Destructor.
    ~Session(); 

    /// Session state.
    enum State{DISCONNECTED, LOGON_IN_PROGRESS, LOGOUT_IN_PROGRESS, ACTIVE, RECONNECTING};

    /// Returns the session state.
    State getState();   
    
    /// Returns the session state as a string.
    static const char* state2string(State state);

    enum EncryptionMethod{
        NONE, ///< No encryption
        SSL ///< Secure Sockets Layer
    };

    /// Returns the current encryption method.
    EncryptionMethod getEncryptionMethod() const;

    /// Sets the encryption method.
    void setEncryptionMethod(EncryptionMethod newEncryptionMethod);

    /// Sets the SSL certificate file.
    /// 
    /// @note Only the (Privacy Enhanced Mail) Base 64 Encoded (.pem) SSL certificates are supported. 
    void setSslCertificateFile(const std::string& file);

    /// Sets the SSL private key file.
    /// 
    /// @note Only the (Privacy Enhanced Mail) Base 64 Encoded (.pem) SSL certificates are supported. 
    void setSslPrivateKeyFile(const std::string& file);

    /**
     * Establishes the FIX Connection as Acceptor. 
     *
     * Acceptor is the receiving party of the FIX session. 
     * It listens for the incoming connection on the pre-defined port. 
     * The acceptor has responsibility to perform first level authentication and formally declare 
     * the connection request "accepted" through transmission of an acknowledgment Logon message. 
     */
    void logonAsAcceptor();
    
    /**
     * Establishes FIX Connection as Initiator using the ResetSeqNumFlag(141) field.
     * 
     * Initiator establishes the telecommunications link and initiates the session via transmission
     * of the initial Logon message.    
     */ 
    void logonAsInitiator(const std::string& host, int port, bool setResetSeqNumFlag);

        /**
     * Establishes FIX Connection as Initiator. 
     * 
     * Initiator establishes the telecommunications link and initiates the session via transmission
     * of the initial Logon message.    
     */ 
    void logonAsInitiator(const std::string& host, int port);

    /// Establishes FIX Connection as Initiator using the given Heartbeat interval (seconds).
    void logonAsInitiator(const std::string& host, int port, int heartBtInt);

    /// Establishes FIX Connection as Initiator using the given Heartbeat interval (seconds) and the ResetSeqNumFlag(141) field.
    void logonAsInitiator(const std::string& host, int port, int heartBtInt, bool setResetSeqNumFlag);

    /// Establishes FIX Connection as Initiator using the custom Logon message. 
    void logonAsInitiator(const std::string& host, int port, int heartBtInt, Message* customLogonMsg);

    /// Establishes FIX Connection as Initiator using the custom Logon message and the ResetSeqNumFlag(141) field. 
    void logonAsInitiator(const std::string& host, int port, int heartBtInt, Message* customLogonMsg, bool setResetSeqNumFlag);

    /** 
     * Terminates the FIX Connection. 
     *
     * The initial Logout message is sent to the conterparty and the method blocks until the acknowledgement 
     * Logout message is received.  
     */
    void logout();
    
    /**
     * Terminates the FIX Connection. 
     *
     * @param text Free format text string that is sent to the counterparty in the Text(58) field of the initial 
     * Logout message.
     */
    void logout(const std::string& text);

    /**
     * Sends the message to the counterparty.
     *
     * As soon as a session is created it is possible to start sending messages via the session. 
     * If the session is not established, the messages will be sent when the connection is established with 
     * the counterparty.
     */
    void send(Message* msg);

    /**
     * Shutdowns the session.   
     */
    void shutdown();
    
    /// Returns the string descripton of the session.
    operator const std::string& ();

    /// Returns the counterparty host name or address.
    const std::string& getCounterpartyHost();

    /// Returns the counterparty port number.
    size_t getCounterpartyPort();

    /// Returns the Heartbeat interval (seconds).
    int getHeartBtInt();

    /// Returns the expected sequence number of the next incoming message.
    int getInSeqNum();

    /// Sets the expected sequence number of the next incoming message.
    void setInSeqNum(int seqNum);   

    /// Returns the sequence number of the next outgoing message.
    int getOutSeqNum();

    /// Sets the sequence number of the next outgoing message.
    void setOutSeqNum(int seqNum);

    /// Session role.
    enum Role{NA, INITIATOR, ACCEPTOR};

    /// Returns the session role.
    Role getRole();
    
    /// Returns the assigned value used to identify firm sending message (the SenderCompID (tag=49) field value in outgoing messages).
    const std::string& getSenderCompID();

    /// Returns the Assigned value used to identify receiving firm (the TargetCompID (tag=56) field value in outgoing messages).
    const std::string& getTargetCompID();

    /// Returns the session FIX Protocol version.
    Version getVersion();       

    /// Backups the current log files and resets the sequence numbers to 1. 
    ///
    /// @note This method can be called only when the session is disconnected.
    void reset();

    /// Sends a Logon message with the ResetSeqNumFlag set.
    void resetSeqNumViaLogonExchange();

    /// Sets the SenderSubID (tag=50) field values for all outgoing messages.
    void senderSubID(const std::string& value);

    /// Sets the TargetSubID (tag=57) field values for all outgoing messages.
    void targetSubID(const std::string& value);

    /// Sets the SenderLocationID (tag=142) field values for all outgoing messages.
    void senderLocationID(const std::string& value);

    /// Sets the TargetLocationID (tag=143) field values for all outgoing messages.
    void targetLocationID(const std::string& value);

    /// Sends the Test Request (MsgType=1) message.
    void sendTestRequest(const std::string& testReqID = "");

private:    
    void init(const std::string& senderCompID, const std::string& targetCompID, Version version, 
                bool keepSequenceNumbersAfterLogout, ISessionListener* listener);

 public:    
    struct Impl;    

 private:
    Impl* impl_;    
};
}};

#endif

---