connection.hpp

Go to the documentation of this file.

//-------------------------------------------------------------------------------------------------
/*

Fix8 is released under the GNU LESSER GENERAL PUBLIC LICENSE Version 3.

Fix8 Open Source FIX Engine.
Copyright (C) 2010-16 David L. Dight <fix@fix8.org>

Fix8 is free software: you can  redistribute it and / or modify  it under the  terms of the
GNU Lesser General  Public License as  published  by the Free  Software Foundation,  either
version 3 of the License, or (at your option) any later version.

Fix8 is distributed in the hope  that it will be useful, but WITHOUT ANY WARRANTY;  without
even the  implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

You should  have received a copy of the GNU Lesser General Public  License along with Fix8.
If not, see <http://www.gnu.org/licenses/>.

BECAUSE THE PROGRAM IS  LICENSED FREE OF  CHARGE, THERE IS NO  WARRANTY FOR THE PROGRAM, TO
THE EXTENT  PERMITTED  BY  APPLICABLE  LAW.  EXCEPT WHEN  OTHERWISE  STATED IN  WRITING THE
COPYRIGHT HOLDERS AND/OR OTHER PARTIES  PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY
KIND,  EITHER EXPRESSED   OR   IMPLIED,  INCLUDING,  BUT   NOT  LIMITED   TO,  THE  IMPLIED
WARRANTIES  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS TO
THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE,
YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

IN NO EVENT UNLESS REQUIRED  BY APPLICABLE LAW  OR AGREED TO IN  WRITING WILL ANY COPYRIGHT
HOLDER, OR  ANY OTHER PARTY  WHO MAY MODIFY  AND/OR REDISTRIBUTE  THE PROGRAM AS  PERMITTED
ABOVE,  BE  LIABLE  TO  YOU  FOR  DAMAGES,  INCLUDING  ANY  GENERAL, SPECIAL, INCIDENTAL OR
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR
THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH
HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

*/
//-------------------------------------------------------------------------------------------------
#ifndef FIX8_CONNECTION_HPP_
#define FIX8_CONNECTION_HPP_

#include <Poco/Net/StreamSocket.h>
#include <Poco/Timespan.h>
#include <Poco/Net/NetException.h>

//----------------------------------------------------------------------------------------
namespace FIX8 {

class Session;

//----------------------------------------------------------------------------------------

template <typename T>
class AsyncSocket
{
protected:
   coroutine _coro;
   Poco::Net::StreamSocket *_sock;
   f8_concurrent_queue<T> _msg_queue;
   Session& _session;
   ProcessModel _pmodel;
   f8_thread_cancellation_token _cancellation_token;
   volatile bool _started;
   f8_mutex _start_mutex;

private:
   f8_thread<AsyncSocket> _thread;

public:
   AsyncSocket(Poco::Net::StreamSocket *sock, Session& session, const ProcessModel pmodel=pm_pipeline)
      : _sock(sock), _session(session), _pmodel(pmodel), _started(false), _thread(std::ref(*this)) {}

   virtual ~AsyncSocket() = default;

   size_t queued() const { return _msg_queue.size(); }

   bool started() const { return _started; }

   int operator()() { return execute(_cancellation_token); }

   virtual int execute(f8_thread_cancellation_token& cancellation_token) { return 0; }

   virtual void start()
   {
      if (!_started)
      {
         f8_scoped_lock guard(_start_mutex);
         if (!_started)
         {
            _started = true;
            _thread.start();
         }
      }
      else
      {
         glout_warn << "AsyncSocket already started.";
      }
   }

   virtual void request_stop() { _thread.request_stop(); }

   virtual void quit() { _thread.request_stop(); join(); }

   Poco::Net::StreamSocket *socket() { return _sock; }

   int join() { return _thread.join(); }

   f8_thread_cancellation_token& cancellation_token() { return _cancellation_token; }
};

//----------------------------------------------------------------------------------------
class FIXReader : public AsyncSocket<f8String>
{
   enum { _max_msg_len = FIX8_MAX_MSG_LENGTH, _chksum_sz = 7 };
   f8_atomic<bool> _socket_error;

   f8_thread<FIXReader> _callback_thread;
   f8_thread_cancellation_token _callback_cancellation_token;

#if FIX8_EXPERIMENTAL_BUFFERED_SOCKET_READ
    char _read_buffer[_max_msg_len*2];
    char *_read_buffer_rptr, *_read_buffer_wptr;
#endif

   F8API int callback_processor();

   size_t _bg_sz; // 8=FIXx.x^A9=x

   bool read(f8String& to);

#if FIX8_EXPERIMENTAL_BUFFERED_SOCKET_READ

