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
|
// Copyright (c) 2011 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef NET_BASE_ADDRESS_LIST_H_
#define NET_BASE_ADDRESS_LIST_H_
#pragma once
#include <string>
#include "base/memory/ref_counted.h"
#include "net/base/net_api.h"
#include "net/base/net_util.h"
struct addrinfo;
namespace net {
// An AddressList object contains a linked list of addrinfo structures. This
// class is designed to be copied around by value.
class NET_API AddressList {
public:
// Constructs an invalid address list. Should not call any methods on this
// other than assignment.
AddressList();
AddressList(const AddressList& addresslist);
~AddressList();
AddressList& operator=(const AddressList& addresslist);
// Creates an address list for a list of IP literals.
static AddressList CreateFromIPAddressList(
const IPAddressList& addresses,
uint16 port);
// Creates an address list for a single IP literal.
static AddressList CreateFromIPAddress(
const IPAddressNumber& address,
uint16 port);
// Creates an address list for a single IP literal. If
// |canonicalize_name| is true, fill the ai_canonname field with the
// canonicalized IP address.
static AddressList CreateFromIPAddressWithCname(
const IPAddressNumber& address,
uint16 port,
bool canonicalize_name);
// Adopts the given addrinfo list (assumed to have been created by
// the system, e.g. returned by getaddrinfo()) in place of the
// existing one if any. This hands over responsibility for freeing
// the addrinfo list to the AddressList object.
static AddressList CreateByAdoptingFromSystem(struct addrinfo* head);
// Creates a new address list with a copy of |head|. This includes the
// entire linked list.
static AddressList CreateByCopying(const struct addrinfo* head);
// Creates a new address list wich has a single address, |head|. If there
// are other addresses in |head| they will be ignored.
static AddressList CreateByCopyingFirstAddress(const struct addrinfo* head);
// Creates an address list for a single socket address.
// |address| the sockaddr to copy.
// |socket_type| is either SOCK_STREAM or SOCK_DGRAM.
// |protocol| is either IPPROTO_TCP or IPPROTO_UDP.
static AddressList CreateFromSockaddr(
const struct sockaddr* address,
socklen_t address_length,
int socket_type,
int protocol);
// Appends a copy of |head| and all its linked addrinfos to the stored
// addrinfo. Note that this will cause a reallocation of the linked list,
// which invalidates the head pointer.
void Append(const struct addrinfo* head);
// Sets the port of all addresses in the list to |port| (that is the
// sin[6]_port field for the sockaddrs). Note that this will cause a
// reallocation of the linked list, which invalidates the head pointer.
void SetPort(uint16 port);
// Retrieves the port number of the first sockaddr in the list. (If SetPort()
// was previously used on this list, then all the addresses will have this
// same port number.)
uint16 GetPort() const;
// Gets the canonical name for the address.
// If the canonical name exists, |*canonical_name| is filled in with the
// value and true is returned. If it does not exist, |*canonical_name| is
// not altered and false is returned.
// |canonical_name| must be a non-null value.
bool GetCanonicalName(std::string* canonical_name) const;
// Gets access to the head of the addrinfo list.
//
// IMPORTANT: Callers SHOULD NOT mutate the addrinfo chain, since under the
// hood this data might be shared by other AddressLists, which
// might even be running on other threads.
//
// Additionally, non-const methods like SetPort() and Append() can
// cause the head to be reallocated, so do not cache the return
// value of head() across such calls.
const struct addrinfo* head() const;
private:
struct Data;
explicit AddressList(Data* data);
scoped_refptr<Data> data_;
};
// Helper to create an AddressList that has a particular port. It has an
// optimization to avoid allocating a new address linked list when the
// port is already what we want.
AddressList CreateAddressListUsingPort(const AddressList& src, int port);
} // namespace net
#endif // NET_BASE_ADDRESS_LIST_H_
|
