E-MailRelay

- Main Page
- Namespaces
- Classes
- Files

- File List
- File Members

gconnection.h
Go to the documentation of this file.
1 //
2 // Copyright (C) 2001-2018 Graeme Walker <graeme_walker@users.sourceforge.net>
3 //
4 // This program is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // This program is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with this program. If not, see <http://www.gnu.org/licenses/>.
16 // ===
17 ///
18 /// \file gconnection.h
19 ///
20
21 #ifndef G_NET_CONNECTION__H
22 #define G_NET_CONNECTION__H
23
24 #include "gdef.h"
25 #include "gaddress.h"
26
27 namespace GNet
28 {
29 class Connection ;
30 }
31
32 /// \class GNet::Connection
33 /// An abstract interface which provides address information for a network
34 /// connection.
35 /// \see GNet::Client, GNet::ServerPeer
36 ///
37 class GNet::Connection
38 {
39 public:
40 virtual std::pair<bool,Address> localAddress() const = 0 ;
41 ///< Returns the connection's local address.
42 ///< Pair.first is false if none.
43
44 virtual std::pair<bool,Address> peerAddress() const = 0 ;
45 ///< Returns the connection's peer address.
46 ///< Pair.first is false if none.
47
48 virtual std::string connectionState() const = 0 ;
49 ///< Returns the connection state as a display string.
50 ///< This should normally return the peerAddress() string
51 ///< when the connection is fully established.
52
53 virtual std::string peerCertificate() const = 0 ;
54 ///< Returns the peer's TLS certificate. Returns the
55 ///< empty string if none.
56
57 virtual ~Connection() ;
58 ///< Destructor.
59
60 private:
61 void operator=( const Connection & ) ; // not implemented
62 } ;
63
64 #endif
GNet
Network classes.
Definition: gaddress.h:29
GNet::Connection::connectionState
virtual std::string connectionState() const =0
Returns the connection state as a display string.
GNet::Connection::peerAddress
virtual std::pair< bool, Address > peerAddress() const =0
Returns the connection's peer address.
GNet::Connection::peerCertificate
virtual std::string peerCertificate() const =0
Returns the peer's TLS certificate.
GNet::Connection
An abstract interface which provides address information for a network connection.
Definition: gconnection.h:37
GNet::Connection::~Connection
virtual ~Connection()
Destructor.
Definition: gconnection.cpp:24
gaddress.h
GNet::Connection::localAddress
virtual std::pair< bool, Address > localAddress() const =0
Returns the connection's local address.