2 Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
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.
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.
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/>.
22 #include <boost/asio.hpp>
23 #include <boost/noncopyable.hpp>
24 #include <boost/scoped_ptr.hpp>
25 #include <boost/weak_ptr.hpp>
28 * @brief A class to wrap a boost::asio::ip::tcp::socket with some things
29 * that are useful for DCP-o-matic.
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.
34 class Socket : public boost::noncopyable
37 explicit Socket (int timeout = 30);
39 /** @return Our underlying socket */
40 boost::asio::ip::tcp::socket& socket () {
44 void connect (boost::asio::ip::tcp::endpoint);
46 void write (uint32_t n);
47 void write (uint8_t const * data, int size);
49 void read (uint8_t* data, int size);
50 uint32_t read_uint32 ();
55 ReadDigestScope (boost::shared_ptr<Socket> socket);
58 boost::weak_ptr<Socket> _socket;
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
65 class WriteDigestScope
68 WriteDigestScope (boost::shared_ptr<Socket> socket);
71 boost::weak_ptr<Socket> _socket;
75 friend class DigestScope;
78 void start_read_digest ();
79 bool check_read_digest ();
80 void start_write_digest ();
81 void finish_write_digest ();
83 Socket (Socket const &);
85 boost::asio::io_service _io_service;
86 boost::asio::deadline_timer _deadline;
87 boost::asio::ip::tcp::socket _socket;
89 boost::scoped_ptr<Digester> _read_digester;
90 boost::scoped_ptr<Digester> _write_digester;