io.vertx.core.http.WebSocket Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vertx-core Show documentation

There is a newer version: 5.0.0.CR3

/*
 * Copyright (c) 2011-2013 The original author or authors
 * ------------------------------------------------------
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * and Apache License v2.0 which accompanies this distribution.
 *
 *     The Eclipse Public License is available at
 *     http://www.eclipse.org/legal/epl-v10.html
 *
 *     The Apache License v2.0 is available at
 *     http://www.opensource.org/licenses/apache2.0.php
 *
 * You may elect to redistribute this code under either of these licenses.
 */

package io.vertx.core.http;

import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.Handler;
import io.vertx.core.buffer.Buffer;

/**
 * Represents a client-side WebSocket.
 *
 * @author Tim Fox
 */
@VertxGen
public interface WebSocket extends WebSocketBase {

  @Override
  WebSocket exceptionHandler(Handler handler);

  @Override
  WebSocket handler(Handler handler);

  @Override
  WebSocket pause();

  @Override
  WebSocket resume();

  @Override
  WebSocket endHandler(Handler endHandler);

  @Override
  WebSocket write(Buffer data);

  @Override
  WebSocket setWriteQueueMaxSize(int maxSize);

  @Override
  WebSocket drainHandler(Handler handler);

  @Override
  WebSocket writeFrame(WebSocketFrame frame);

  @Override
  WebSocket writeFinalTextFrame(String text);

  @Override
  WebSocket writeFinalBinaryFrame(Buffer data);

  @Override
  WebSocket writeBinaryMessage(Buffer data);

  @Override
  WebSocket closeHandler(Handler handler);

  @Override
  WebSocket frameHandler(Handler handler);
}