eu.luminis.websocket

Class WebSocketClient

java.lang.Object

eu.luminis.websocket.WebSocketClient

public class WebSocketClient
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebSocketClient.HttpResult

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CONNECT_TIMEOUT
static int	DEFAULT_READ_TIMEOUT
static Set<String>	UPGRADE_HEADERS

Constructor Summary

Constructors

Constructor and Description
WebSocketClient(URL wsURL)

Method Summary

Modifier and Type	Method and Description
protected Map<String,String>	checkServerResponse(InputStream inputStream, String nonce)
CloseFrame	close(int status, String requestData, int readTimeout) Close the websocket connection properly, i.e.
WebSocketClient.HttpResult	connect()
WebSocketClient.HttpResult	connect(int connectTimeout, int readTimeout)
WebSocketClient.HttpResult	connect(Map<String,String> headers)
WebSocketClient.HttpResult	connect(Map<String,String> headers, int connectTimeout, int readTimeout)
protected Socket	createSocket(String host, int port, int connectTimeout, int readTimeout)
void	dispose()
void	finalize()
URL	getConnectUrl()
boolean	isConnected()
BinaryFrame	receiveBinaryData(int timeout)
CloseFrame	receiveClose(int timeout)
Frame	receiveFrame(int readTimeout)
PongFrame	receivePong(int timeout)
TextFrame	receiveText(int timeout)
BinaryFrame	sendBinaryFrame(byte[] requestData)
Frame	sendClose(int closeStatus, String reason)
Frame	sendPingFrame()
Frame	sendPingFrame(byte[] applicationData)
Frame	sendPongFrame()
Frame	sendPongFrame(byte[] applicationData)
TextFrame	sendTextFrame(String requestData)
void	setAdditionalUpgradeRequestHeaders(Map<String,String> additionalHeaders)
void	useProxy(String host, int port, String user, String password)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONNECT_TIMEOUT

public static final int DEFAULT_CONNECT_TIMEOUT

See Also:

Constant Field Values

DEFAULT_READ_TIMEOUT

public static final int DEFAULT_READ_TIMEOUT

See Also:

Constant Field Values

UPGRADE_HEADERS

public static Set<String> UPGRADE_HEADERS

Constructor Detail

WebSocketClient

public WebSocketClient(URL wsURL)

Method Detail

getConnectUrl

public URL getConnectUrl()

setAdditionalUpgradeRequestHeaders

public void setAdditionalUpgradeRequestHeaders(Map<String,String> additionalHeaders)

useProxy

public void useProxy(String host,
                     int port,
                     String user,
                     String password)

connect

public WebSocketClient.HttpResult connect()
                                   throws IOException,
                                          HttpException

Throws:

IOException

HttpException

connect

public WebSocketClient.HttpResult connect(int connectTimeout,
                                          int readTimeout)
                                   throws IOException,
                                          HttpException

Throws:

IOException

HttpException

connect

public WebSocketClient.HttpResult connect(Map<String,String> headers)
                                   throws IOException,
                                          HttpException

Throws:

IOException

HttpException

connect

public WebSocketClient.HttpResult connect(Map<String,String> headers,
                                          int connectTimeout,
                                          int readTimeout)
                                   throws IOException,
                                          HttpException

Throws:

IOException

HttpException

isConnected

public boolean isConnected()

createSocket

protected Socket createSocket(String host,
                              int port,
                              int connectTimeout,
                              int readTimeout)
                       throws IOException

Throws:

IOException

dispose

public void dispose()

finalize

public void finalize()

Overrides:

finalize in class Object

close

public CloseFrame close(int status,
                        String requestData,
                        int readTimeout)
                 throws IOException,
                        UnexpectedFrameException

Close the websocket connection properly, i.e. send a close frame and wait for a close confirm.

Parameters:

status - the status to send in the close frame

requestData - the close reason to send as part of the close frame

readTimeout - read timeout used when reading close response

Returns:

the close frame received as response from the server

Throws:

IOException - when an IO exception occurs on the underlying connection

UnexpectedFrameException - when a frame is received that is not a close frame

sendTextFrame

public TextFrame sendTextFrame(String requestData)
                        throws IOException

Throws:

IOException

sendBinaryFrame

public BinaryFrame sendBinaryFrame(byte[] requestData)
                            throws IOException

Throws:

IOException

sendPingFrame

public Frame sendPingFrame()
                    throws IOException

Throws:

IOException

sendPingFrame

public Frame sendPingFrame(byte[] applicationData)
                    throws IOException

Throws:

IOException

sendPongFrame

public Frame sendPongFrame()
                    throws IOException

Throws:

IOException

sendPongFrame

public Frame sendPongFrame(byte[] applicationData)
                    throws IOException

Throws:

IOException

sendClose

public Frame sendClose(int closeStatus,
                       String reason)
                throws IOException

Throws:

IOException

receiveClose

public CloseFrame receiveClose(int timeout)
                        throws IOException,
                               UnexpectedFrameException

Throws:

IOException

UnexpectedFrameException

receiveFrame

public Frame receiveFrame(int readTimeout)
                   throws IOException

Throws:

IOException

receiveText

public TextFrame receiveText(int timeout)
                      throws IOException,
                             UnexpectedFrameException

Throws:

IOException

UnexpectedFrameException

receiveBinaryData

public BinaryFrame receiveBinaryData(int timeout)
                              throws IOException,
                                     UnexpectedFrameException

Throws:

IOException

UnexpectedFrameException

receivePong

public PongFrame receivePong(int timeout)
                      throws IOException,
                             UnexpectedFrameException

Throws:

IOException

UnexpectedFrameException

checkServerResponse

protected Map<String,String> checkServerResponse(InputStream inputStream,
                                                 String nonce)
                                          throws IOException

Throws:

IOException