Endpoint.h
1 /*
2  * Copyright (C) 2013 Marc Duerner
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * As a special exception, you may use this file as part of a free
10  * software library without restriction. Specifically, if other files
11  * instantiate templates or use macros or inline functions from this
12  * file, or you compile this file and link it with other files to
13  * produce an executable, this file does not by itself cause the
14  * resulting executable to be covered by the GNU General Public
15  * License. This exception does not however invalidate any other
16  * reasons why the executable file might be covered by the GNU Library
17  * General Public License.
18  *
19  * This library is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22  * Lesser General Public License for more details.
23  *
24  * You should have received a copy of the GNU Lesser General Public
25  * License along with this library; if not, write to the Free Software
26  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
27  */
28 
29 #ifndef PT_NET_ENDPOINT_H
30 #define PT_NET_ENDPOINT_H
31 
32 #include <Pt/Net/Api.h>
33 #include <string>
34 
35 namespace Pt {
36 
37 namespace Net {
38 
39 class EndpointImpl;
40 
76 class PT_NET_API Endpoint
77 {
78  public:
82 
85  Endpoint(const std::string& host, unsigned short port);
86 
89  Endpoint(const char* host, unsigned short port);
90 
93  Endpoint(const Endpoint& src);
94 
98 
102 
105  void clear();
106 
109  std::string toString() const;
110 
113  static Endpoint ip4Any(unsigned short port);
114 
117  static Endpoint ip4Loopback(unsigned short port);
118 
121  static Endpoint ip4Broadcast(unsigned short port);
122 
125  static Endpoint ip6Any(unsigned short port);
126 
129  static Endpoint ip6Loopback(unsigned short port);
130 
132  explicit Endpoint(EndpointImpl* impl);
133 
135  EndpointImpl* impl()
136  { return _impl; }
137 
139  const EndpointImpl* impl() const
140  { return _impl; }
141 
142  private:
143  EndpointImpl* _impl;
144 };
145 
146 } // namespace Net
147 
148 } // namespace Pt
149 
150 #endif // PT_NET_ENDPOINT_H
Core module.
Definition: Allocator.h:33
std::string toString() const
Returns the endpoint as a string.
static Endpoint ip6Any(unsigned short port)
Creates the IPv6 any-address for port.
void clear()
Clears the endpoint.
Endpoint(const Endpoint &src)
Copies the endpoint.
Endpoint(const std::string &host, unsigned short port)
Creates an endpoint for host and port.
static Endpoint ip4Broadcast(unsigned short port)
Creates the IPv4 broadcast address for port.
Host and service address.
Definition: Endpoint.h:77
Endpoint & operator=(const Endpoint &src)
Assigns the endpoint.
Endpoint()
Creates an empty endpoint.
static Endpoint ip6Loopback(unsigned short port)
Creates the IPv6 loopback address for port.
Endpoint(const char *host, unsigned short port)
Creates an endpoint for host and port.
static Endpoint ip4Any(unsigned short port)
Creates the IPv4 any-address for port.
static Endpoint ip4Loopback(unsigned short port)
Creates the IPv4 loopback address for port.
~Endpoint()
Destroys the endpoint.