ppapi/c/private/ppb_tcp_server_socket_private.h

   1 /* Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2  * Use of this source code is governed by a BSD-style license that can be
   3  * found in the LICENSE file.
   4  */
   5
   6 /* From private/ppb_tcp_server_socket_private.idl,
   7  *   modified Thu Mar 28 10:31:11 2013.
   8  */
   9
  10 #ifndef PPAPI_C_PRIVATE_PPB_TCP_SERVER_SOCKET_PRIVATE_H_
  11 #define PPAPI_C_PRIVATE_PPB_TCP_SERVER_SOCKET_PRIVATE_H_
  12
  13 #include "ppapi/c/pp_bool.h"
  14 #include "ppapi/c/pp_completion_callback.h"
  15 #include "ppapi/c/pp_instance.h"
  16 #include "ppapi/c/pp_macros.h"
  17 #include "ppapi/c/pp_resource.h"
  18 #include "ppapi/c/pp_stdint.h"
  19 #include "ppapi/c/private/ppb_net_address_private.h"
  20
  21 #define PPB_TCPSERVERSOCKET_PRIVATE_INTERFACE_0_1 \
  22     "PPB_TCPServerSocket_Private;0.1"
  23 #define PPB_TCPSERVERSOCKET_PRIVATE_INTERFACE \
  24     PPB_TCPSERVERSOCKET_PRIVATE_INTERFACE_0_1
  25
  26 /**
  27  * @file
  28  * This file defines the <code>PPB_TCPServerSocket_Private</code> interface.
  29  */
  30
  31
  32 /**
  33  * @addtogroup Interfaces
  34  * @{
  35  */
  36 /**
  37  * The <code>PPB_TCPServerSocket_Private</code> interface provides TCP
  38  * server socket operations.
  39  */
  40 struct PPB_TCPServerSocket_Private_0_1 {
  41   /**
  42    * Allocates a TCP server socket resource.
  43    */
  44   PP_Resource (*Create)(PP_Instance instance);
  45   /**
  46    * Determines if a given resource is TCP server socket.
  47    */
  48   PP_Bool (*IsTCPServerSocket)(PP_Resource resource);
  49   /**
  50    * Binds |tcp_server_socket| to the address given by |addr| and
  51    * starts listening.  The |backlog| argument defines the maximum
  52    * length to which the queue of pending connections may
  53    * grow. |callback| is invoked when |tcp_server_socket| is ready to
  54    * accept incoming connections or in the case of failure. Returns
  55    * PP_ERROR_NOSPACE if socket can't be initialized, or
  56    * PP_ERROR_FAILED in the case of Listen failure. Otherwise, returns
  57    * PP_OK.
  58    */
  59   int32_t (*Listen)(PP_Resource tcp_server_socket,
  60                     const struct PP_NetAddress_Private* addr,
  61                     int32_t backlog,
  62                     struct PP_CompletionCallback callback);
  63   /**
  64    * Accepts single connection, creates instance of
  65    * PPB_TCPSocket_Private and stores reference to it in
  66    * |tcp_socket|. |callback| is invoked when connection is accepted
  67    * or in the case of failure. This method can be called only after
  68    * successful Listen call on |tcp_server_socket|.
  69    */
  70   int32_t (*Accept)(PP_Resource tcp_server_socket,
  71                     PP_Resource* tcp_socket,
  72                     struct PP_CompletionCallback callback);
  73   /**
  74    * Cancels all pending callbacks reporting PP_ERROR_ABORTED and
  75    * closes the socket. Note: this method is implicitly called when
  76    * server socket is destroyed.
  77    */
  78   void (*StopListening)(PP_Resource tcp_server_socket);
  79 };
  80
  81 typedef struct PPB_TCPServerSocket_Private_0_1 PPB_TCPServerSocket_Private;
  82 /**
  83  * @}
  84  */
  85
  86 #endif  /* PPAPI_C_PRIVATE_PPB_TCP_SERVER_SOCKET_PRIVATE_H_ */
  87