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
|
/* Copyright 2012 The Chromium Authors
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
/* From private/ppb_tcp_socket_private.idl modified Mon Jun 24 09:53:12 2013. */
#ifndef PPAPI_C_PRIVATE_PPB_TCP_SOCKET_PRIVATE_H_
#define PPAPI_C_PRIVATE_PPB_TCP_SOCKET_PRIVATE_H_
#include "ppapi/c/pp_bool.h"
#include "ppapi/c/pp_completion_callback.h"
#include "ppapi/c/pp_instance.h"
#include "ppapi/c/pp_macros.h"
#include "ppapi/c/pp_resource.h"
#include "ppapi/c/pp_stdint.h"
#include "ppapi/c/pp_var.h"
#include "ppapi/c/private/ppb_net_address_private.h"
#define PPB_TCPSOCKET_PRIVATE_INTERFACE_0_3 "PPB_TCPSocket_Private;0.3"
#define PPB_TCPSOCKET_PRIVATE_INTERFACE_0_4 "PPB_TCPSocket_Private;0.4"
#define PPB_TCPSOCKET_PRIVATE_INTERFACE_0_5 "PPB_TCPSocket_Private;0.5"
#define PPB_TCPSOCKET_PRIVATE_INTERFACE PPB_TCPSOCKET_PRIVATE_INTERFACE_0_5
/**
* @file
* This file defines the <code>PPB_TCPSocket_Private</code> interface.
*/
/**
* @addtogroup Enums
* @{
*/
typedef enum {
/* Special value used for testing. Guaranteed to fail SetOption(). */
PP_TCPSOCKETOPTION_PRIVATE_INVALID = 0,
/* Disable coalescing of small writes to make TCP segments, and instead
* deliver data immediately. For SSL sockets, this option must be set before
* SSLHandshake() is called. Value type is PP_VARTYPE_BOOL. */
PP_TCPSOCKETOPTION_PRIVATE_NO_DELAY = 1
} PP_TCPSocketOption_Private;
PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_TCPSocketOption_Private, 4);
/**
* @}
*/
/**
* @addtogroup Interfaces
* @{
*/
/**
* The <code>PPB_TCPSocket_Private</code> interface provides TCP socket
* operations.
*/
struct PPB_TCPSocket_Private_0_5 {
/**
* Allocates a TCP socket resource.
*/
PP_Resource (*Create)(PP_Instance instance);
/**
* Determines if a given resource is TCP socket.
*/
PP_Bool (*IsTCPSocket)(PP_Resource resource);
/**
* Connects to a TCP port given as a host-port pair.
* When a proxy server is used, |host| and |port| refer to the proxy server
* instead of the destination server.
*/
int32_t (*Connect)(PP_Resource tcp_socket,
const char* host,
uint16_t port,
struct PP_CompletionCallback callback);
/**
* Same as Connect(), but connecting to the address given by |addr|. A typical
* use-case would be for reconnections.
*/
int32_t (*ConnectWithNetAddress)(PP_Resource tcp_socket,
const struct PP_NetAddress_Private* addr,
struct PP_CompletionCallback callback);
/**
* Gets the local address of the socket, if it has been connected.
* Returns PP_TRUE on success.
*/
PP_Bool (*GetLocalAddress)(PP_Resource tcp_socket,
struct PP_NetAddress_Private* local_addr);
/**
* Gets the remote address of the socket, if it has been connected.
* Returns PP_TRUE on success.
*/
PP_Bool (*GetRemoteAddress)(PP_Resource tcp_socket,
struct PP_NetAddress_Private* remote_addr);
/**
* Does SSL handshake and moves to sending and receiving encrypted data. The
* socket must have been successfully connected. |server_name| will be
* compared with the name(s) in the server's certificate during the SSL
* handshake. |server_port| is only used to identify an SSL server in the SSL
* session cache.
* When a proxy server is used, |server_name| and |server_port| refer to the
* destination server.
* If the socket is not connected, or there are pending read/write requests,
* SSLHandshake() will fail without starting a handshake. Otherwise, any
* failure during the handshake process will cause the socket to be
* disconnected.
*/
int32_t (*SSLHandshake)(PP_Resource tcp_socket,
const char* server_name,
uint16_t server_port,
struct PP_CompletionCallback callback);
/**
* Returns the server's <code>PPB_X509Certificate_Private</code> for a socket
* connection if an SSL connection has been established using
* <code>SSLHandshake</code>. If no SSL connection has been established, a
* null resource is returned.
*/
PP_Resource (*GetServerCertificate)(PP_Resource tcp_socket);
/**
* NOTE: This function is not implemented and will return
* <code>PP_FALSE</code>.
* Adds a trusted/untrusted chain building certificate to be used for this
* connection. The <code>certificate</code> must be a
* <code>PPB_X509Certificate_Private<code>. <code>PP_TRUE</code> is returned
* upon success.
*/
PP_Bool (*AddChainBuildingCertificate)(PP_Resource tcp_socket,
PP_Resource certificate,
PP_Bool is_trusted);
/**
* Reads data from the socket. The size of |buffer| must be at least as large
* as |bytes_to_read|. May perform a partial read. Returns the number of bytes
* read or an error code. If the return value is 0, then it indicates that
* end-of-file was reached.
* This method won't return more than 1 megabyte, so if |bytes_to_read|
* exceeds 1 megabyte, it will always perform a partial read.
* Multiple outstanding read requests are not supported.
*/
int32_t (*Read)(PP_Resource tcp_socket,
char* buffer,
int32_t bytes_to_read,
struct PP_CompletionCallback callback);
/**
* Writes data to the socket. May perform a partial write. Returns the number
* of bytes written or an error code.
* This method won't write more than 1 megabyte, so if |bytes_to_write|
* exceeds 1 megabyte, it will always perform a partial write.
* Multiple outstanding write requests are not supported.
*/
int32_t (*Write)(PP_Resource tcp_socket,
const char* buffer,
int32_t bytes_to_write,
struct PP_CompletionCallback callback);
/**
* Cancels any IO that may be pending, and disconnects the socket. Any pending
* callbacks will still run, reporting PP_Error_Aborted if pending IO was
* interrupted. It is NOT valid to call Connect() again after a call to this
* method. Note: If the socket is destroyed when it is still connected, then
* it will be implicitly disconnected, so you are not required to call this
* method.
*/
void (*Disconnect)(PP_Resource tcp_socket);
/**
* Sets an option on |tcp_socket|. Supported |name| and |value| parameters
* are as described for PP_TCPSocketOption_Private. |callback| will be
* invoked with PP_OK if setting the option succeeds, or an error code
* otherwise. The socket must be connection before SetOption is called.
*/
int32_t (*SetOption)(PP_Resource tcp_socket,
PP_TCPSocketOption_Private name,
struct PP_Var value,
struct PP_CompletionCallback callback);
};
typedef struct PPB_TCPSocket_Private_0_5 PPB_TCPSocket_Private;
struct PPB_TCPSocket_Private_0_3 {
PP_Resource (*Create)(PP_Instance instance);
PP_Bool (*IsTCPSocket)(PP_Resource resource);
int32_t (*Connect)(PP_Resource tcp_socket,
const char* host,
uint16_t port,
struct PP_CompletionCallback callback);
int32_t (*ConnectWithNetAddress)(PP_Resource tcp_socket,
const struct PP_NetAddress_Private* addr,
struct PP_CompletionCallback callback);
PP_Bool (*GetLocalAddress)(PP_Resource tcp_socket,
struct PP_NetAddress_Private* local_addr);
PP_Bool (*GetRemoteAddress)(PP_Resource tcp_socket,
struct PP_NetAddress_Private* remote_addr);
int32_t (*SSLHandshake)(PP_Resource tcp_socket,
const char* server_name,
uint16_t server_port,
struct PP_CompletionCallback callback);
int32_t (*Read)(PP_Resource tcp_socket,
char* buffer,
int32_t bytes_to_read,
struct PP_CompletionCallback callback);
int32_t (*Write)(PP_Resource tcp_socket,
const char* buffer,
int32_t bytes_to_write,
struct PP_CompletionCallback callback);
void (*Disconnect)(PP_Resource tcp_socket);
};
struct PPB_TCPSocket_Private_0_4 {
PP_Resource (*Create)(PP_Instance instance);
PP_Bool (*IsTCPSocket)(PP_Resource resource);
int32_t (*Connect)(PP_Resource tcp_socket,
const char* host,
uint16_t port,
struct PP_CompletionCallback callback);
int32_t (*ConnectWithNetAddress)(PP_Resource tcp_socket,
const struct PP_NetAddress_Private* addr,
struct PP_CompletionCallback callback);
PP_Bool (*GetLocalAddress)(PP_Resource tcp_socket,
struct PP_NetAddress_Private* local_addr);
PP_Bool (*GetRemoteAddress)(PP_Resource tcp_socket,
struct PP_NetAddress_Private* remote_addr);
int32_t (*SSLHandshake)(PP_Resource tcp_socket,
const char* server_name,
uint16_t server_port,
struct PP_CompletionCallback callback);
PP_Resource (*GetServerCertificate)(PP_Resource tcp_socket);
PP_Bool (*AddChainBuildingCertificate)(PP_Resource tcp_socket,
PP_Resource certificate,
PP_Bool is_trusted);
int32_t (*Read)(PP_Resource tcp_socket,
char* buffer,
int32_t bytes_to_read,
struct PP_CompletionCallback callback);
int32_t (*Write)(PP_Resource tcp_socket,
const char* buffer,
int32_t bytes_to_write,
struct PP_CompletionCallback callback);
void (*Disconnect)(PP_Resource tcp_socket);
};
/**
* @}
*/
#endif /* PPAPI_C_PRIVATE_PPB_TCP_SOCKET_PRIVATE_H_ */
|
