org.atmosphere.vibe.transport

Interface ServerTransport

All Known Implementing Classes:

BaseServerTransport

public interface ServerTransport

Represents a server-side full duplex message channel ensuring there is no message loss and no idle connection.

Implementations are thread safe.

Author:

Donghwan Kim

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the connection.
ServerTransport	closeAction(Action<Void> action) Attaches an action for the close event.
ServerTransport	errorAction(Action<Throwable> action) Executed if there was any error on the connection.
ServerTransport	send(String data) Sends a text message through the connection.
ServerTransport	textAction(Action<String> action) Attaches an action for the text message.
<T> T	unwrap(Class<T> clazz) Returns the underlying component.
String	uri() A URI used to connect.

Method Detail

uri

String uri()

A URI used to connect. To work with URI parts, use URI or something like that.

errorAction

ServerTransport errorAction(Action<Throwable> action)

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

textAction

ServerTransport textAction(Action<String> action)

Attaches an action for the text message.

send

ServerTransport send(String data)

Sends a text message through the connection.

closeAction

ServerTransport closeAction(Action<Void> action)

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

close

void close()

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

unwrap

<T> T unwrap(Class<T> clazz)

Returns the underlying component.