aboutsummaryrefslogtreecommitdiff
path: root/lib/libutil++/freebsd__addrinfo_up.3
blob: 4845a76bfb612345f8f64b596c57ef4bdb48b1e7 (plain) (blame)
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
.\"
.\" SPDX-License-Identifier: BSD-2-Clause
.\"
.\" Copyright (c) 2025 Chelsio Communications, Inc.
.\" Written by: John Baldwin <jhb@FreeBSD.org>
.\"
.Dd July 31, 2025
.Dt FREEBSD::ADDRINFO_UP 3
.Os
.Sh NAME
.Nm freebsd::addrinfo_up
.Nd std::unique_ptr specialization for lists of socket addresses
.Sh LIBRARY
.Lb libutil++
.Sh SYNOPSIS
.In libutil++.hh
.Ft using addrinfo_up = std::unique_ptr<addrinfo, freeaddrinfo_deleter>;
.Sh DESCRIPTION
This class is a specialization of
.Vt std::unique_ptr
for socket addresses returned by
.Xr getaddrinfo 3 .
When a list of socket addresses managed by an instance of this class is
disposed,
.Xr freeaddrinfo 3
is invoked to dispose of the list.
.Sh EXAMPLES
.Bd -literal -offset indent
freebsd::addrinfo_up
resolve_address(const char *address, const char *port)
{
	struct addrinfo hints, *ai;
	int error;

	memset(&hints, 0, sizeof(hints));
	hints.ai_family = AF_UNSPEC;
	hints.ai_socktype = SOCK_STREAM;
	error = getaddrinfo(address, port, &hints, &ai);
	if (error != 0)
		return {};
	return freebsd::addrinfo_up(ai);
}
.Ed
.Sh SEE ALSO
.Xr getaddrinfo 3