#include <ppb_tcp_socket_private.h>

Public Attributes
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)

int32_t(*	SetOption )(PP_Resource tcp_socket, PP_TCPSocketOption_Private name, struct PP_Var value, struct PP_CompletionCallback callback)

Detailed Description

The PPB_TCPSocket_Private interface provides TCP socket operations.

Member Data Documentation

PP_Bool(* PPB_TCPSocket_Private_0_5::AddChainBuildingCertificate)(PP_Resource tcp_socket, PP_Resource certificate, PP_Bool is_trusted)

NOTE: This function is not implemented and will return PP_FALSE. Adds a trusted/untrusted chain building certificate to be used for this connection. The certificate must be a PPB_X509Certificate_Private. PP_TRUE is returned upon success.

int32_t(* PPB_TCPSocket_Private_0_5::Connect)(PP_Resource tcp_socket, const char *host, uint16_t port, struct PP_CompletionCallback callback)

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(* PPB_TCPSocket_Private_0_5::ConnectWithNetAddress)(PP_Resource tcp_socket, const struct PP_NetAddress_Private *addr, struct PP_CompletionCallback callback)

Same as Connect(), but connecting to the address given by |addr|. A typical use-case would be for reconnections.

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

Allocates a TCP socket resource.

void(* PPB_TCPSocket_Private_0_5::Disconnect)(PP_Resource tcp_socket)

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.

PP_Bool(* PPB_TCPSocket_Private_0_5::GetLocalAddress)(PP_Resource tcp_socket, struct PP_NetAddress_Private *local_addr)

Gets the local address of the socket, if it has been connected. Returns PP_TRUE on success.

PP_Bool(* PPB_TCPSocket_Private_0_5::GetRemoteAddress)(PP_Resource tcp_socket, struct PP_NetAddress_Private *remote_addr)

Gets the remote address of the socket, if it has been connected. Returns PP_TRUE on success.

PP_Resource(* PPB_TCPSocket_Private_0_5::GetServerCertificate)(PP_Resource tcp_socket)

Returns the server's PPB_X509Certificate_Private for a socket connection if an SSL connection has been established using SSLHandshake. If no SSL connection has been established, a null resource is returned.

PP_Bool(* PPB_TCPSocket_Private_0_5::IsTCPSocket)(PP_Resource resource)

Determines if a given resource is TCP socket.

int32_t(* PPB_TCPSocket_Private_0_5::Read)(PP_Resource tcp_socket, char *buffer, int32_t bytes_to_read, struct PP_CompletionCallback callback)

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(* PPB_TCPSocket_Private_0_5::SetOption)(PP_Resource tcp_socket, PP_TCPSocketOption_Private name, struct PP_Var value, struct PP_CompletionCallback callback)

int32_t(* PPB_TCPSocket_Private_0_5::SSLHandshake)(PP_Resource tcp_socket, const char *server_name, uint16_t server_port, struct PP_CompletionCallback callback)

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(* PPB_TCPSocket_Private_0_5::Write)(PP_Resource tcp_socket, const char *buffer, int32_t bytes_to_write, 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.

The documentation for this struct was generated from the following file:

ppapi/c/private/ppb_tcp_socket_private.h

Public Attributes

Detailed Description

Member Data Documentation