org.opendaylight.yangtools.websocket.client

Class WebSocketIClient

java.lang.Object

org.opendaylight.yangtools.websocket.client.WebSocketIClient

public class WebSocketIClient
extends Object

Implementation of web socket client that supports WS and HTTP protocols.

Constructor Summary

Constructors

Constructor and Description
WebSocketIClient(URI uri, ClientMessageCallback clientMessageCallback) Creates new web socket client

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the connection when the server responds to the CloseWebSocketFrame.
void	connect() Makes the connection attempt and notifies when the handshake process succeeds or fail.
void	ping() Writes PingWebSocketFrame through the ChannelPipeline and request to actual Channel.flush() to flush all pending data to the actual transport.
void	writeAndFlush(Object message) Writes a Object message through the ChannelPipeline and request to actual Channel.flush() to flush all pending data to the actual transport.
void	writeAndFlush(String message) Writes a String message through the ChannelPipeline and request to actual Channel.flush() to flush all pending data to the actual transport.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketIClient

public WebSocketIClient(URI uri,
                ClientMessageCallback clientMessageCallback)

Creates new web socket client

Parameters:

uri - URI

clientMessageCallback - ClientMessageCallback

Method Detail

connect

public void connect()
             throws InterruptedException

Makes the connection attempt and notifies when the handshake process succeeds or fail.

Throws:

InterruptedException

writeAndFlush

public void writeAndFlush(String message)

Writes a String message through the ChannelPipeline and request to actual Channel.flush() to flush all pending data to the actual transport.

Parameters:

message - a message to write

writeAndFlush

public void writeAndFlush(Object message)

Writes a Object message through the ChannelPipeline and request to actual Channel.flush() to flush all pending data to the actual transport.

Parameters:

message - a message to write

ping

public void ping()

Writes PingWebSocketFrame through the ChannelPipeline and request to actual Channel.flush() to flush all pending data to the actual transport.

close

public void close()
           throws InterruptedException

Closes the connection when the server responds to the CloseWebSocketFrame.

Throws:

InterruptedException