• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  *
3  * Copyright 2015 gRPC authors.
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  *     http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  */
18 
19 #ifndef GRPC_CORE_LIB_IOMGR_SOCKADDR_UTILS_H
20 #define GRPC_CORE_LIB_IOMGR_SOCKADDR_UTILS_H
21 
22 #include <grpc/support/port_platform.h>
23 
24 #include <string>
25 
26 #include "src/core/lib/iomgr/resolve_address.h"
27 
28 /* Returns true if addr is an IPv4-mapped IPv6 address within the
29    ::ffff:0.0.0.0/96 range, or false otherwise.
30 
31    If addr4_out is non-NULL, the inner IPv4 address will be copied here when
32    returning true. */
33 int grpc_sockaddr_is_v4mapped(const grpc_resolved_address* addr,
34                               grpc_resolved_address* addr4_out);
35 
36 /* If addr is an AF_INET address, writes the corresponding ::ffff:0.0.0.0/96
37    address to addr6_out and returns true.  Otherwise returns false. */
38 int grpc_sockaddr_to_v4mapped(const grpc_resolved_address* addr,
39                               grpc_resolved_address* addr6_out);
40 
41 /* If addr is ::, 0.0.0.0, or ::ffff:0.0.0.0, writes the port number to
42  *port_out (if not NULL) and returns true, otherwise returns false. */
43 int grpc_sockaddr_is_wildcard(const grpc_resolved_address* addr, int* port_out);
44 
45 /* Writes 0.0.0.0:port and [::]:port to separate sockaddrs. */
46 void grpc_sockaddr_make_wildcards(int port, grpc_resolved_address* wild4_out,
47                                   grpc_resolved_address* wild6_out);
48 
49 /* Writes 0.0.0.0:port. */
50 void grpc_sockaddr_make_wildcard4(int port, grpc_resolved_address* wild_out);
51 
52 /* Writes [::]:port. */
53 void grpc_sockaddr_make_wildcard6(int port, grpc_resolved_address* wild_out);
54 
55 /* Return the IP port number of a sockaddr */
56 int grpc_sockaddr_get_port(const grpc_resolved_address* addr);
57 
58 /* Set IP port number of a sockaddr */
59 int grpc_sockaddr_set_port(grpc_resolved_address* addr, int port);
60 
61 // Converts a sockaddr into a newly-allocated human-readable string.
62 //
63 // Currently, only the AF_INET and AF_INET6 families are recognized.
64 // If the normalize flag is enabled, ::ffff:0.0.0.0/96 IPv6 addresses are
65 // displayed as plain IPv4.
66 std::string grpc_sockaddr_to_string(const grpc_resolved_address* addr,
67                                     bool normalize);
68 
69 void grpc_string_to_sockaddr(grpc_resolved_address* out, const char* addr,
70                              int port);
71 
72 /* Returns the URI string corresponding to \a addr */
73 std::string grpc_sockaddr_to_uri(const grpc_resolved_address* addr);
74 
75 /* Returns the URI scheme corresponding to \a addr */
76 const char* grpc_sockaddr_get_uri_scheme(const grpc_resolved_address* addr);
77 
78 int grpc_sockaddr_get_family(const grpc_resolved_address* resolved_addr);
79 
80 #endif /* GRPC_CORE_LIB_IOMGR_SOCKADDR_UTILS_H */
81