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/scoped_ptr.hpp>
  24
  25 /** @class Socket
  26  *  @brief A class to wrap a boost::asio::ip::tcp::socket with some things
  27  *  that are useful for DCP-o-matic.
  28  *
  29  *  This class wraps some things that I could not work out how to do easily with boost;
  30  *  most notably, sync read/write calls with timeouts.
  31  */
  32 class Socket
  33 {
  34 public:
  35         explicit Socket (int timeout = 30);
  36
  37         Socket (Socket const&) = delete;
  38         Socket& operator= (Socket const&) = delete;
  39
  40         /** @return Our underlying socket */
  41         boost::asio::ip::tcp::socket& socket () {
  42                 return _socket;
  43         }
  44
  45         void connect (boost::asio::ip::tcp::endpoint);
  46
  47         void write (uint32_t n);
  48         void write (uint8_t const * data, int size);
  49
  50         void read (uint8_t* data, int size);
  51         uint32_t read_uint32 ();
  52
  53         class ReadDigestScope
  54         {
  55         public:
  56                 ReadDigestScope (std::shared_ptr<Socket> socket);
  57                 bool check ();
  58         private:
  59                 std::weak_ptr<Socket> _socket;
  60         };
  61
  62         /** After one of these is created everything that is sent from the socket will be
  63          *  added to a digest.  When the DigestScope is destroyed the digest will be sent
  64          *  from the socket.
  65          */
  66         class WriteDigestScope
  67         {
  68         public:
  69                 WriteDigestScope (std::shared_ptr<Socket> socket);
  70                 ~WriteDigestScope ();
  71         private:
  72                 std::weak_ptr<Socket> _socket;
  73         };
  74
  75 private:
  76         friend class DigestScope;
  77
  78         void check ();
  79         void start_read_digest ();
  80         bool check_read_digest ();
  81         void start_write_digest ();
  82         void finish_write_digest ();
  83
  84         boost::asio::io_service _io_service;
  85         boost::asio::deadline_timer _deadline;
  86         boost::asio::ip::tcp::socket _socket;
  87         int _timeout;
  88         boost::scoped_ptr<Digester> _read_digester;
  89         boost::scoped_ptr<Digester> _write_digester;
  90 };