summaryrefslogtreecommitdiff
path: root/src/net/AllocatedSocketAddress.hxx
blob: f662f89ad48f08e16901c6bc23bf072f69448d8b (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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
/*
 * Copyright 2012-2019 Max Kellermann <max.kellermann@gmail.com>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the
 * distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
 * FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef ALLOCATED_SOCKET_ADDRESS_HXX
#define ALLOCATED_SOCKET_ADDRESS_HXX

#include "SocketAddress.hxx"
#include "Features.hxx"
#include "util/Compiler.h"

#include <algorithm>

#include <stdlib.h>

struct sockaddr;

class AllocatedSocketAddress {
public:
	typedef SocketAddress::size_type size_type;

private:
	struct sockaddr *address = nullptr;
	size_type size = 0;

	AllocatedSocketAddress(struct sockaddr *_address,
			       size_type _size)
		:address(_address), size(_size) {}

public:
	AllocatedSocketAddress() = default;

	explicit AllocatedSocketAddress(SocketAddress src) noexcept {
		*this = src;
	}

	AllocatedSocketAddress(const AllocatedSocketAddress &src) noexcept
		:AllocatedSocketAddress((SocketAddress)src) {}

	AllocatedSocketAddress(AllocatedSocketAddress &&src) noexcept
		:address(src.address), size(src.size) {
		src.address = nullptr;
		src.size = 0;
	}

	~AllocatedSocketAddress() {
		free(address);
	}

	AllocatedSocketAddress &operator=(SocketAddress src) noexcept;

	AllocatedSocketAddress &operator=(const AllocatedSocketAddress &src) noexcept {
		return *this = (SocketAddress)src;
	}

	AllocatedSocketAddress &operator=(AllocatedSocketAddress &&src) noexcept {
		std::swap(address, src.address);
		std::swap(size, src.size);
		return *this;
	}

	template<typename T>
	gcc_pure
	bool operator==(T &&other) const noexcept {
		return (SocketAddress)*this == std::forward<T>(other);
	}

	template<typename T>
	gcc_pure
	bool operator!=(T &&other) const noexcept {
		return !(*this == std::forward<T>(other));
	}

	gcc_const
	static AllocatedSocketAddress Null() noexcept {
		return AllocatedSocketAddress(nullptr, 0);
	}

	bool IsNull() const noexcept {
		return address == nullptr;
	}

	size_type GetSize() const noexcept {
		return size;
	}

	const struct sockaddr *GetAddress() const noexcept {
		return address;
	}

	operator SocketAddress() const noexcept {
		return SocketAddress(address, size);
	}

	operator const struct sockaddr *() const noexcept {
		return address;
	}

	int GetFamily() const noexcept {
		return address->sa_family;
	}

	/**
	 * Does the object have a well-defined address?  Check !IsNull()
	 * before calling this method.
	 */
	bool IsDefined() const noexcept {
		return GetFamily() != AF_UNSPEC;
	}

	void Clear() noexcept {
		free(address);
		address = nullptr;
		size = 0;
	}

#ifdef HAVE_UN
	/**
	 * @see SocketAddress::GetLocalRaw()
	 */
	gcc_pure
	StringView GetLocalRaw() const noexcept;

	/**
	 * @see SocketAddress::GetLocalPath()
	 */
	gcc_pure
	const char *GetLocalPath() const noexcept {
		return ((SocketAddress)*this).GetLocalPath();
	}

	/**
	 * Make this a "local" address (UNIX domain socket).  If the path
	 * begins with a '@', then the rest specifies an "abstract" local
	 * address.
	 */
	void SetLocal(const char *path) noexcept;
#endif

#ifdef HAVE_TCP
	bool IsV6Any() const noexcept {
		return ((SocketAddress)*this).IsV6Any();
	}

	bool IsV4Mapped() const noexcept {
		return ((SocketAddress)*this).IsV4Mapped();
	}

	/**
	 * Extract the port number.  Returns 0 if not applicable.
	 */
	gcc_pure
	unsigned GetPort() const noexcept {
		return ((SocketAddress)*this).GetPort();
	}

	/**
	 * @return true on success, false if this address cannot have
	 * a port number
	 */
	bool SetPort(unsigned port) noexcept;

	static AllocatedSocketAddress WithPort(SocketAddress src,
					       unsigned port) noexcept {
		AllocatedSocketAddress result(src);
		result.SetPort(port);
		return result;
	}

	AllocatedSocketAddress WithPort(unsigned port) const noexcept {
		return WithPort(*this, port);
	}
#endif

private:
	void SetSize(size_type new_size) noexcept;
};

#endif