org.atmosphere.vibe.platform.ws

Class AbstractServerWebSocket

java.lang.Object

org.atmosphere.vibe.platform.ws.AbstractServerWebSocket

All Implemented Interfaces:

ServerWebSocket

public abstract class AbstractServerWebSocket
extends Object
implements ServerWebSocket

Abstract base class for ServerWebSocket.

Author:

Donghwan Kim

Field Summary

Fields

Modifier and Type	Field and Description
protected Actions<ByteBuffer>	binaryActions
protected Actions<Void>	closeActions
protected Actions<Throwable>	errorActions
protected Actions<String>	textActions

Constructor Summary

Constructors

Constructor and Description
AbstractServerWebSocket()

Method Summary

Methods

Modifier and Type	Method and Description
ServerWebSocket	binaryAction(Action<ByteBuffer> action) Attaches an action for the binary frame.
void	close() Closes the connection.
ServerWebSocket	closeAction(Action<Void> action) Attaches an action for the close event.
protected abstract void	doClose()
protected abstract void	doSend(ByteBuffer byteBuffer)
protected abstract void	doSend(String data)
ServerWebSocket	errorAction(Action<Throwable> action) Attaches an action to handle error from various things.
ServerWebSocket	send(ByteBuffer byteBuffer) Sends a binary frame through the connection.
ServerWebSocket	send(String data) Sends a text frame through the connection.
ServerWebSocket	textAction(Action<String> action) Attaches an action for the text frame.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.atmosphere.vibe.platform.ws.ServerWebSocket

unwrap, uri

Field Detail

textActions

protected final Actions<String> textActions

binaryActions

protected final Actions<ByteBuffer> binaryActions

errorActions

protected final Actions<Throwable> errorActions

closeActions

protected final Actions<Void> closeActions

Constructor Detail

AbstractServerWebSocket

public AbstractServerWebSocket()

Method Detail

close

public void close()

Description copied from interface: ServerWebSocket

Closes the connection. This method has no side effect if called more than once.

Specified by:

close in interface ServerWebSocket

doClose

protected abstract void doClose()

send

public ServerWebSocket send(String data)

Description copied from interface: ServerWebSocket

Sends a text frame through the connection.

Specified by:

send in interface ServerWebSocket

send

public ServerWebSocket send(ByteBuffer byteBuffer)

Description copied from interface: ServerWebSocket

Sends a binary frame through the connection.

Specified by:

send in interface ServerWebSocket

doSend

protected abstract void doSend(ByteBuffer byteBuffer)

doSend

protected abstract void doSend(String data)

textAction

public ServerWebSocket textAction(Action<String> action)

Description copied from interface: ServerWebSocket

Attaches an action for the text frame.

Specified by:

textAction in interface ServerWebSocket

binaryAction

public ServerWebSocket binaryAction(Action<ByteBuffer> action)

Description copied from interface: ServerWebSocket

Attaches an action for the binary frame.

Specified by:

binaryAction in interface ServerWebSocket

closeAction

public ServerWebSocket closeAction(Action<Void> action)

Description copied from interface: ServerWebSocket

Attaches an action for the close event. After this event, the instance shouldn't be used and all the other events will be disabled.

Specified by:

closeAction in interface ServerWebSocket

errorAction

public ServerWebSocket errorAction(Action<Throwable> action)

Description copied from interface: ServerWebSocket

Attaches an action to handle error from various things. Its exact behavior is platform-specific and error created by the platform is propagated.

Specified by:

errorAction in interface ServerWebSocket