#include <ppb_websocket.h>

Collaboration diagram for PPB_WebSocket_1_0:

Public Attributes
PP_Resource(*	Create )(PP_Instance instance)

PP_Bool(*	IsWebSocket )(PP_Resource resource)

int32_t(*	Connect )(PP_Resource web_socket, struct PP_Var url, const struct PP_Var protocols[], uint32_t protocol_count, struct PP_CompletionCallback callback)

int32_t(*	Close )(PP_Resource web_socket, uint16_t code, struct PP_Var reason, struct PP_CompletionCallback callback)

int32_t(*	ReceiveMessage )(PP_Resource web_socket, struct PP_Var *message, struct PP_CompletionCallback callback)

int32_t(*	SendMessage )(PP_Resource web_socket, struct PP_Var message)

uint64_t(*	GetBufferedAmount )(PP_Resource web_socket)

uint16_t(*	GetCloseCode )(PP_Resource web_socket)

struct PP_Var(*	GetCloseReason )(PP_Resource web_socket)

PP_Bool(*	GetCloseWasClean )(PP_Resource web_socket)

struct PP_Var(*	GetExtensions )(PP_Resource web_socket)

struct PP_Var(*	GetProtocol )(PP_Resource web_socket)

PP_WebSocketReadyState(*	GetReadyState )(PP_Resource web_socket)

struct PP_Var(*	GetURL )(PP_Resource web_socket)

Detailed Description

The PPB_WebSocket interface provides bi-directional, full-duplex, communications over a single TCP socket.

Definition at line 182 of file ppb_websocket.h.

Member Data Documentation

int32_t(* PPB_WebSocket_1_0::Close)(PP_Resource web_socket, uint16_t code, struct PP_Var reason, struct PP_CompletionCallback callback)

Close() closes the specified WebSocket connection by specifying code and reason.

Parameters

[in]	web_socket	A `PP_Resource` corresponding to a WebSocket.
[in]	code	The WebSocket close code. This is ignored if it is `PP_WEBSOCKETSTATUSCODE_NOT_SPECIFIED`. `PP_WEBSOCKETSTATUSCODE_NORMAL_CLOSURE` must be used for the usual case. To indicate some specific error cases, codes in the range `PP_WEBSOCKETSTATUSCODE_USER_REGISTERED_MIN` to `PP_WEBSOCKETSTATUSCODE_USER_REGISTERED_MAX`, and in the range `PP_WEBSOCKETSTATUSCODE_USER_PRIVATE_MIN` to `PP_WEBSOCKETSTATUSCODE_USER_PRIVATE_MAX` are available.
[in]	reason	A `PP_Var` representing the WebSocket close reason. This is ignored if it is `PP_VARTYPE_UNDEFINED`. Otherwise, its `PP_VarType` must be `PP_VARTYPE_STRING`.
[in]	callback	A `PP_CompletionCallback` called when the connection is closed or an error occurs in closing the connection.

Returns: An int32_t containing an error code from pp_errors.h. Returns PP_ERROR_BADARGUMENT if reason contains an invalid character as a UTF-8 string, or is longer than 123 bytes. PP_ERROR_BADARGUMENT corresponds to a JavaScript SyntaxError in the WebSocket API specification. Returns PP_ERROR_NOACCESS if the code is not an integer equal to 1000 or in the range 3000 to 4999. PP_ERROR_NOACCESS corresponds to an InvalidAccessError in the WebSocket API specification. Returns PP_ERROR_INPROGRESS if a previous call to Close() is not finished.

Definition at line 286 of file ppb_websocket.h.

int32_t(* PPB_WebSocket_1_0::Connect)(PP_Resource web_socket, struct PP_Var url, const struct PP_Var protocols[], uint32_t protocol_count, struct PP_CompletionCallback callback)

Connect() connects to the specified WebSocket server. You can call this function once for a web_socket.

Parameters

[in]	web_socket	A `PP_Resource` corresponding to a WebSocket.
[in]	url	A `PP_Var` representing a WebSocket server URL. The `PP_VarType` must be `PP_VARTYPE_STRING`.
[in]	protocols	A pointer to an array of `PP_Var` specifying sub-protocols. Each `PP_Var` represents one sub-protocol and its `PP_VarType` must be `PP_VARTYPE_STRING`. This argument can be null only if `protocol_count` is 0.
[in]	protocol_count	The number of sub-protocols in `protocols`.
[in]	callback	A `PP_CompletionCallback` called when a connection is established or an error occurs in establishing connection.

Returns: An int32_t containing an error code from pp_errors.h. Returns PP_ERROR_BADARGUMENT if the specified url, or protocols contain an invalid string as defined in the WebSocket API specification. PP_ERROR_BADARGUMENT corresponds to a SyntaxError in the WebSocket API specification. Returns PP_ERROR_NOACCESS if the protocol specified in the url is not a secure protocol, but the origin of the caller has a secure scheme. Also returns PP_ERROR_NOACCESS if the port specified in the url is a port that the user agent is configured to block access to because it is a well-known port like SMTP. PP_ERROR_NOACCESS corresponds to a SecurityError of the specification. Returns PP_ERROR_INPROGRESS if this is not the first call to Connect().

Definition at line 245 of file ppb_websocket.h.

PP_Resource(* PPB_WebSocket_1_0::Create)(PP_Instance instance)

Create() creates a WebSocket instance.

Parameters

[in] instance A PP_Instance identifying the instance with the WebSocket.

Returns: A PP_Resource corresponding to a WebSocket if successful.

Definition at line 192 of file ppb_websocket.h.

uint64_t(* PPB_WebSocket_1_0::GetBufferedAmount)(PP_Resource web_socket)

GetBufferedAmount() returns the number of bytes of text and binary messages that have been queued for the WebSocket connection to send, but have not been transmitted to the network yet.

Parameters