OLD | NEW |
---|---|
1 /* Copyright (c) 2012 The Chromium Authors. All rights reserved. | 1 /* Copyright (c) 2012 The Chromium Authors. All rights reserved. |
2 * Use of this source code is governed by a BSD-style license that can be | 2 * Use of this source code is governed by a BSD-style license that can be |
3 * found in the LICENSE file. | 3 * found in the LICENSE file. |
4 */ | 4 */ |
5 | 5 |
6 /** | 6 /** |
7 * This file defines the <code>PPB_NetworkList_Private</code> interface. | 7 * This file defines the <code>PPB_NetworkList_Private</code> interface. |
8 */ | 8 */ |
9 | 9 |
10 [generate_thunk] | 10 [generate_thunk] |
11 | 11 |
12 label Chrome { | 12 label Chrome { |
13 M19 = 0.2 | 13 M31 = 0.3 |
14 }; | 14 }; |
15 | 15 |
16 /** | 16 /** |
17 * Type of a network interface. | 17 * Type of a network interface. |
18 */ | 18 */ |
19 [assert_size(4)] | 19 [assert_size(4)] |
20 enum PP_NetworkListType_Private { | 20 enum PP_NetworkListType_Private { |
21 /** | 21 /** |
22 * Type of the network interface is not known. | 22 * Type of the network interface is not known. |
23 */ | 23 */ |
(...skipping 45 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
69 * | 69 * |
70 * @param[in] resource A <code>PP_Resource</code> resource. | 70 * @param[in] resource A <code>PP_Resource</code> resource. |
71 * | 71 * |
72 * @return Returns <code>PP_TRUE</code> if <code>resource</code> is | 72 * @return Returns <code>PP_TRUE</code> if <code>resource</code> is |
73 * a <code>PPB_NetworkList_Private</code>, <code>PP_FALSE</code> | 73 * a <code>PPB_NetworkList_Private</code>, <code>PP_FALSE</code> |
74 * otherwise. | 74 * otherwise. |
75 */ | 75 */ |
76 PP_Bool IsNetworkList([in] PP_Resource resource); | 76 PP_Bool IsNetworkList([in] PP_Resource resource); |
77 | 77 |
78 /** | 78 /** |
79 * Gets number of interfaces in the list. | |
80 * | |
yzshen1
2013/09/04 17:40:26
nit: to be consistent, please consider adding a pa
Sergey Ulanov
2013/09/04 18:43:08
Done.
| |
79 * @return Returns number of available network interfaces or 0 if | 81 * @return Returns number of available network interfaces or 0 if |
80 * the list has never been updated. | 82 * the list has never been updated. |
81 */ | 83 */ |
82 uint32_t GetCount([in] PP_Resource resource); | 84 uint32_t GetCount([in] PP_Resource resource); |
83 | 85 |
84 /** | 86 /** |
87 * Gets name of a network interface. | |
88 * | |
89 * @param[in] resource A <code>PP_Resource</code> corresponding to a | |
90 * network list. | |
91 * @param[in] index Index of the network interface. | |
92 * | |
85 * @return Returns name for the network interface with the specified | 93 * @return Returns name for the network interface with the specified |
86 * <code>index</code>. | 94 * <code>index</code>. |
87 */ | 95 */ |
88 PP_Var GetName([in] PP_Resource resource, | 96 PP_Var GetName([in] PP_Resource resource, |
89 [in] uint32_t index); | 97 [in] uint32_t index); |
90 | 98 |
91 /** | 99 /** |
100 * Gets type of a network interface. | |
101 * | |
102 * @param[in] resource A <code>PP_Resource</code> corresponding to a | |
103 * network list. | |
104 * @param[in] index Index of the network interface. | |
105 * | |
92 * @return Returns type of the network interface with the specified | 106 * @return Returns type of the network interface with the specified |
93 * <code>index</code>. | 107 * <code>index</code>. |
94 */ | 108 */ |
95 [on_failure=PP_NETWORKLIST_UNKNOWN] | 109 [on_failure=PP_NETWORKLIST_UNKNOWN] |
96 PP_NetworkListType_Private GetType([in] PP_Resource resource, | 110 PP_NetworkListType_Private GetType([in] PP_Resource resource, |
97 [in] uint32_t index); | 111 [in] uint32_t index); |
98 | 112 |
99 /** | 113 /** |
114 * Gets state of a network interface. | |
115 * | |
116 * @param[in] resource A <code>PP_Resource</code> corresponding to a | |
117 * network list. | |
118 * @param[in] index Index of the network interface. | |
119 * | |
100 * @return Returns current state of the network interface with the | 120 * @return Returns current state of the network interface with the |
101 * specified <code>index</code>. | 121 * specified <code>index</code>. |
102 */ | 122 */ |
103 [on_failure=PP_NETWORKLIST_DOWN] | 123 [on_failure=PP_NETWORKLIST_DOWN] |
104 PP_NetworkListState_Private GetState([in] PP_Resource resource, | 124 PP_NetworkListState_Private GetState([in] PP_Resource resource, |
105 [in] uint32_t index); | 125 [in] uint32_t index); |
106 | 126 |
107 /** | 127 /** |
108 * Gets list of IP addresses for the network interface with the | 128 * Gets list of IP addresses for a network interface. |
109 * specified <code>index</code> and stores them in | |
110 * <code>addresses</code>. If the caller didn't allocate sufficient | |
111 * space to store all addresses, then only the first | |
112 * <code>count</code> addresses are filled in. | |
113 * | 129 * |
114 * @return Returns total number of IP addresses assigned to the | 130 * @param[in] resource A <code>PP_Resource</code> corresponding to a |
115 * network interface or a negative error code. | 131 * network list. |
132 * @param[in] index Index of the network interface. | |
133 * @param[in] output An output array which will receive | |
134 * <code>PPB_NetAddress</code> resources on success. Please note that the | |
135 * ref count of those resources has already been increased by 1 for the | |
136 * caller. | |
137 * | |
138 * @return An error code from <code>pp_errors.h</code>. | |
116 */ | 139 */ |
117 int32_t GetIpAddresses( | 140 int32_t GetIpAddresses([in] PP_Resource resource, |
118 [in] PP_Resource resource, | 141 [in] uint32_t index, |
119 [in] uint32_t index, | 142 [in] PP_ArrayOutput output); |
120 [inout, size_is(count)] PP_NetAddress_Private[] addresses, | |
121 [in] uint32_t count); | |
122 | 143 |
123 /** | 144 /** |
145 * Gets display name of a network interface. | |
146 * | |
147 * @param[in] resource A <code>PP_Resource</code> corresponding to a | |
148 * network list. | |
149 * @param[in] index Index of the network interface. | |
150 * | |
124 * @return Returns display name for the network interface with the | 151 * @return Returns display name for the network interface with the |
125 * specified <code>index</code>. | 152 * specified <code>index</code>. |
126 */ | 153 */ |
127 PP_Var GetDisplayName([in] PP_Resource resource, | 154 PP_Var GetDisplayName([in] PP_Resource resource, |
128 [in] uint32_t index); | 155 [in] uint32_t index); |
129 | 156 |
130 /** | 157 /** |
158 * Gets MTU (Maximum Transmission Unit) of a network interface. | |
159 * | |
160 * @param[in] resource A <code>PP_Resource</code> corresponding to a | |
161 * network list. | |
162 * @param[in] index Index of the network interface. | |
163 * | |
131 * @return Returns MTU for the network interface with the specified | 164 * @return Returns MTU for the network interface with the specified |
132 * <code>index</code> or 0 if MTU is unknown. | 165 * <code>index</code> or 0 if MTU is unknown. |
133 */ | 166 */ |
134 uint32_t GetMTU([in] PP_Resource resource, | 167 uint32_t GetMTU([in] PP_Resource resource, |
135 [in] uint32_t index); | 168 [in] uint32_t index); |
136 | 169 |
137 }; | 170 }; |
OLD | NEW |