org.atmosphere.vibe.transport

Class BaseServerTransport

java.lang.Object

org.atmosphere.vibe.transport.BaseServerTransport

All Implemented Interfaces:

ServerTransport

Direct Known Subclasses:

BaseHttpServerTransport, WebSocketServerTransport

public abstract class BaseServerTransport
extends Object
implements ServerTransport

Base class for ServerTransport.

Author:

Donghwan Kim

Field Summary

Fields

Modifier and Type	Field and Description
protected org.atmosphere.vibe.platform.action.Actions<Void>	closeActions
protected org.atmosphere.vibe.platform.action.Actions<Throwable>	errorActions
protected org.atmosphere.vibe.platform.action.Actions<String>	textActions

Constructor Summary

Constructors

Constructor and Description
BaseServerTransport()

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the connection.
ServerTransport	closeAction(org.atmosphere.vibe.platform.action.Action<Void> action) Attaches an action for the close event.
protected abstract void	doClose()
protected abstract void	doSend(String data)
ServerTransport	errorAction(org.atmosphere.vibe.platform.action.Action<Throwable> action) Executed if there was any error on the connection.
BaseServerTransport	send(String data) Sends a text message through the connection.
ServerTransport	textAction(org.atmosphere.vibe.platform.action.Action<String> action) Attaches an action for the text message.

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.transport.ServerTransport

unwrap, uri

Field Detail

textActions

protected org.atmosphere.vibe.platform.action.Actions<String> textActions

errorActions

protected org.atmosphere.vibe.platform.action.Actions<Throwable> errorActions

closeActions

protected org.atmosphere.vibe.platform.action.Actions<Void> closeActions

Constructor Detail

BaseServerTransport

public BaseServerTransport()

Method Detail

textAction

public ServerTransport textAction(org.atmosphere.vibe.platform.action.Action<String> action)

Description copied from interface: ServerTransport

Attaches an action for the text message.

Specified by:

textAction in interface ServerTransport

send

public BaseServerTransport send(String data)

Description copied from interface: ServerTransport

Sends a text message through the connection.

Specified by:

send in interface ServerTransport

doSend

protected abstract void doSend(String data)

errorAction

public ServerTransport errorAction(org.atmosphere.vibe.platform.action.Action<Throwable> action)

Description copied from interface: ServerTransport

Executed if there was any error on the connection. You don't need to close it explicitly.

Specified by:

errorAction in interface ServerTransport

closeAction

public ServerTransport closeAction(org.atmosphere.vibe.platform.action.Action<Void> action)

Description copied from interface: ServerTransport

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 ServerTransport

close

public void close()

Description copied from interface: ServerTransport

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

Specified by:

close in interface ServerTransport

doClose

protected abstract void doClose()