src/third_party/WebKit/Source/modules/websockets/WebSocketChannelClient.h

   1 /*
   2  * Copyright (C) 2011 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 WebSocketChannelClient_h
  32 #define WebSocketChannelClient_h
  33
  34 #include "platform/heap/Handle.h"
  35 #include "wtf/Forward.h"
  36 #include "wtf/PassOwnPtr.h"
  37 #include "wtf/Vector.h"
  38
  39 namespace blink {
  40
  41 class WebSocketChannelClient : public GarbageCollectedMixin {
  42 public:
  43     virtual ~WebSocketChannelClient() { }
  44     virtual void didConnect(const String& subprotocol, const String& extensions) { }
  45     virtual void didReceiveTextMessage(const String&) { }
  46     virtual void didReceiveBinaryMessage(PassOwnPtr<Vector<char> >) { }
  47     virtual void didError() { }
  48     virtual void didConsumeBufferedAmount(unsigned long consumed) { }
  49     virtual void didStartClosingHandshake() { }
  50     enum ClosingHandshakeCompletionStatus {
  51         ClosingHandshakeIncomplete,
  52         ClosingHandshakeComplete
  53     };
  54     virtual void didClose(ClosingHandshakeCompletionStatus, unsigned short /* code */, const String& /* reason */) { }
  55     virtual void trace(Visitor*) { }
  56
  57 protected:
  58     WebSocketChannelClient() { }
  59 };
  60
  61 } // namespace blink
  62
  63 #endif // WebSocketChannelClient_h