• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2015 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef ANDROID_MULTINETWORK_H
18 #define ANDROID_MULTINETWORK_H
19 
20 #include <netdb.h>
21 #include <stdlib.h>
22 #include <sys/cdefs.h>
23 
24 __BEGIN_DECLS
25 
26 /**
27  * The corresponding C type for android.net.Network#getNetworkHandle() return
28  * values.  The Java signed long value can be safely cast to a net_handle_t:
29  *
30  *     [C]    ((net_handle_t) java_long_network_handle)
31  *     [C++]  static_cast<net_handle_t>(java_long_network_handle)
32  *
33  * as appropriate.
34  */
35 typedef uint64_t net_handle_t;
36 
37 /**
38  * The value NETWORK_UNSPECIFIED indicates no specific network.
39  *
40  * For some functions (documented below), a previous binding may be cleared
41  * by an invocation with NETWORK_UNSPECIFIED.
42  *
43  * Depending on the context it may indicate an error.  It is expressly
44  * not used to indicate some notion of the "current default network".
45  */
46 #define NETWORK_UNSPECIFIED  ((net_handle_t)0)
47 
48 
49 /**
50  * All functions below that return an int return 0 on success or -1
51  * on failure with an appropriate errno value set.
52  */
53 
54 #if __ANDROID_API__ >= 24
55 
56 /**
57  * Set the network to be used by the given socket file descriptor.
58  *
59  * To clear a previous socket binding, invoke with NETWORK_UNSPECIFIED.
60  *
61  * This is the equivalent of: [android.net.Network#bindSocket()](https://developer.android.com/reference/android/net/Network.html#bindSocket(java.net.Socket))
62  *
63  */
64 int android_setsocknetwork(net_handle_t network, int fd);
65 
66 
67 /**
68  * Binds the current process to |network|.  All sockets created in the future
69  * (and not explicitly bound via android_setsocknetwork()) will be bound to
70  * |network|.  All host name resolutions will be limited to |network| as well.
71  * Note that if the network identified by |network| ever disconnects, all
72  * sockets created in this way will cease to work and all host name
73  * resolutions will fail.  This is by design so an application doesn't
74  * accidentally use sockets it thinks are still bound to a particular network.
75  *
76  * To clear a previous process binding, invoke with NETWORK_UNSPECIFIED.
77  *
78  * This is the equivalent of: [android.net.ConnectivityManager#setProcessDefaultNetwork()](https://developer.android.com/reference/android/net/ConnectivityManager.html#setProcessDefaultNetwork(android.net.Network))
79  *
80  */
81 int android_setprocnetwork(net_handle_t network);
82 
83 
84 /**
85  * Perform hostname resolution via the DNS servers associated with |network|.
86  *
87  * All arguments (apart from |network|) are used identically as those passed
88  * to getaddrinfo(3).  Return and error values are identical to those of
89  * getaddrinfo(3), and in particular gai_strerror(3) can be used as expected.
90  * Similar to getaddrinfo(3):
91  *     - |hints| may be NULL (in which case man page documented defaults apply)
92  *     - either |node| or |service| may be NULL, but not both
93  *     - |res| must not be NULL
94  *
95  * This is the equivalent of: [android.net.Network#getAllByName()](https://developer.android.com/reference/android/net/Network.html#getAllByName(java.lang.String))
96  *
97  */
98 int android_getaddrinfofornetwork(net_handle_t network,
99         const char *node, const char *service,
100         const struct addrinfo *hints, struct addrinfo **res);
101 
102 #endif /* __ANDROID_API__ >= 24 */
103 
104 __END_DECLS
105 
106 #endif  // ANDROID_MULTINETWORK_H
107