summaryrefslogtreecommitdiff
path: root/src/lib/dcpomatic_socket.h
blob: 6f6f8ceceb1352bf1f73c6b42f6a8b093111d4c0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
/*
    Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>

    This file is part of DCP-o-matic.

    DCP-o-matic is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    DCP-o-matic 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.  See the
    GNU General Public License for more details.

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

*/

#include "digester.h"
#include <boost/asio.hpp>
#include <boost/noncopyable.hpp>
#include <boost/scoped_ptr.hpp>
#include <boost/weak_ptr.hpp>

/** @class Socket
 *  @brief A class to wrap a boost::asio::ip::tcp::socket with some things
 *  that are useful for DCP-o-matic.
 *
 *  This class wraps some things that I could not work out how to do easily with boost;
 *  most notably, sync read/write calls with timeouts.
 */
class Socket : public boost::noncopyable
{
public:
	explicit Socket (int timeout = 30);

	/** @return Our underlying socket */
	boost::asio::ip::tcp::socket& socket () {
		return _socket;
	}

	void connect (boost::asio::ip::tcp::endpoint);

	void write (uint32_t n);
	void write (uint8_t const * data, size_t size);

	void read (uint8_t* data, size_t size);
	uint32_t read_uint32 ();

	class ReadDigestScope
	{
	public:
		ReadDigestScope (boost::shared_ptr<Socket> socket);
		bool check ();
	private:
		boost::weak_ptr<Socket> _socket;
	};

	/** After one of these is created everything that is sent from the socket will be
	 *  added to a digest.  When the DigestScope is destroyed the digest will be sent
	 *  from the socket.
	 */
	class WriteDigestScope
	{
	public:
		WriteDigestScope (boost::shared_ptr<Socket> socket);
		~WriteDigestScope ();
	private:
		boost::weak_ptr<Socket> _socket;
	};

private:
	friend class DigestScope;

	void check ();
	void start_read_digest ();
	bool check_read_digest ();
	void start_write_digest ();
	void finish_write_digest ();

	Socket (Socket const &);

	boost::asio::io_service _io_service;
	boost::asio::deadline_timer _deadline;
	boost::asio::ip::tcp::socket _socket;
	int _timeout;
	boost::scoped_ptr<Digester> _read_digester;
	boost::scoped_ptr<Digester> _write_digester;
};