   int sockRead(char *where, size_t sz)
   {
      const size_t available_in_buffer(static_cast<size_t>(_read_buffer_wptr - _read_buffer_rptr));
      if (available_in_buffer < sz)
         realSockRead(sz - available_in_buffer, _max_msg_len);
      sz = std::min((size_t)(_read_buffer_wptr-_read_buffer_rptr), sz);
      memcpy(where, _read_buffer_rptr, sz);
      _read_buffer_rptr += sz;
      const size_t shift(_max_msg_len);
      if (static_cast<size_t>(_read_buffer_rptr - _read_buffer) >= shift)
      {
         memcpy(_read_buffer, &_read_buffer[shift], sizeof(_read_buffer) - shift);
         _read_buffer_rptr -= shift;
         _read_buffer_wptr -= shift;
      }
      return sz;
   }

   int realSockRead(size_t sz, size_t maxsz)
   {
      const size_t max_sz(_read_buffer + sizeof(_read_buffer) - _read_buffer_wptr);
      int maxremaining(std::min(maxsz, max_sz)), remaining(std::min(sz, max_sz));
      char *ptr(_read_buffer_wptr), *eptr(_read_buffer + sizeof(_read_buffer));

      int rdsz(0);
      while (remaining > 0 && _read_buffer_wptr < eptr)
      {
         rdsz = _sock->receiveBytes(_read_buffer_wptr, maxremaining);
         if (rdsz <= 0)
         {
            if (errno == EAGAIN
#if defined EWOULDBLOCK && EAGAIN != EWOULDBLOCK
               || errno == EWOULDBLOCK
#endif
            )
               continue;
            throw PeerResetConnection("sockRead: connection gone");
         }
         _read_buffer_wptr += rdsz;
         remaining -= rdsz;
         maxremaining -= rdsz;
      }
      return _read_buffer_wptr - ptr;
   }
#else

   int sockRead(char *where, const size_t sz)
   {
      unsigned remaining(static_cast<unsigned>(sz)), rddone(0);
      while (remaining > 0)
      {
         const int rdSz(_sock->receiveBytes(where + rddone, remaining));
         if (rdSz <= 0)
         {
            if (errno == EAGAIN
#if defined EWOULDBLOCK && EAGAIN != EWOULDBLOCK
               || errno == EWOULDBLOCK
#endif
            )
               continue;
            throw PeerResetConnection("sockRead: connection gone");
         }
         rddone += rdSz;
         remaining -= rdSz;
      }
      return rddone;
   }
#endif

public:
   FIXReader(Poco::Net::StreamSocket *sock, Session& session, const ProcessModel pmodel=pm_pipeline)
      : AsyncSocket<f8String>(sock, session, pmodel), _callback_thread(std::ref(*this), &FIXReader::callback_processor)
#if FIX8_EXPERIMENTAL_BUFFERED_SOCKET_READ
      , _read_buffer(), _read_buffer_rptr(_read_buffer), _read_buffer_wptr(_read_buffer)
#endif
      , _bg_sz()
   {
      set_preamble_sz();
   }

   virtual ~FIXReader()
   {
      stop();
      join();
   }

   virtual void start()
   {
      _socket_error = false;
      if (_pmodel != pm_coro)
         AsyncSocket<f8String>::start();
      if (_pmodel == pm_pipeline)
      {
         if (_callback_thread.start())
            _socket_error = true;
      }
   }

   virtual void quit()
   {
      if (_pmodel == pm_pipeline)
      {
         _callback_thread.request_stop();
         _callback_thread.join();
      }
      if (_pmodel != pm_coro)
         AsyncSocket<f8String>::quit();
   }

   virtual void stop()
   {
      if (_started)
      {
         f8_scoped_lock guard(_start_mutex);
         if (_started)
         {
            if (_pmodel == pm_pipeline)
            {
               const f8String from;
               _msg_queue.try_push(from);
               _callback_thread.request_stop();
            }
            if (_pmodel != pm_coro)
               AsyncSocket<f8String>::request_stop();
         }
      }
      else
      {
         glout_warn << "FIXReader: AsyncSocket already stopped.";
      }
   }

   F8API virtual int execute(f8_thread_cancellation_token& cancellation_token);

   int join() { return _pmodel != pm_coro ? AsyncSocket<f8String>::join() : -1; }

   F8API void set_preamble_sz();

   bool is_socket_error() const { return _socket_error; }

   bool poll(const Poco::Timespan &ts = Poco::Timespan()) const
   {
      return _sock->poll(ts, Poco::Net::Socket::SELECT_READ);
   }

   f8_thread_cancellation_token& callback_cancellation_token() { return _callback_cancellation_token; }
};

//----------------------------------------------------------------------------------------
class FIXWriter : public AsyncSocket<Message *>
{
   f8_spin_lock _con_spl;

public:
   FIXWriter(Poco::Net::StreamSocket *sock, Session& session, const ProcessModel pmodel=pm_pipeline)
      : AsyncSocket<Message *>(sock, session, pmodel) {}

