summaryrefslogtreecommitdiff
path: root/lib/psocksxx/iosockstream.h
blob: 2b2b0bbace16343c1d96f69cd2349f81c7c3408b (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
/*
*  psocksxx - A C++ wrapper for POSIX sockets
*  Copyright (C) 2013 Uditha Atukorala
*
*  This software library 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.
*
*  This software library 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 Lesser General Public License for more details.
*
*  You should have received a copy of the GNU Lesser General Public License
*  along with this software library. If not, see <http://www.gnu.org/licenses/>.
*
*/

#ifndef PSOCKSXX_IOSOCKSTREAM_H
#define PSOCKSXX_IOSOCKSTREAM_H

#include <psocksxx/isockstream.h>
#include <psocksxx/osockstream.h>


namespace psocksxx {

	/**
	*   @brief Input and Output controller class for socket streams
	*
	*   This merges the two input and output controller
	*   classes to create a single interface for controlling
	*   both input and output socket streams.
	*
	*/
	class iosockstream :
		public isockstream,
		public osockstream {

	public:

		/**
		*   @brief constructor
		*   @param ssb socket stream buffer
		*
		*   This constructor simply initialises the parent
		*   classes with the passed in socket stream buffer
		*/
		iosockstream( sockstreambuf * ssb ) throw() :
			isockstream( ssb ), osockstream( ssb ) {
			// constructor
		}

		/**
		*   @brief destructor
		*/
		virtual ~iosockstream() throw() {
			// destructor
		}

		/**
		*   @brief get the timed-out status for this stream
		*   @return boolean @c true if timed-out flag is set or @c false
		*           otherwise.
		*
		*   Returns the timed-out status.
		*
		*/
		bool timedout() const throw() {
			return ( isockstream::timedout() || osockstream::timedout() );
		}

	};

} /* end of namespace psocksxx */

#endif /* !PSOCKSXX_IOSOCKSTREAM_H */