blob: 293a288fd13d43a4b4a1067826c9bf8747287e86 (
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
92
93
94
95
96
97
98
99
|
/*
* 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_IOSOCKS_H
#define PSOCKSXX_IOSOCKS_H
#include <psocksxx/sockstreambuf.h>
#include <ios>
namespace psocksxx {
/**
* @brief base class for socket stream controller classes
*
* This class holds the common methods for socket stream controller
* classes.
*/
class iosocks : public virtual std::ios {
public:
/**
* @brief destructor
*
* Does nothing.
*
*/
virtual ~iosocks() throw() { };
/**
* @brief get the timed-out status flag value
* @return boolean @c true if timed-out flag is set or @c false
* otherwise.
*
* Returns the timed-out status for the associated socket stream
* buffer.
*
*/
bool timedout() const throw();
/**
* @brief set the timeout value for stream communications
* @param sec seconds
* @param usec microseconds
* @return a reference to the internal timeout structure
*
* Wrapper method for sockstreambuf::timeout() to set the
* timeout value for stream communications.
*
* @see sockstreambuf::timeout()
*
*/
const timeval * timeout( time_t sec, suseconds_t usec ) throw();
/**
* @brief clear the timeout value
* @return a reference to the internal timeout structure which will
* always be a null-pointer (@c 0) after clearing the timeout
*
* This will clear any timeout values set for this stream using
* timeout().
*
*/
void * clear_timeout() throw();
protected:
/**
* @brief empty default constructor
*
* Empty default constructor so that derived classes through virtual
* inheritance does not have to call the constructor.
*
*/
iosocks() throw() { }
};
} /* end of namespace psocksxx */
#endif /* !PSOCKSXX_IOSOCKS_H */
|
