diff options
author | yzshen@chromium.org <yzshen@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98> | 2013-06-13 06:48:36 +0000 |
---|---|---|
committer | yzshen@chromium.org <yzshen@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98> | 2013-06-13 06:48:36 +0000 |
commit | b1784f4dc9fbf104e4454796edf26d2f76e16a94 (patch) | |
tree | 476affcb92e4fa1e2f0772a935bc3f63f8164630 /ppapi/c | |
parent | b1c988bcd7869765e1bd56e592787af123340516 (diff) | |
download | chromium_src-b1784f4dc9fbf104e4454796edf26d2f76e16a94.zip chromium_src-b1784f4dc9fbf104e4454796edf26d2f76e16a94.tar.gz chromium_src-b1784f4dc9fbf104e4454796edf26d2f76e16a94.tar.bz2 |
Introduce PPB_TCPSocket_Dev.
This change exposes the PPB_TCPSocket_Dev interface and makes it to share the same backend as PPB_TCPSocket_Private.
It doesn't include:
- apps permission check;
- TCP socket options that PPB_TCPSocket_Private doesn't support.
These will be implemented in separate CLs.
BUG=247225
TEST=newly added test_tcp_socket.{h,cc}.
Review URL: https://chromiumcodereview.appspot.com/16667002
git-svn-id: svn://svn.chromium.org/chrome/trunk/src@206014 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'ppapi/c')
-rw-r--r-- | ppapi/c/dev/ppb_tcp_socket_dev.h | 136 |
1 files changed, 136 insertions, 0 deletions
diff --git a/ppapi/c/dev/ppb_tcp_socket_dev.h b/ppapi/c/dev/ppb_tcp_socket_dev.h new file mode 100644 index 0000000..d59bc31 --- /dev/null +++ b/ppapi/c/dev/ppb_tcp_socket_dev.h @@ -0,0 +1,136 @@ +/* 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. + */ + +/* From dev/ppb_tcp_socket_dev.idl modified Wed Jun 12 11:16:37 2013. */ + +#ifndef PPAPI_C_DEV_PPB_TCP_SOCKET_DEV_H_ +#define PPAPI_C_DEV_PPB_TCP_SOCKET_DEV_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" + +#define PPB_TCPSOCKET_DEV_INTERFACE_0_1 "PPB_TCPSocket(Dev);0.1" +#define PPB_TCPSOCKET_DEV_INTERFACE PPB_TCPSOCKET_DEV_INTERFACE_0_1 + +/** + * @file + * This file defines the <code>PPB_TCPSocket_Dev</code> interface. + */ + + +/** + * @addtogroup Enums + * @{ + */ +typedef enum { + /* Disables coalescing of small writes to make TCP segments, and instead + * deliver data immediately. Value type is PP_VARTYPE_BOOL. */ + PP_TCPSOCKET_OPTION_NO_DELAY = 0, + /* Specifies the socket send buffer in bytes. Value's type should be + * PP_VARTYPE_INT32. + * Note: This is only treated as a hint for the browser to set the buffer + * size. Even if SetOption() reports that this option has been successfully + * set, the browser doesn't guarantee to conform to it. */ + PP_TCPSOCKET_OPTION_SEND_BUFFER_SIZE = 1, + /* Specifies the socket receive buffer in bytes. Value's type should be + * PP_VARTYPE_INT32. + * Note: This is only treated as a hint for the browser to set the buffer + * size. Even if SetOption() reports that this option has been successfully + * set, the browser doesn't guarantee to conform to it. */ + PP_TCPSOCKET_OPTION_RECV_BUFFER_SIZE = 2 +} PP_TCPSocket_Option_Dev; +PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_TCPSocket_Option_Dev, 4); +/** + * @} + */ + +/** + * @addtogroup Interfaces + * @{ + */ +/** + * The <code>PPB_TCPSocket_Dev</code> interface provides TCP socket operations. + */ +struct PPB_TCPSocket_Dev_0_1 { + /** + * 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 an address given by |addr|, which is a PPB_NetAddress_Dev + * resource. + */ + int32_t (*Connect)(PP_Resource tcp_socket, + PP_Resource addr, + struct PP_CompletionCallback callback); + /** + * Gets the local address of the socket, if it has been connected. + * Returns a PPB_NetAddress_Dev resource on success; returns 0 on failure. + */ + PP_Resource (*GetLocalAddress)(PP_Resource tcp_socket); + /** + * Gets the remote address of the socket, if it has been connected. + * Returns a PPB_NetAddress_Dev resource on success; returns 0 on failure. + */ + PP_Resource (*GetRemoteAddress)(PP_Resource tcp_socket); + /** + * 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. + * + * 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. + * + * 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 (*Close)(PP_Resource tcp_socket); + /** + * Sets an option on |tcp_socket|. Supported |name| and |value| parameters + * are as described for PP_TCPSocketOption_Dev. |callback| will be + * invoked with PP_OK if setting the option succeeds, or an error code + * otherwise. The socket must be connected before SetOption is called. + */ + int32_t (*SetOption)(PP_Resource tcp_socket, + PP_TCPSocket_Option_Dev name, + struct PP_Var value, + struct PP_CompletionCallback callback); +}; + +typedef struct PPB_TCPSocket_Dev_0_1 PPB_TCPSocket_Dev; +/** + * @} + */ + +#endif /* PPAPI_C_DEV_PPB_TCP_SOCKET_DEV_H_ */ + |