   virtual ~FIXWriter()
   {
      quit();
   }

   bool write(Message *from, bool destroy)
   {
      if (_pmodel == pm_pipeline) // pipeline mode ignores destroy flag
         return _msg_queue.try_push(from);
      f8_scoped_spin_lock guard(_con_spl);
      if (destroy)
      {
         std::unique_ptr<Message> msg(from);
         return _session.send_process(msg.get());
      }
      return _session.send_process(from);
   }

   size_t write_batch(const std::vector<Message *>& msgs, bool destroy)
   {
      if (msgs.empty())
         return 0;
      if (msgs.size() == 1)
         return write(msgs.front(), destroy) ? 1 : 0;
      size_t result(0);
      f8_scoped_spin_lock guard(_con_spl);
      for (std::vector<Message *>::const_iterator itr(msgs.begin()), eitr(msgs.end()), litr(eitr-1); itr != eitr; ++itr)
      {
         Message* msg = *itr;
         msg->set_end_of_batch(itr == litr);
         if (_pmodel == pm_pipeline) // pipeline mode ignores destroy flag
         {
            _msg_queue.try_push(msg);
            ++result;
            continue;
         }
         if (_session.send_process(msg))
            ++result;
      }
      if (destroy && _pmodel != pm_pipeline)
      {
         for (std::vector<Message *>::const_iterator itr(msgs.begin()), eitr(msgs.end()); itr != eitr; ++itr)
         {
            std::unique_ptr<Message> smsg(*itr);
         }
      }
      return result;
   }
   int join() { return _pmodel == pm_pipeline ? AsyncSocket<Message *>::join() : -1; }

   bool write(Message& from)
   {
      if (_pmodel == pm_pipeline) // not permitted if pipeling
         throw f8Exception("cannot send message directly if pipelining");
      f8_scoped_spin_lock guard(_con_spl);
      return _session.send_process(&from);
   }

   bool poll(const Poco::Timespan &ts = Poco::Timespan()) const
   {
      return _sock->poll(ts, Poco::Net::Socket::SELECT_WRITE);
   }

   int send(const char *data, size_t remaining, bool nb=false)
   {
      unsigned wrdone(0);

      while (remaining > 0)
      {
         const int wrtSz(_sock->sendBytes(data + wrdone, static_cast<int>(remaining)));
         if (wrtSz < 0)
         {
            if (errno == EAGAIN
#if defined EWOULDBLOCK && EAGAIN != EWOULDBLOCK
               || errno == EWOULDBLOCK
#endif
            )
            {
               if (nb)
                  return wrdone;
               continue;
            }
            throw PeerResetConnection("send: connection gone");
         }

         wrdone += wrtSz;
         remaining -= wrtSz;
      }

      return wrdone;
   }

   virtual void start()
   {
      if (_pmodel == pm_pipeline)
         AsyncSocket<Message *>::start();
   }

   virtual void stop()
   {
      if (_started)
      {
         f8_scoped_lock guard(_start_mutex);
         if (_started)
         {
            _msg_queue.try_push(0);
            if (_pmodel == pm_pipeline)
               AsyncSocket::request_stop();
         }
      }
      else
      {
         glout_warn << "FIXWriter: AsyncSocket already stopped.";
      }
   }

   F8API virtual int execute(f8_thread_cancellation_token& cancellation_token);

   virtual void quit()
   {
      if (_pmodel == pm_pipeline)
         AsyncSocket<Message *>::quit();
   }

};

//----------------------------------------------------------------------------------------
class Connection
{
public:
   enum Role { cn_acceptor, cn_initiator, cn_unknown };

protected:
   Poco::Net::StreamSocket *_sock;
   Poco::Net::SocketAddress _addr;
   f8_atomic<bool> _connected;
   Session& _session;
   Role _role;
   ProcessModel _pmodel;
   unsigned _hb_interval, _hb_interval20pc;

   FIXReader _reader;
   FIXWriter _writer;
   bool _secured;

public:
   Connection(Poco::Net::StreamSocket *sock, Poco::Net::SocketAddress& addr, Session &session, Role role,
              const ProcessModel pmodel, unsigned hb_interval, bool secured)
      : _sock(sock), _addr(addr), _connected(role == cn_acceptor), _session(session), _role(role), _pmodel(pmodel),
        _hb_interval(hb_interval), _hb_interval20pc(hb_interval + hb_interval / 5),
        _reader(sock, session, pmodel), _writer(sock, session, pmodel),
        _secured(secured) {}

   virtual ~Connection() { stop(); _session.clear_connection(this); }

   Role get_role() const { return _role; }

