FIXEngine.h

Go to the documentation of this file.

/*
* (c) Onix Solutions.
*/

#ifndef FIXEngine_h
#define FIXEngine_h

#include "./FIXEngineDefines.h"
#include "EngineException.h"

namespace FIXForge{
namespace FIX{
    class IEngineListener;

/**
 * FIX Engine.  
 */
class FF_API Engine{
public:
    /**
     * Initializes the FIX Engine.
     *
     * @param listenPort The engine listens on this port for incoming connections.
     * If '0' then only session-initiators can be created. 
     * If '-1' then the telecommunication level is disabled and only message parsing/assembling can be used. 
     */ 
    static Engine* init(int listenPort = 0);

    /**
    * Initializes the FIX Engine.
    *
    * @param configFile Configuration file. 
    */ 
    static Engine* init(const std::string& configFile);

    /**
    * Initializes the FIX Engine.
    *
    * @param configuration Configuration string.    
    */ 
    static Engine* initFromString(const std::string& configuration);

    /// Shutdowns the FIX Engine and releases all resources.
    static void shutdown();

    /**
     * Returns the Engine instance.
     *
     * @throw EngineException if the FIX Engine has not been initialized yet.
     */
    static Engine* instance();

    /// Returns 'true' if the FIX Engine has been initialized, otherwise - 'false'.
    static bool isInitialized();

    /**
    * Returns the listen port.
    * 
    * The FIX Engine listens on this port for incoming connections. 
    */ 
    int getListenPort();

    /// Registers the Engine listener.
    ///  @throw Exception if the listener is already registered.
    void registerListener(IEngineListener* listener);

    /// Un-registers the Engine listener.
    void unregisterListener();

    struct Impl;

private:    
    Engine();

    ~Engine();

    Impl* impl_;

    static Engine* instance_;

    friend class Message;
};
}};

#endif

---