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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
|
/* Copyright 2013 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.
*/
/**
* This file defines the <code>PPB_TCPSocket</code> interface.
*/
label Chrome {
M29 = 1.0,
M31 = 1.1
};
/**
* Option names used by <code>SetOption()</code>.
*/
[assert_size(4)]
enum PP_TCPSocket_Option {
/**
* Disables coalescing of small writes to make TCP segments, and instead
* delivers data immediately. Value's type is <code>PP_VARTYPE_BOOL</code>.
* This option can only be set after a successful <code>Connect()</code> call.
*/
PP_TCPSOCKET_OPTION_NO_DELAY = 0,
/**
* Specifies the total per-socket buffer space reserved for sends. Value's
* type should be <code>PP_VARTYPE_INT32</code>.
* This option can only be set after a successful <code>Connect()</code> call.
*
* Note: This is only treated as a hint for the browser to set the buffer
* size. Even if <code>SetOption()</code> succeeds, the browser doesn't
* guarantee it will conform to the size.
*/
PP_TCPSOCKET_OPTION_SEND_BUFFER_SIZE = 1,
/**
* Specifies the total per-socket buffer space reserved for receives. Value's
* type should be <code>PP_VARTYPE_INT32</code>.
* This option can only be set after a successful <code>Connect()</code> call.
*
* Note: This is only treated as a hint for the browser to set the buffer
* size. Even if <code>SetOption()</code> succeeds, the browser doesn't
* guarantee it will conform to the size.
*/
PP_TCPSOCKET_OPTION_RECV_BUFFER_SIZE = 2
};
/**
* The <code>PPB_TCPSocket</code> interface provides TCP socket operations.
*
* Permissions: Apps permission <code>socket</code> with subrule
* <code>tcp-connect</code> is required for <code>Connect()</code>; subrule
* <code>tcp-listen</code> is required for <code>Listen()</code>.
* For more details about network communication permissions, please see:
* http://developer.chrome.com/apps/app_network.html
*/
interface PPB_TCPSocket {
/**
* Creates a TCP socket resource.
*
* @param[in] instance A <code>PP_Instance</code> identifying one instance of
* a module.
*
* @return A <code>PP_Resource</code> corresponding to a TCP socket or 0
* on failure.
*/
PP_Resource Create([in] PP_Instance instance);
/**
* Determines if a given resource is a TCP socket.
*
* @param[in] resource A <code>PP_Resource</code> to check.
*
* @return <code>PP_TRUE</code> if the input is a
* <code>PPB_TCPSocket</code> resource; <code>PP_FALSE</code> otherwise.
*/
PP_Bool IsTCPSocket([in] PP_Resource resource);
/**
* Binds the socket to the given address. The socket must not be bound.
*
* @param[in] tcp_socket A <code>PP_Resource</code> corresponding to a TCP
* socket.
* @param[in] addr A <code>PPB_NetAddress</code> resource.
* @param[in] callback A <code>PP_CompletionCallback</code> to be called upon
* completion.
*
* @return An int32_t containing an error code from <code>pp_errors.h</code>,
* including (but not limited to):
* - <code>PP_ERROR_ADDRESS_IN_USE</code>: the address is already in use.
* - <code>PP_ERROR_ADDRESS_INVALID</code>: the address is invalid.
*/
[version=1.1]
int32_t Bind([in] PP_Resource tcp_socket,
[in] PP_Resource addr,
[in] PP_CompletionCallback callback);
/**
* Connects the socket to the given address. The socket must not be listening.
* Binding the socket beforehand is optional.
*
* @param[in] tcp_socket A <code>PP_Resource</code> corresponding to a TCP
* socket.
* @param[in] addr A <code>PPB_NetAddress</code> resource.
* @param[in] callback A <code>PP_CompletionCallback</code> to be called upon
* completion.
*
* @return An int32_t containing an error code from <code>pp_errors.h</code>,
* including (but not limited to):
* - <code>PP_ERROR_NOACCESS</code>: the caller doesn't have required
* permissions.
* - <code>PP_ERROR_ADDRESS_UNREACHABLE</code>: <code>addr</code> is
* unreachable.
* - <code>PP_ERROR_CONNECTION_REFUSED</code>: the connection attempt was
* refused.
* - <code>PP_ERROR_CONNECTION_FAILED</code>: the connection attempt failed.
* - <code>PP_ERROR_CONNECTION_TIMEDOUT</code>: the connection attempt timed
* out.
*
* Since version 1.1, if the socket is listening/connected or has a pending
* listen/connect request, <code>Connect()</code> will fail without starting a
* connection attempt; otherwise, any failure during the connection attempt
* will cause the socket to be closed.
*/
int32_t Connect([in] PP_Resource tcp_socket,
[in] PP_Resource addr,
[in] PP_CompletionCallback callback);
/**
* Gets the local address of the socket, if it is bound.
*
* @param[in] tcp_socket A <code>PP_Resource</code> corresponding to a TCP
* socket.
*
* @return A <code>PPB_NetAddress</code> resource on success or 0 on failure.
*/
PP_Resource GetLocalAddress([in] PP_Resource tcp_socket);
/**
* Gets the remote address of the socket, if it is connected.
*
* @param[in] tcp_socket A <code>PP_Resource</code> corresponding to a TCP
* socket.
*
* @return A <code>PPB_NetAddress</code> resource on success or 0 on failure.
*/
PP_Resource GetRemoteAddress([in] PP_Resource tcp_socket);
/**
* Reads data from the socket. The socket must be connected. It may perform a
* partial read.
*
* @param[in] tcp_socket A <code>PP_Resource</code> corresponding to a TCP
* socket.
* @param[out] buffer The buffer to store the received data on success. It
* must be at least as large as <code>bytes_to_read</code>.
* @param[in] bytes_to_read The number of bytes to read.
* @param[in] callback A <code>PP_CompletionCallback</code> to be called upon
* completion.
*
* @return A non-negative number on success to indicate how many bytes have
* been read, 0 means that end-of-file was reached; otherwise, an error code
* from <code>pp_errors.h</code>.
*/
int32_t Read([in] PP_Resource tcp_socket,
[out] str_t buffer,
[in] int32_t bytes_to_read,
[in] PP_CompletionCallback callback);
/**
* Writes data to the socket. The socket must be connected. It may perform a
* partial write.
*
* @param[in] tcp_socket A <code>PP_Resource</code> corresponding to a TCP
* socket.
* @param[in] buffer The buffer containing the data to write.
* @param[in] bytes_to_write The number of bytes to write.
* @param[in] callback A <code>PP_CompletionCallback</code> to be called upon
* completion.
*
* @return A non-negative number on success to indicate how many bytes have
* been written; otherwise, an error code from <code>pp_errors.h</code>.
*/
int32_t Write([in] PP_Resource tcp_socket,
[in] str_t buffer,
[in] int32_t bytes_to_write,
[in] PP_CompletionCallback callback);
/**
* Starts listening. The socket must be bound and not connected.
*
* @param[in] tcp_socket A <code>PP_Resource</code> corresponding to a TCP
* socket.
* @param[in] backlog A hint to determine the maximum length to which the
* queue of pending connections may grow.
* @param[in] callback A <code>PP_CompletionCallback</code> to be called upon
* completion.
*
* @return An int32_t containing an error code from <code>pp_errors.h</code>,
* including (but not limited to):
* - <code>PP_ERROR_NOACCESS</code>: the caller doesn't have required
* permissions.
* - <code>PP_ERROR_ADDRESS_IN_USE</code>: Another socket is already listening
* on the same port.
*/
[version=1.1]
int32_t Listen([in] PP_Resource tcp_socket,
[in] int32_t backlog,
[in] PP_CompletionCallback callback);
/**
* Accepts a connection. The socket must be listening.
*
* @param[in] tcp_socket A <code>PP_Resource</code> corresponding to a TCP
* socket.
* @param[out] accepted_tcp_socket Stores the accepted TCP socket on success.
* @param[in] callback A <code>PP_CompletionCallback</code> to be called upon
* completion.
*
* @return An int32_t containing an error code from <code>pp_errors.h</code>,
* including (but not limited to):
* - <code>PP_ERROR_CONNECTION_ABORTED</code>: A connection has been aborted.
*/
[version=1.1]
int32_t Accept([in] PP_Resource tcp_socket,
[out] PP_Resource accepted_tcp_socket,
[in] PP_CompletionCallback callback);
/**
* Cancels all pending operations and closes the socket. Any pending callbacks
* will still run, reporting <code>PP_ERROR_ABORTED</code> if pending IO was
* interrupted. After a call to this method, no output buffer pointers passed
* into previous <code>Read()</code> or <code>Accept()</code> calls will be
* accessed. It is not valid to call <code>Connect()</code> or
* <code>Listen()</code> again.
*
* The socket is implicitly closed if it is destroyed, so you are not required
* to call this method.
*
* @param[in] tcp_socket A <code>PP_Resource</code> corresponding to a TCP
* socket.
*/
void Close([in] PP_Resource tcp_socket);
/**
* Sets a socket option on the TCP socket.
* Please see the <code>PP_TCPSocket_Option</code> description for option
* names, value types and allowed values.
*
* @param[in] tcp_socket A <code>PP_Resource</code> corresponding to a TCP
* socket.
* @param[in] name The option to set.
* @param[in] value The option value to set.
* @param[in] callback A <code>PP_CompletionCallback</code> to be called upon
* completion.
*
* @return An int32_t containing an error code from <code>pp_errors.h</code>.
*/
int32_t SetOption([in] PP_Resource tcp_socket,
[in] PP_TCPSocket_Option name,
[in] PP_Var value,
[in] PP_CompletionCallback callback);
};
|
