org.atmosphere.vibe.platform.server

Class AbstractServerWebSocket

java.lang.Object

org.atmosphere.vibe.platform.server.AbstractServerWebSocket

All Implemented Interfaces:

ServerWebSocket, Wrapper

Direct Known Subclasses:

AtmosphereServerWebSocket, JwaServerWebSocket, PlayServerWebSocket, VertxServerWebSocket

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<Void>	closeActions
protected Actions<Throwable>	errorActions
protected Actions<Data>	messageActions

Constructor Summary

Constructors

Constructor and Description
AbstractServerWebSocket()

Method Summary

Methods

Modifier and Type	Method and Description
ServerWebSocket	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	messageAction(Action<Data> action) Attaches an action for the message event.
ServerWebSocket	send(ByteBuffer byteBuffer) Sends bytes message through the connection
ServerWebSocket	send(String data) Sends a text message through the connection.

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.server.ServerWebSocket

uri

Methods inherited from interface org.atmosphere.vibe.platform.Wrapper

unwrap

Field Detail

messageActions

protected final Actions<Data> messageActions

errorActions

protected final Actions<Throwable> errorActions

closeActions

protected final Actions<Void> closeActions

Constructor Detail

AbstractServerWebSocket

public AbstractServerWebSocket()

Method Detail

close

public ServerWebSocket 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 message through the connection.

Specified by:

send in interface ServerWebSocket

send

public ServerWebSocket send(ByteBuffer byteBuffer)

Description copied from interface: ServerWebSocket

Sends bytes message through the connection

Specified by:

send in interface ServerWebSocket

doSend

protected abstract void doSend(ByteBuffer byteBuffer)

doSend

protected abstract void doSend(String data)

messageAction

public ServerWebSocket messageAction(Action<Data> action)

Description copied from interface: ServerWebSocket

Attaches an action for the message event. The allowed message type is String for text messages. If the message is quite big, it may drain memory quickly.

Specified by:

messageAction in interface ServerWebSocket

errorAction

public ServerWebSocket errorAction(Action<Throwable> action)

Description copied from interface: ServerWebSocket

Attaches an action to handle error from various things. If an error occurs, the connection will be closed.

Specified by:

errorAction in interface ServerWebSocket

closeAction

public ServerWebSocket closeAction(Action<Void> action)

Description copied from interface: ServerWebSocket

Attaches an action for the close event. If the connection is already closed, the handler will be executed on addition. After close event, all the other event will be disabled.

Specified by:

closeAction in interface ServerWebSocket