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)#ifndef PPAPI_THUNK_WEBSOCKET_API_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define PPAPI_THUNK_WEBSOCKET_API_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/ref_counted.h" 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ppapi/c/pp_completion_callback.h" 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ppapi/c/ppb_websocket.h" 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ppapi/thunk/ppapi_thunk_export.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace ppapi { 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class TrackedCallback; 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace thunk { 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Some arguments and attributes are based on The WebSocket Protocol and The 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// WebSocket API. See also following official specifications. 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// - The WebSocket Protocol http://tools.ietf.org/html/rfc6455 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// - The WebSocket API http://dev.w3.org/html5/websockets/ 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class PPAPI_THUNK_EXPORT PPB_WebSocket_API { 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~PPB_WebSocket_API() {} 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Connects to the specified WebSocket server with |protocols| argument 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // defined by the WebSocket API. Returns an int32_t error code from 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // pp_errors.h. 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual int32_t Connect(const PP_Var& url, 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const PP_Var protocols[], 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint32_t protocol_count, 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_refptr<TrackedCallback> callback) = 0; 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Closes the established connection with specified |code| and |reason|. 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns an int32_t error code from pp_errors.h. 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual int32_t Close(uint16_t code, 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const PP_Var& reason, 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_refptr<TrackedCallback> callback) = 0; 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Receives a message from the WebSocket server. Caller must keep specified 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |message| object as valid until completion callback is invoked. Returns an 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // int32_t error code from pp_errors.h. 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual int32_t ReceiveMessage(PP_Var* message, 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_refptr<TrackedCallback> callback) = 0; 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Sends a message to the WebSocket server. Returns an int32_t error code 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // from pp_errors.h. 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual int32_t SendMessage(const PP_Var& message) = 0; 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the bufferedAmount attribute of The WebSocket API. 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual uint64_t GetBufferedAmount() = 0; 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the CloseEvent code attribute of The WebSocket API. Returned code 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // is valid if the connection is already closed and wasClean attribute is 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // true. 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual uint16_t GetCloseCode() = 0; 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the CloseEvent reason attribute of The WebSocket API. Returned 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // code is valid if the connection is already closed and wasClean attribute 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // is true. 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual PP_Var GetCloseReason() = 0; 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the CloseEvent wasClean attribute of The WebSocket API. Returned 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // code is valid if the connection is already closed. 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual PP_Bool GetCloseWasClean() = 0; 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the extensions attribute of The WebSocket API. 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual PP_Var GetExtensions() = 0; 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the protocol attribute of The WebSocket API. 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual PP_Var GetProtocol() = 0; 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the readState attribute of The WebSocket API. 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual PP_WebSocketReadyState GetReadyState() = 0; 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the url attribute of The WebSocket API. 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual PP_Var GetURL() = 0; 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace thunk 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace ppapi 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // PPAPI_THUNK_WEBSOCKET_API_H_ 85