third_party/blink/public/web/web_pepper_socket_client.h

/*
 * Copyright (C) 2011, 2012 Google Inc.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef THIRD_PARTY_BLINK_PUBLIC_WEB_WEB_PEPPER_SOCKET_CLIENT_H_
#define THIRD_PARTY_BLINK_PUBLIC_WEB_WEB_PEPPER_SOCKET_CLIENT_H_

#include "third_party/blink/public/platform/web_common.h"

namespace blink {

class WebArrayBuffer;
class WebString;

class WebPepperSocketClient {
 public:
  enum ClosingHandshakeCompletionStatus {
    kClosingHandshakeIncomplete,
    kClosingHandshakeComplete
  };

  virtual ~WebPepperSocketClient() = default;
  virtual void DidConnect(const WebString& subprotocol,
                          const WebString& extensions) {}
  virtual void DidReceiveMessage(const WebString& message) {}
  virtual void DidReceiveArrayBuffer(const WebArrayBuffer& array_buffer) {}
  virtual void DidReceiveMessageError() {}
  virtual void DidConsumeBufferedAmount(uint64_t consumed) {}
  virtual void DidStartClosingHandshake() {}
  virtual void DidClose(ClosingHandshakeCompletionStatus,
                        unsigned short code,
                        const WebString& reason) {}

  // FIXME: Deperecate these methods.
  virtual void DidConnect() {}
  virtual void DidUpdateBufferedAmount(unsigned long buffered_amount) {}
  virtual void DidClose(unsigned long unhandled_buffered_amount,
                        ClosingHandshakeCompletionStatus,
                        unsigned short code,
                        const WebString& reason) {}
};

}  // namespace blink

#endif  // THIRD_PARTY_BLINK_PUBLIC_WEB_WEB_PEPPER_SOCKET_CLIENT_H_