io.socket
Class WebsocketTransport

java.lang.Object
  io.socket.WebsocketTransport

All Implemented Interfaces:

de.roderick.weberknecht.WebSocketEventHandler, IOTransport

 class WebsocketTransport
extends java.lang.Object
implements IOTransport, de.roderick.weberknecht.WebSocketEventHandler

The Class WebsocketTransport.

Field Summary

static java.lang.String	TRANSPORT_NAME The String to identify this Transport
(package private) de.roderick.weberknecht.WebSocketConnection	websocket

Constructor Summary

WebsocketTransport(java.net.URI uri, IOConnection connection)
Instantiates a new websocket transport.

Method Summary

boolean	canSendBulk() return true if the IOTransport prefers to send multiple messages at a time.
void	connect() Instructs the IOTransport to connect.
static IOTransport	create(java.net.URL url, IOConnection connection) Creates a new Transport for the given url an IOConnection.
void	disconnect() Instructs the IOTransport to disconnect.
java.lang.String	getName()
void	invalidate() Instructs the IOTransport to invalidate.
void	onClose()
void	onMessage(de.roderick.weberknecht.WebSocketMessage arg0)
void	onOpen()
void	send(java.lang.String text) Instructs the IOTransport to send a Message
void	sendBulk(java.lang.String[] texts) Instructs the IOTransport to send multiple messages.

Methods inherited from class java.lang.Object

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

Field Detail

websocket

de.roderick.weberknecht.WebSocketConnection websocket

TRANSPORT_NAME

public static final java.lang.String TRANSPORT_NAME

The String to identify this Transport

See Also:

Constant Field Values

Constructor Detail

WebsocketTransport

public WebsocketTransport(java.net.URI uri,
                          IOConnection connection)

Instantiates a new websocket transport.

Parameters:

uri - the uri

connection - the connection

Throws:

de.roderick.weberknecht.WebSocketException

Method Detail

create

public static IOTransport create(java.net.URL url,
                                 IOConnection connection)

Creates a new Transport for the given url an IOConnection.

Parameters:

url - the url

connection - the connection

Returns:

the iO transport

disconnect

public void disconnect()

Description copied from interface: IOTransport

Instructs the IOTransport to disconnect.

Specified by:

disconnect in interface IOTransport

canSendBulk

public boolean canSendBulk()

Description copied from interface: IOTransport

return true if the IOTransport prefers to send multiple messages at a time.

Specified by:

canSendBulk in interface IOTransport

Returns:

true, if successful

sendBulk

public void sendBulk(java.lang.String[] texts)
              throws java.io.IOException

Description copied from interface: IOTransport

Instructs the IOTransport to send multiple messages. This is only called when canSendBulk returns true.

Specified by:

sendBulk in interface IOTransport

Parameters:

texts - the texts

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

invalidate

public void invalidate()

Description copied from interface: IOTransport

Instructs the IOTransport to invalidate. DO NOT DISCONNECT from the server. just make sure, that events are not populated to the IOConnection

Specified by:

invalidate in interface IOTransport

onClose

public void onClose()

Specified by:

onClose in interface de.roderick.weberknecht.WebSocketEventHandler

onMessage

public void onMessage(de.roderick.weberknecht.WebSocketMessage arg0)

Specified by:

onMessage in interface de.roderick.weberknecht.WebSocketEventHandler

onOpen

public void onOpen()

Specified by:

onOpen in interface de.roderick.weberknecht.WebSocketEventHandler

connect

public void connect()

Description copied from interface: IOTransport

Instructs the IOTransport to connect.

Specified by:

connect in interface IOTransport

send

public void send(java.lang.String text)
          throws java.lang.Exception

Description copied from interface: IOTransport

Instructs the IOTransport to send a Message

Specified by:

send in interface IOTransport

Parameters:

text - the text to be sent

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

java.lang.Exception

getName

public java.lang.String getName()

Specified by:

getName in interface IOTransport