15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch/* From private/ppb_udp_socket_private.idl modified Mon Jun 24 09:53:43 2013. */ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef PPAPI_C_PRIVATE_PPB_UDP_SOCKET_PRIVATE_H_ 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define PPAPI_C_PRIVATE_PPB_UDP_SOCKET_PRIVATE_H_ 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ppapi/c/pp_bool.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ppapi/c/pp_completion_callback.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ppapi/c/pp_instance.h" 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ppapi/c/pp_macros.h" 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ppapi/c/pp_resource.h" 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ppapi/c/pp_stdint.h" 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ppapi/c/pp_var.h" 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ppapi/c/private/ppb_net_address_private.h" 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define PPB_UDPSOCKET_PRIVATE_INTERFACE_0_2 "PPB_UDPSocket_Private;0.2" 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define PPB_UDPSOCKET_PRIVATE_INTERFACE_0_3 "PPB_UDPSocket_Private;0.3" 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define PPB_UDPSOCKET_PRIVATE_INTERFACE_0_4 "PPB_UDPSocket_Private;0.4" 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define PPB_UDPSOCKET_PRIVATE_INTERFACE PPB_UDPSOCKET_PRIVATE_INTERFACE_0_4 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * @file 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * This file defines the <code>PPB_UDPSocket_Private</code> interface. 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * @addtogroup Enums 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * @{ 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)typedef enum { 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* Allow the socket to share the local address to which socket will 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * be bound with other processes. Value's type should be 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * PP_VARTYPE_BOOL. */ 39eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch PP_UDPSOCKETFEATURE_PRIVATE_ADDRESS_REUSE = 0, 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* Allow sending and receiving packets sent to and from broadcast 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * addresses. Value's type should be PP_VARTYPE_BOOL. */ 42eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch PP_UDPSOCKETFEATURE_PRIVATE_BROADCAST = 1, 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* Special value for counting the number of available 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * features. Should not be passed to SetSocketFeature(). */ 45eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch PP_UDPSOCKETFEATURE_PRIVATE_COUNT = 2 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} PP_UDPSocketFeature_Private; 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_UDPSocketFeature_Private, 4); 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * @} 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * @addtogroup Interfaces 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * @{ 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)struct PPB_UDPSocket_Private_0_4 { 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Creates a UDP socket resource. 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_Resource (*Create)(PP_Instance instance_id); 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Determines if a given resource is a UDP socket. 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_Bool (*IsUDPSocket)(PP_Resource resource_id); 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Sets a socket feature to |udp_socket|. Should be called before 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Bind(). Possible values for |name|, |value| and |value|'s type 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * are described in PP_UDPSocketFeature_Private description. If no 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * error occurs, returns PP_OK. Otherwise, returns 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * PP_ERROR_BADRESOURCE (if bad |udp_socket| provided), 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * PP_ERROR_BADARGUMENT (if bad name/value/value's type provided) 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * or PP_ERROR_FAILED in the case of internal errors. 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int32_t (*SetSocketFeature)(PP_Resource udp_socket, 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_UDPSocketFeature_Private name, 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct PP_Var value); 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* Creates a socket and binds to the address given by |addr|. */ 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int32_t (*Bind)(PP_Resource udp_socket, 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const struct PP_NetAddress_Private* addr, 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct PP_CompletionCallback callback); 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* Returns the address that the socket has bound to. A successful 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * call to Bind must be called first. Returns PP_FALSE if Bind 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * fails, or if Close has been called. 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_Bool (*GetBoundAddress)(PP_Resource udp_socket, 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct PP_NetAddress_Private* addr); 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* Performs a non-blocking recvfrom call on socket. 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Bind must be called first. |callback| is invoked when recvfrom 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * reads data. You must call GetRecvFromAddress to recover the 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * address the data was retrieved from. 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int32_t (*RecvFrom)(PP_Resource udp_socket, 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) char* buffer, 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int32_t num_bytes, 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct PP_CompletionCallback callback); 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* Upon successful completion of RecvFrom, the address that the data 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * was received from is stored in |addr|. 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_Bool (*GetRecvFromAddress)(PP_Resource udp_socket, 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct PP_NetAddress_Private* addr); 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* Performs a non-blocking sendto call on the socket created and 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * bound(has already called Bind). The callback |callback| is 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * invoked when sendto completes. 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int32_t (*SendTo)(PP_Resource udp_socket, 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const char* buffer, 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int32_t num_bytes, 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const struct PP_NetAddress_Private* addr, 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct PP_CompletionCallback callback); 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* Cancels all pending reads and writes, and closes the socket. */ 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void (*Close)(PP_Resource udp_socket); 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)typedef struct PPB_UDPSocket_Private_0_4 PPB_UDPSocket_Private; 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)struct PPB_UDPSocket_Private_0_2 { 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_Resource (*Create)(PP_Instance instance_id); 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_Bool (*IsUDPSocket)(PP_Resource resource_id); 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int32_t (*Bind)(PP_Resource udp_socket, 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const struct PP_NetAddress_Private* addr, 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct PP_CompletionCallback callback); 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int32_t (*RecvFrom)(PP_Resource udp_socket, 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) char* buffer, 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int32_t num_bytes, 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct PP_CompletionCallback callback); 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_Bool (*GetRecvFromAddress)(PP_Resource udp_socket, 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct PP_NetAddress_Private* addr); 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int32_t (*SendTo)(PP_Resource udp_socket, 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const char* buffer, 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int32_t num_bytes, 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const struct PP_NetAddress_Private* addr, 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct PP_CompletionCallback callback); 1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void (*Close)(PP_Resource udp_socket); 1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)struct PPB_UDPSocket_Private_0_3 { 1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_Resource (*Create)(PP_Instance instance_id); 1385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_Bool (*IsUDPSocket)(PP_Resource resource_id); 1395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int32_t (*Bind)(PP_Resource udp_socket, 1405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const struct PP_NetAddress_Private* addr, 1415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct PP_CompletionCallback callback); 1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_Bool (*GetBoundAddress)(PP_Resource udp_socket, 1435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct PP_NetAddress_Private* addr); 1445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int32_t (*RecvFrom)(PP_Resource udp_socket, 1455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) char* buffer, 1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int32_t num_bytes, 1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct PP_CompletionCallback callback); 1485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_Bool (*GetRecvFromAddress)(PP_Resource udp_socket, 1495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct PP_NetAddress_Private* addr); 1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int32_t (*SendTo)(PP_Resource udp_socket, 1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const char* buffer, 1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int32_t num_bytes, 1535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const struct PP_NetAddress_Private* addr, 1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct PP_CompletionCallback callback); 1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void (*Close)(PP_Resource udp_socket); 1565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** 1585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * @} 1595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 1605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif /* PPAPI_C_PRIVATE_PPB_UDP_SOCKET_PRIVATE_H_ */ 1625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 163