John Colvin
fc1ae2e5cb
WARNING: This is NOT an official release. As of 12/10/21 20:23, the latest release of the quickfix lib (1.15.1) does not support c++17 (the FIX::Application class has fns with dynamic exceptions). This commit upgrades to a more recent (unreleased) build which supports c++17.
128 lines
5.1 KiB
C++
128 lines
5.1 KiB
C++
/* -*- C++ -*- */
|
|
|
|
/****************************************************************************
|
|
** Copyright (c) 2001-2014
|
|
**
|
|
** This file is part of the QuickFIX FIX Engine
|
|
**
|
|
** This file may be distributed under the terms of the quickfixengine.org
|
|
** license as defined by quickfixengine.org and appearing in the file
|
|
** LICENSE included in the packaging of this file.
|
|
**
|
|
** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
|
|
** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
|
|
**
|
|
** See http://www.quickfixengine.org/LICENSE for licensing information.
|
|
**
|
|
** Contact ask@quickfixengine.org if any conditions of this licensing are
|
|
** not clear to you.
|
|
**
|
|
****************************************************************************/
|
|
|
|
#ifndef FIX_APPLICATION_H
|
|
#define FIX_APPLICATION_H
|
|
|
|
#include "Message.h"
|
|
#include "SessionID.h"
|
|
#include "Mutex.h"
|
|
|
|
namespace FIX
|
|
{
|
|
/**
|
|
* This interface must be implemented to define what your %FIX application
|
|
* does.
|
|
*
|
|
* These methods notify your application about events that happen on
|
|
* active %FIX sessions. There is no guarantee how many threads will be calling
|
|
* these functions. If the application is sharing resources among multiple sessions,
|
|
* you must synchronize those resources. You can also use the SynchronizedApplication
|
|
* class to automatically synchronize all function calls into your application.
|
|
* The various MessageCracker classes can be used to parse the generic message
|
|
* structure into specific %FIX messages.
|
|
*/
|
|
class Application
|
|
{
|
|
public:
|
|
virtual ~Application() {};
|
|
/// Notification of a session begin created
|
|
virtual void onCreate( const SessionID& ) = 0;
|
|
/// Notification of a session successfully logging on
|
|
virtual void onLogon( const SessionID& ) = 0;
|
|
/// Notification of a session logging off or disconnecting
|
|
virtual void onLogout( const SessionID& ) = 0;
|
|
/// Notification of admin message being sent to target
|
|
virtual void toAdmin( Message&, const SessionID& ) = 0;
|
|
/// Notification of app message being sent to target
|
|
virtual void toApp( Message&, const SessionID& )
|
|
EXCEPT ( DoNotSend ) = 0;
|
|
/// Notification of admin message being received from target
|
|
virtual void fromAdmin( const Message&, const SessionID& )
|
|
EXCEPT ( FieldNotFound, IncorrectDataFormat, IncorrectTagValue, RejectLogon ) = 0;
|
|
/// Notification of app message being received from target
|
|
virtual void fromApp( const Message&, const SessionID& )
|
|
EXCEPT ( FieldNotFound, IncorrectDataFormat, IncorrectTagValue, UnsupportedMessageType ) = 0;
|
|
};
|
|
|
|
/**
|
|
* This is a special implementation of the Application interface that takes
|
|
* in another Application interface and synchronizes all of its callbacks. This
|
|
* will guarantee that only one thread will access the applications code at a time.
|
|
*
|
|
* This class is a great convenience for writing applications where you
|
|
* don't want to worry about synchronization. There is of course a tradeoff
|
|
* in that you may be synchronizing more than you need to. There is also a very
|
|
* minor performance penalty due to the extra virtual table lookup.
|
|
*/
|
|
class SynchronizedApplication : public Application
|
|
{
|
|
public:
|
|
SynchronizedApplication( Application& app ) : m_app( app ) {}
|
|
|
|
void onCreate( const SessionID& sessionID )
|
|
{ Locker l( m_mutex ); app().onCreate( sessionID ); }
|
|
void onLogon( const SessionID& sessionID )
|
|
{ Locker l( m_mutex ); app().onLogon( sessionID ); }
|
|
void onLogout( const SessionID& sessionID )
|
|
{ Locker l( m_mutex ); app().onLogout( sessionID ); }
|
|
void toAdmin( Message& message, const SessionID& sessionID )
|
|
{ Locker l( m_mutex ); app().toAdmin( message, sessionID ); }
|
|
void toApp( Message& message, const SessionID& sessionID )
|
|
EXCEPT ( DoNotSend )
|
|
{ Locker l( m_mutex ); app().toApp( message, sessionID ); }
|
|
void fromAdmin( const Message& message, const SessionID& sessionID )
|
|
EXCEPT ( FieldNotFound, IncorrectDataFormat, IncorrectTagValue, RejectLogon )
|
|
{ Locker l( m_mutex ); app().fromAdmin( message, sessionID ); }
|
|
void fromApp( const Message& message, const SessionID& sessionID )
|
|
EXCEPT ( FieldNotFound, IncorrectDataFormat, IncorrectTagValue, UnsupportedMessageType )
|
|
{ Locker l( m_mutex ); app().fromApp( message, sessionID ); }
|
|
|
|
Mutex m_mutex;
|
|
|
|
Application& app() { return m_app; }
|
|
Application& m_app;
|
|
};
|
|
|
|
/**
|
|
* An empty implementation of an Application. This can be used if you
|
|
* do not want to provide an implementation for all the callback methods.
|
|
* It is also useful for unit tests writing unit tests where the callback
|
|
* values of some or all methods are not of interest.
|
|
*/
|
|
class NullApplication : public Application
|
|
{
|
|
void onCreate( const SessionID& ) {}
|
|
void onLogon( const SessionID& ) {}
|
|
void onLogout( const SessionID& ) {}
|
|
void toAdmin( Message&, const SessionID& ) {}
|
|
void toApp( Message&, const SessionID& )
|
|
EXCEPT ( DoNotSend ) {}
|
|
void fromAdmin( const Message&, const SessionID& )
|
|
EXCEPT ( FieldNotFound, IncorrectDataFormat, IncorrectTagValue, RejectLogon ) {}
|
|
void fromApp( const Message&, const SessionID& )
|
|
EXCEPT ( FieldNotFound, IncorrectDataFormat, IncorrectTagValue, UnsupportedMessageType ) {}
|
|
};
|
|
/*! @} */
|
|
}
|
|
|
|
#endif //FIX_APPLICATION_H
|