io.vertx.ext.web.handler.sockjs

Interface SockJSSocket

All Superinterfaces:

ReadStream<Buffer>, StreamBase, WriteStream<Buffer>

public interface SockJSSocket
extends ReadStream<Buffer>, WriteStream<Buffer>

You interact with SockJS clients through instances of SockJS socket.

The API is very similar to WebSocket. It implements both ReadStream and WriteStream so it can be used with Pump to pump data with flow control.

Author:

Tim Fox

Method Summary

Modifier and Type	Method and Description
void	close() Close it
default void	close(int statusCode, String reason) Close it giving a status code and reason.
SockJSSocket	closeHandler(Handler<Void> closeHandler)
SockJSSocket	drainHandler(Handler<Void> handler)
Future<Void>	end() Call close().
SockJSSocket	endHandler(Handler<Void> endHandler)
SockJSSocket	exceptionHandler(Handler<Throwable> handler)
SockJSSocket	fetch(long amount)
SockJSSocket	handler(Handler<Buffer> handler)
MultiMap	headers() Return the headers corresponding to the last request for this socket or the websocket handshake Any cookie headers will be removed for security reasons
SocketAddress	localAddress() Return the local address for this socket
SockJSSocket	pause()
SocketAddress	remoteAddress() Return the remote address for this socket
SockJSSocket	resume()
RoutingContext	routingContext()
SockJSSocket	setWriteQueueMaxSize(int maxSize)
String	uri() Return the URI corresponding to the last request for this socket or the websocket handshake
Session	webSession()
User	webUser()
default Future<Void>	write(Buffer data)
void	write(Buffer data, Handler<AsyncResult<Void>> handler)
default Future<Void>	write(String data) Write a String to the socket, encoded in UTF-8.
default void	write(String data, Handler<AsyncResult<Void>> handler)
String	writeHandlerID() When a SockJSSocket is created it can register an event handler with the event bus, the ID of that handler is given by writeHandlerID.

Methods inherited from interface io.vertx.core.streams.ReadStream

pipe, pipeTo, pipeTo

Methods inherited from interface io.vertx.core.streams.WriteStream

end, end, end, writeQueueFull

Method Detail

exceptionHandler

SockJSSocket exceptionHandler(Handler<Throwable> handler)

Specified by:

exceptionHandler in interface ReadStream<Buffer>

Specified by:

exceptionHandler in interface StreamBase

Specified by:

exceptionHandler in interface WriteStream<Buffer>

handler

SockJSSocket handler(Handler<Buffer> handler)

Specified by:

handler in interface ReadStream<Buffer>

pause

SockJSSocket pause()

Specified by:

pause in interface ReadStream<Buffer>

resume

SockJSSocket resume()

Specified by:

resume in interface ReadStream<Buffer>

fetch

SockJSSocket fetch(long amount)

Specified by:

fetch in interface ReadStream<Buffer>

endHandler

SockJSSocket endHandler(Handler<Void> endHandler)

Specified by:

endHandler in interface ReadStream<Buffer>

closeHandler

SockJSSocket closeHandler(Handler<Void> closeHandler)

write

default Future<Void> write(Buffer data)

Specified by:

write in interface WriteStream<Buffer>

write

default Future<Void> write(String data)

Write a String to the socket, encoded in UTF-8.

Parameters:

data - the string to write

write

default void write(String data,
                   Handler<AsyncResult<Void>> handler)

write

void write(Buffer data,
           Handler<AsyncResult<Void>> handler)

Specified by:

write in interface WriteStream<Buffer>

setWriteQueueMaxSize

SockJSSocket setWriteQueueMaxSize(int maxSize)

Specified by:

setWriteQueueMaxSize in interface WriteStream<Buffer>

drainHandler

SockJSSocket drainHandler(Handler<Void> handler)

Specified by:

drainHandler in interface WriteStream<Buffer>

writeHandlerID

String writeHandlerID()

When a SockJSSocket is created it can register an event handler with the event bus, the ID of that handler is given by 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.

Returns:

the writeHandlerID or null if writeHandler registration is disabled in SockJSHandlerOptions

end

Future<Void> end()

Call close().

Specified by:

end in interface WriteStream<Buffer>

close

void close()

Close it

close

default void close(int statusCode,
                   String reason)

Close it giving a status code and reason. Only Applicable to RawWebSocket will downgrade to plain close for other transports.

remoteAddress

SocketAddress remoteAddress()

Return the remote address for this socket

localAddress

SocketAddress localAddress()

Return the local address for this socket

headers

MultiMap headers()

Return the headers corresponding to the last request for this socket or the websocket handshake Any cookie headers will be removed for security reasons

uri

String uri()

Return the URI corresponding to the last request for this socket or the websocket handshake

routingContext

RoutingContext routingContext()

Returns:

the Vert.x-Web RoutingContext corresponding to this socket

webSession

Session webSession()

Returns:

the Vert.x-Web session corresponding to this socket

webUser

User webUser()

Returns:

the Vert.x-Web user corresponding to this socket