Home | History | Annotate | Download | only in platform 
      1 /*
      2  * Copyright (C) 2013 Google Inc. All rights reserved.
      3  *
      4  * Redistribution and use in source and binary forms, with or without
      5  * modification, are permitted provided that the following conditions are
      6  * met:
      7  *
      8  *     * Redistributions of source code must retain the above copyright
      9  * notice, this list of conditions and the following disclaimer.
     10  *     * Redistributions in binary form must reproduce the above
     11  * copyright notice, this list of conditions and the following disclaimer
     12  * in the documentation and/or other materials provided with the
     13  * distribution.
     14  *     * Neither the name of Google Inc. nor the names of its
     15  * contributors may be used to endorse or promote products derived from
     16  * this software without specific prior written permission.
     17  *
     18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     29  */
     30 
     31 #ifndef WebSocketHandle_h
     32 #define WebSocketHandle_h
     33 
     34 #include "public/platform/WebCommon.h"
     35 #include "public/platform/WebVector.h"
     36 
     37 namespace blink {
     38 
     39 class WebSerializedOrigin;
     40 class WebSocketHandleClient;
     41 class WebString;
     42 class WebURL;
     43 
     44 // FIXME: This class will replace WebSocketStreamHandle.
     45 //
     46 // WebSocketHandle is an interface class designed to be a handle of WebSocket connection.
     47 // WebSocketHandle will be used together with WebSocketHandleClient.
     48 //
     49 // Once a WebSocketHandle is deleted there will be no notification to the corresponding WebSocketHandleClient.
     50 // Once a WebSocketHandleClient receives DidClose, any method of the corresponding WebSocketHandle can't be called.
     51 
     52 class WebSocketHandle {
     53 public:
     54     enum MessageType {
     55         MessageTypeContinuation,
     56         MessageTypeText,
     57         MessageTypeBinary,
     58     };
     59 
     60     virtual ~WebSocketHandle() { }
     61 
     62     virtual void connect(const WebURL& /* url */, const WebVector<WebString>& protocols, const WebSerializedOrigin& /* origin */, WebSocketHandleClient*) = 0;
     63     virtual void send(bool fin, MessageType, const char* data, size_t /* size */) = 0;
     64     virtual void flowControl(int64_t quota) = 0;
     65     virtual void close(unsigned short code, const WebString& reason) = 0;
     66 };
     67 
     68 } // namespace blink
     69 
     70 #endif // WebSocketHandle_h
     71