io.vertx.ext.web.handler.sockjs.SockJSSocket Maven / Gradle / Ivy
/*
* Copyright 2014 Red Hat, Inc.
*
* 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.
*/
/*
* 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.ext.web.handler.sockjs;
import io.vertx.codegen.annotations.Nullable;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.*;
import io.vertx.core.buffer.Buffer;
import io.vertx.core.net.SocketAddress;
import io.vertx.core.streams.ReadStream;
import io.vertx.core.streams.WriteStream;
import io.vertx.ext.auth.User;
import io.vertx.ext.web.RoutingContext;
import io.vertx.ext.web.Session;
/**
*
* You interact with SockJS clients through instances of SockJS socket.
*
* The API is very similar to {@link io.vertx.core.http.WebSocket}.
* It implements both {@link ReadStream} and {@link WriteStream}
* so it can be used with
* {@link io.vertx.core.streams.Pump} to pump data with flow control.
*
* @author Tim Fox
*/
@VertxGen
public interface SockJSSocket extends ReadStream, WriteStream {
@Override
SockJSSocket exceptionHandler(Handler handler);
@Override
SockJSSocket handler(Handler handler);
@Override
SockJSSocket pause();
@Override
SockJSSocket resume();
@Override
SockJSSocket fetch(long amount);
@Override
SockJSSocket endHandler(Handler endHandler);
SockJSSocket closeHandler(Handler closeHandler);
@Override
Future write(Buffer data);
/**
* Write a {@link String} to the socket, encoded in UTF-8.
*
* @param data the string to write
*/
default Future write(String data) {
return write(Buffer.buffer(data));
}
default void write(String data, Handler> handler) {
write(data)
.onComplete(handler);
}
@Override
default void write(Buffer data, Handler> handler) {
write(data)
.onComplete(handler);
}
@Override
SockJSSocket setWriteQueueMaxSize(int maxSize);
@Override
SockJSSocket drainHandler(Handler handler);
/**
* When a {@code SockJSSocket} is created it can register an event handler with the event bus, the ID of that
* handler is given by {@code writeHandlerID}.
*
* Given this ID, a different event loop can send a buffer to that event handler using the event bus and
* that buffer will be received by this instance in its own event loop and written to the underlying socket. This
* allows you to write data to other sockets which are owned by different event loops.
*
* @return the {@code writeHandlerID} or {@code null} if {@code writeHandler} registration is disabled in {@link SockJSHandlerOptions}
*/
String writeHandlerID();
/**
* Call {@link #close()}.
*/
@Override
Future end();
/**
* Close it
*/
void close();
/**
* Close it giving a status code and reason. Only Applicable to RawWebSocket will downgrade to plain close for
* other transports.
*/
default void close(int statusCode, String reason) {
close();
}
/**
* Return the remote address for this socket
*/
SocketAddress remoteAddress();
/**
* Return the local address for this socket
*/
SocketAddress localAddress();
/**
* Return the headers corresponding to the last request for this socket or the websocket handshake
* Any cookie headers will be removed for security reasons
*/
MultiMap headers();
/**
* Return the URI corresponding to the last request for this socket or the websocket handshake
*/
String uri();
/**
* @return the Vert.x-Web RoutingContext corresponding to this socket
*/
RoutingContext routingContext();
/**
* @return the Vert.x-Web session corresponding to this socket
*/
@Nullable
Session webSession();
/**
* @return the Vert.x-Web user corresponding to this socket
*/
@Nullable
User webUser();
}