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.CR1

/*
 * Copyright (c) 2011-2019 Contributors to the Eclipse Foundation
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
 * which is available at https://www.apache.org/licenses/LICENSE-2.0.
 *
 * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
 */

package io.vertx.core.http;

import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.AsyncResult;
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 fetch(long amount);

  @Override
  WebSocket endHandler(Handler endHandler);

  @Override
  WebSocket setWriteQueueMaxSize(int maxSize);

  @Override
  WebSocket drainHandler(Handler handler);

  @Override
  WebSocket writeFrame(WebSocketFrame frame, Handler> handler);

  @Override
  WebSocket writeFinalTextFrame(String text, Handler> handler);

  @Override
  WebSocket writeFinalBinaryFrame(Buffer data, Handler> handler);

  @Override
  WebSocket writeBinaryMessage(Buffer data, Handler> handler);

  @Override
  WebSocket writeTextMessage(String text, Handler> handler);

  @Override
  WebSocket writePing(Buffer data, Handler> handler);

  @Override
  WebSocket writePong(Buffer data, Handler> handler);

  @Override
  WebSocket closeHandler(Handler handler);

  @Override
  WebSocket frameHandler(Handler handler);
}