blob: 4aa2722635b6471ad3b6450285d15b27cfbbd2a1 (
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
|
/*
* 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_LSOCKSTREAM_H
#define PSOCKSXX_LSOCKSTREAM_H
#include <psocksxx/iosockstream.h>
#include <psocksxx/lsockaddr.h>
namespace psocksxx {
/**
* @brief Local (unix) socket controller class
*
* This class acts as a controller for communicating through a
* local (unix) socket and uses an instance of psocksxx::sockstreambuf
* as the underlying / associated sequence.
*/
class lsockstream : public iosockstream {
public:
/**
* @brief constructor
* @throw psocksxx::sockexception socket exception
*
* Initialise a local (unix) communication stream.
*
*/
lsockstream() throw( sockexception );
/**
* @brief destructor
*/
virtual ~lsockstream() throw();
/**
* @brief connect to a local socket
* @param path local socket path
* @throw psocksxx::sockexception socket exception
* @throw psocksxx::socktimeoutexception connection timeout
* exception
*
* Connect a to local socket at the given path. It is assumed
* that the socket is ready to accept connections.
*
*/
void connect( const char * path ) throw( sockexception, socktimeoutexception );
/**
* @brief connect to a local socket
* @param saddr local socket address instance
* @throw psocksxx::sockexception socket exception
* @throw psocksxx::socktimeoutexception connection timeout
* exception
*
* Connect to a local socket using the passed in socket address
* object.
*
*/
void connect( const lsockaddr * saddr ) throw( sockexception, socktimeoutexception );
};
} /* end of namespace psocksxx */
#endif /* !PSOCKSXX_LSOCKSTREAM_H */
|
