io.socket.engineio.server

Class Transport

java.lang.Object

io.socket.emitter.Emitter

io.socket.engineio.server.Transport

Direct Known Subclasses:

Polling, WebSocket

public abstract class Transport
extends io.socket.emitter.Emitter

Base class for all transports.

Nested Class Summary

Nested classes/interfaces inherited from class io.socket.emitter.Emitter

io.socket.emitter.Emitter.Listener

Field Summary

Fields

Modifier and Type	Field and Description
protected ReadyState	mReadyState

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Transport()

Method Summary

Modifier and Type	Method and Description
void	close() Close the transport if not already closed.
protected abstract void	doClose() Transport specific logic for closing transport.
abstract Map<String,List<String>>	getInitialHeaders() Get the headers of the initial HTTP request.
abstract Map<String,String>	getInitialQuery() Get the query parameters of the initial HTTP request.
abstract String	getName() Get the name of this transport.
abstract boolean	isWritable() Checks whether the transport is currently writable.
protected void	onClose() Called by child to indicate closure of transport.
protected void	onData(Object data) Called by child to indicate data received from remote client.
protected void	onError(String reason, String description) Called by child class to indicate error with transport.
protected void	onPacket(io.socket.engineio.parser.Packet<?> packet) Called by child to indicate a packet receive from remote client.
abstract void	onRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handle a client HTTP request.
abstract void	send(List<io.socket.engineio.parser.Packet<?>> packets) Send a list of packets over the transport.

Methods inherited from class io.socket.emitter.Emitter

emit, hasListeners, listeners, off, off, off, on, once

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mReadyState

protected ReadyState mReadyState

Constructor Detail

Transport

protected Transport()

Method Detail

getInitialQuery

public abstract Map<String,String> getInitialQuery()

Get the query parameters of the initial HTTP request.

Returns:

Query parameters of the initial HTTP request.

getInitialHeaders

public abstract Map<String,List<String>> getInitialHeaders()

Get the headers of the initial HTTP request.

Returns:

Headers of the initial HTTP request.

onRequest

public abstract void onRequest(javax.servlet.http.HttpServletRequest request,
                               javax.servlet.http.HttpServletResponse response)
                        throws IOException

Handle a client HTTP request.

Parameters:

request - The HTTP request object.

response - The HTTP response object.

Throws:

IOException - On IO error.

send

public abstract void send(List<io.socket.engineio.parser.Packet<?>> packets)

Send a list of packets over the transport.

Parameters:

packets - List of packets to send.

isWritable

public abstract boolean isWritable()

Checks whether the transport is currently writable.

Returns:

Boolean value indicating if transport can be written to.

getName

public abstract String getName()

Get the name of this transport.

Returns:

Name of transport.

doClose

protected abstract void doClose()

Transport specific logic for closing transport.

close

public void close()

Close the transport if not already closed.

onError

protected void onError(String reason,
                       String description)

Called by child class to indicate error with transport.

Parameters:

reason - Reason of error.

description - Description of error.

onPacket

protected void onPacket(io.socket.engineio.parser.Packet<?> packet)

Called by child to indicate a packet receive from remote client.

Parameters:

packet - Packet received by transport.

onData

protected void onData(Object data)

Called by child to indicate data received from remote client.

Parameters:

data - Encoded data received by transport.

onClose

protected void onClose()

Called by child to indicate closure of transport.