ppapi/api/private/ppb_network_list_private.idl - Issue 23450012: Make NetworkList and NetworkMonitor APIs public

Side by Side Diff: ppapi/api/private/ppb_network_list_private.idl

Issue 23450012: Make NetworkList and NetworkMonitor APIs public (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: Created 7 years, 3 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View unified diff | Download patch | Annotate | Revision Log

« ppapi/api/ppb_network_monitor.idl ('K') | « ppapi/api/ppb_network_monitor.idl ('k') | ppapi/api/private/ppb_network_monitor_private.idl » ('j') | ppapi/api/private/ppb_network_monitor_private.idl » ('J')
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

OLD	NEW
	(Empty)
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

3 * found in the LICENSE file.

4 */

5

6 /**

7 * This file defines the <code>PPB_NetworkList_Private</code> interface.

8 */

9

10 [generate_thunk]

11

12 label Chrome {

13 M19 = 0.2

14 };

15

16 /**

17 * Type of a network interface.

18 */

19 [assert_size(4)]

20 enum PP_NetworkListType_Private {

21 /**

22 * Type of the network interface is not known.

23 */

24 PP_NETWORKLIST_UNKNOWN = 0,

25

26 /**

27 * Wired Ethernet network.

28 */

29 PP_NETWORKLIST_ETHERNET = 1,

30

31 /**

32 * Wireless Wi-Fi network.

33 */

34 PP_NETWORKLIST_WIFI = 2,

35

36 /**

37 * Cellular network (e.g. LTE).

38 */

39 PP_NETWORKLIST_CELLULAR = 3

40 };

41

42 /**

43 * State of a network interface.

44 */

45 [assert_size(4)]

46 enum PP_NetworkListState_Private {

47 /**

48 * Network interface is down.

49 */

50 PP_NETWORKLIST_DOWN = 0,

51

52 /**

53 * Network interface is up.

54 */

55 PP_NETWORKLIST_UP = 1

56 };

57

58 /**

59 * The <code>PPB_NetworkList_Private</code> is used to represent a

60 * list of network interfaces and their configuration. The content of

61 * the list is immutable. The current networks configuration can be

62 * received using the <code>PPB_NetworkMonitor_Private</code>

63 * interface.

64 */

65 interface PPB_NetworkList_Private {

66 /**

67 * Determines if the specified <code>resource</code> is a

68 * <code>NetworkList</code> object.

69 *

70 * @param[in] resource A <code>PP_Resource</code> resource.

71 *

72 * @return Returns <code>PP_TRUE</code> if <code>resource</code> is

73 * a <code>PPB_NetworkList_Private</code>, <code>PP_FALSE</code>

74 * otherwise.

75 */

76 PP_Bool IsNetworkList([in] PP_Resource resource);

77

78 /**

79 * @return Returns number of available network interfaces or 0 if

80 * the list has never been updated.

81 */

82 uint32_t GetCount([in] PP_Resource resource);

83

84 /**

85 * @return Returns name for the network interface with the specified

86 * <code>index</code>.

87 */

88 PP_Var GetName([in] PP_Resource resource,

89 [in] uint32_t index);

90

91 /**

92 * @return Returns type of the network interface with the specified

93 * <code>index</code>.

94 */

95 [on_failure=PP_NETWORKLIST_UNKNOWN]

96 PP_NetworkListType_Private GetType([in] PP_Resource resource,

97 [in] uint32_t index);

98

99 /**

100 * @return Returns current state of the network interface with the

101 * specified <code>index</code>.

102 */

103 [on_failure=PP_NETWORKLIST_DOWN]

104 PP_NetworkListState_Private GetState([in] PP_Resource resource,

105 [in] uint32_t index);

106

107 /**

108 * Gets list of IP addresses for the network interface with the

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 *

114 * @return Returns total number of IP addresses assigned to the

115 * network interface or a negative error code.

116 */

117 int32_t GetIpAddresses(

118 [in] PP_Resource resource,

119 [in] uint32_t index,

120 [inout, size_is(count)] PP_NetAddress_Private[] addresses,

121 [in] uint32_t count);

122

123 /**

124 * @return Returns display name for the network interface with the

125 * specified <code>index</code>.

126 */

127 PP_Var GetDisplayName([in] PP_Resource resource,

128 [in] uint32_t index);

129

130 /**

131 * @return Returns MTU for the network interface with the specified

132 * <code>index</code> or 0 if MTU is unknown.

133 */

134 uint32_t GetMTU([in] PP_Resource resource,

135 [in] uint32_t index);

136

137 };

OLD	NEW