src/lib/dcpomatic_socket.h

   1 /*
   2     Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 #include "digester.h"
  22 #include <boost/asio.hpp>
  23 #include <boost/noncopyable.hpp>
  24 #include <boost/scoped_ptr.hpp>
  25 #include <boost/weak_ptr.hpp>
  26
  27 /** @class Socket
  28  *  @brief A class to wrap a boost::asio::ip::tcp::socket with some things
  29  *  that are useful for DCP-o-matic.
  30  *
  31  *  This class wraps some things that I could not work out how to do easily with boost;
  32  *  most notably, sync read/write calls with timeouts.
  33  */
  34 class Socket : public boost::noncopyable
  35 {
  36 public:
  37         explicit Socket (int timeout = 30);
  38
  39         /** @return Our underlying socket */
  40         boost::asio::ip::tcp::socket& socket () {
  41                 return _socket;
  42         }
  43
  44         void connect (boost::asio::ip::tcp::endpoint);
  45
  46         void write (uint32_t n);
  47         void write (uint8_t const * data, int size);
  48
  49         void read (uint8_t* data, int size);
  50         uint32_t read_uint32 ();
  51
  52         class ReadDigestScope
  53         {
  54         public:
  55                 ReadDigestScope (boost::shared_ptr<Socket> socket);
  56                 bool check ();
  57         private:
  58                 boost::weak_ptr<Socket> _socket;
  59         };
  60
  61         /** After one of these is created everything that is sent from the socket will be
  62          *  added to a digest.  When the DigestScope is destroyed the digest will be sent
  63          *  from the socket.
  64          */
  65         class WriteDigestScope
  66         {
  67         public:
  68                 WriteDigestScope (boost::shared_ptr<Socket> socket);
  69                 ~WriteDigestScope ();
  70         private:
  71                 boost::weak_ptr<Socket> _socket;
  72         };
  73
  74 private:
  75         friend class DigestScope;
  76
  77         void check ();
  78         void start_read_digest ();
  79         bool check_read_digest ();
  80         void start_write_digest ();
  81         void finish_write_digest ();
  82
  83         Socket (Socket const &);
  84
  85         boost::asio::io_service _io_service;
  86         boost::asio::deadline_timer _deadline;
  87         boost::asio::ip::tcp::socket _socket;
  88         int _timeout;
  89         boost::scoped_ptr<Digester> _read_digester;
  90         boost::scoped_ptr<Digester> _write_digester;
  91 };