E-MailRelay
gconnection.h
Go to the documentation of this file.
1//
2// Copyright (C) 2001-2024 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
27namespace GNet
28{
29 class Connection ;
30}
31
32//| \class GNet::Connection
33/// An abstract interface which provides information about a network
34/// connection.
35/// \see GNet::Client, GNet::ServerPeer
36///
38{
39public:
40 virtual ~Connection() = default ;
41 ///< Destructor.
42
43 virtual Address localAddress() const = 0 ;
44 ///< Returns the connection's local address.
45
46 virtual Address peerAddress() const = 0 ;
47 ///< Returns the connection's peer address.
48 ///< Throws if a client connection that has not yet connected.
49
50 virtual std::string connectionState() const = 0 ;
51 ///< Returns the connection state as a display string.
52 ///< This should be the peerAddress() display string, unless
53 ///< a client connection that has not yet connected.
54
55 virtual std::string peerCertificate() const = 0 ;
56 ///< Returns the peer's TLS certificate. Returns the
57 ///< empty string if none.
58} ;
59
60#endif
The GNet::Address class encapsulates a TCP/UDP transport address.
Definition: gaddress.h:63
An abstract interface which provides information about a network connection.
Definition: gconnection.h:38
virtual ~Connection()=default
Destructor.
virtual Address peerAddress() const =0
Returns the connection's peer address.
virtual Address localAddress() const =0
Returns the connection's local address.
virtual std::string connectionState() const =0
Returns the connection state as a display string.
virtual std::string peerCertificate() const =0
Returns the peer's TLS certificate.
Network classes.
Definition: gdef.h:1243