   ProcessModel get_pmodel() const { return _pmodel; }

   bool is_secure() const { return _secured; }

   F8API void start();

   F8API void stop();

   virtual bool connect() { return _connected; }

   bool is_connected() const { return _connected; }

   virtual bool write(Message *from, bool destroy=true) { return _writer.write(from, destroy); }

   virtual bool write(Message& from) { return _writer.write(from); }

   size_t write_batch(const std::vector<Message *>& msgs, bool destroy) { return _writer.write_batch(msgs, destroy); }

   int send(const char *from, size_t sz) { return _writer.send(from, sz); }

   int send(const f8String& from) { return _writer.send(from.data(), from.size()); }

   void set_hb_interval(const unsigned hb_interval)
      { _hb_interval = hb_interval; _hb_interval20pc = hb_interval + hb_interval / 5; }

   unsigned get_hb_interval() const { return _hb_interval; }

   unsigned get_hb_interval20pc() const { return _hb_interval20pc; }

   Poco::Net::SocketAddress get_peer_socket_address() const { return _sock->peerAddress(); }

   const Poco::Net::SocketAddress& get_socket_address() const { return _addr; }

   int join() { return _reader.join(); }

   bool is_socket_error() const { return _reader.is_socket_error(); }

   static void set_recv_buf_sz(const unsigned sz, Poco::Net::Socket *sock)
   {
      const unsigned current_sz(sock->getReceiveBufferSize());
      sock->setReceiveBufferSize(sz);
      glout_info << "fd(" << sock->impl()->sockfd() << ") ReceiveBufferSize old:" << current_sz
         << " requested:" << sz << " new:" << sock->getReceiveBufferSize();
   }

   static void set_send_buf_sz(const unsigned sz, Poco::Net::Socket *sock)
   {
      const unsigned current_sz(sock->getSendBufferSize());
      sock->setSendBufferSize(sz);
      glout_info << "fd(" << sock->impl()->sockfd() << ") SendBufferSize old:" << current_sz
         << " requested:" << sz << " new:" << sock->getSendBufferSize();
   }
   void set_recv_buf_sz(const unsigned sz) const { set_recv_buf_sz(sz, _sock); }

   void set_send_buf_sz(const unsigned sz) const { set_send_buf_sz(sz, _sock); }

   void set_tcp_cork_flag(bool way) const
   {
#if defined FIX8_HAVE_DECL_TCP_CORK && TCP_CORK != 0
      _sock->setOption(IPPROTO_TCP, TCP_CORK, way ? 1 : 0);
#endif
   }

   Session& get_session() { return _session; }

   int reader_execute() { return _reader.execute(_reader.cancellation_token()); }

   bool reader_poll(const Poco::Timespan &ts = Poco::Timespan()) const { return _reader.poll(ts); }

   int writer_execute() { return _writer.execute(_writer.cancellation_token()); }

   bool writer_poll(const Poco::Timespan &ts = Poco::Timespan()) const { return _writer.poll(ts); }
};

//-------------------------------------------------------------------------------------------------
class ClientConnection : public Connection
{
   const bool _no_delay;

public:
    ClientConnection(Poco::Net::StreamSocket *sock, Poco::Net::SocketAddress& addr,
                     Session &session, unsigned hb_interval, ProcessModel pmodel=pm_pipeline, bool no_delay=true,
                     bool secured=false)
       : Connection(sock, addr, session, cn_initiator, pmodel, hb_interval, secured), _no_delay(no_delay) {}

   virtual ~ClientConnection() {}

   F8API bool connect();
};

//-------------------------------------------------------------------------------------------------
class ServerConnection : public Connection
{
public:
   ServerConnection(Poco::Net::StreamSocket *sock, Poco::Net::SocketAddress& addr,
                    Session &session, unsigned hb_interval, ProcessModel pmodel=pm_pipeline, bool no_delay=true,
                    bool reuse_addr=false, int linger=-1, bool keepalive=false, bool secured=false) :
      Connection(sock, addr, session, cn_acceptor, pmodel, hb_interval, secured)
   {
      _sock->setLinger(linger >= 0, linger);
      _sock->setNoDelay(no_delay);
      _sock->setReuseAddress(reuse_addr);
      _sock->setKeepAlive(keepalive);
   }

   virtual ~ServerConnection() {}
};

//-------------------------------------------------------------------------------------------------
// our buffered RAII ostream log target for Connection session member
#define scout ssout_info((&_session))
#define scout_info ssout_info((&_session))
#define scout_warn ssout_warn((&_session))
#define scout_error ssout_error((&_session))
#define scout_fatal ssout_fatal((&_session))
#define scout_debug ssout_debug((&_session))

//-------------------------------------------------------------------------------------------------

} // FIX8

#endif // FIX8_CONNECTION_HPP_