org.kurento.jsonrpc.client

Class AbstractJsonRpcClientWebSocket

java.lang.Object

org.kurento.jsonrpc.client.JsonRpcClient

org.kurento.jsonrpc.client.AbstractJsonRpcClientWebSocket

All Implemented Interfaces:

Closeable, AutoCloseable, JsonRpcRequestSender

Direct Known Subclasses:

JsonRpcClientNettyWebSocket

public abstract class AbstractJsonRpcClientWebSocket
extends JsonRpcClient

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	maxPacketSize
protected static long	RECONNECT_DELAY_TIME_MILLIS
protected URI	uri

Fields inherited from class org.kurento.jsonrpc.client.JsonRpcClient

closedByClient, connectionTimeout, handlerManager, heartbeating, heartbeatInterval, idleTimeout, label, registerInfo, rsHelper, session

Constructor Summary

Constructors

Constructor and Description
AbstractJsonRpcClientWebSocket(String url, JsonRpcWSConnectionListener connectionListener)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes this client.
protected void	closeClient(String reason)
protected abstract void	closeNativeClient()
protected void	closeWithReconnection()
void	connect()
protected void	connectIfNecessary()
protected abstract void	connectNativeClient()
void	connectWithSession()
protected void	createExecServiceIfNecessary()
protected void	fireConnected()
protected void	fireConnectionFailed()
protected void	fireDisconnected()
protected void	fireReconnectedNewServer()
protected void	fireReconnectedSameServer()
protected void	fireReconnecting()
long	getRequestTimeout()
protected void	handleReconnectDisconnection(int statusCode, String closeReason)
protected void	handleResponseFromServer(com.google.gson.JsonObject message)
protected void	internalConnectIfNecessary()
protected <P> void	internalSendRequestWebSocket(Request<P> request, Class<com.google.gson.JsonElement> resultClass, Continuation<Response<com.google.gson.JsonElement>> continuation)
protected <P,R> Response<R>	internalSendRequestWebSocket(Request<P> request, Class<R> resultClass)
boolean	isConcurrentServerRequest()
protected abstract boolean	isNativeClientConnected()
boolean	isSendCloseMessage()
boolean	isTryReconnectingForever()
void	onConnected(Handler connectedHandler)
void	onConnectionFailed(Handler connectionFailedHandler)
void	onDisconnected(Handler disconnectedHandler)
void	onReconnected(ReconnectedHandler reconnectedHandler)
void	onReconnecting(Handler reconnectingHandler)
protected void	receivedTextMessage(String message)
protected abstract void	sendTextMessage(String jsonMessage)
void	setConcurrentServerRequest(boolean concurrentServerRequest) Configures how requests from server have to be processed.
void	setRequestTimeout(long timeout) Configures the request timeout in this client.
void	setSendCloseMessage(boolean sendCloseMessage) Configures if this client should send a close message to server when close() method is invoked.
void	setTryReconnectingForever(boolean tryReconnectingForever)
void	setTryReconnectingMaxTime(long tryReconnectingMaxTime)

Methods inherited from class org.kurento.jsonrpc.client.JsonRpcClient

disableHeartbeat, disableHeartbeat, enableHeartbeat, enableHeartbeat, getConnectionTimeout, getHeartbeatInterval, getIdleTimeout, getSession, isClosedByUser, sendNotification, sendNotification, sendNotification, sendRequest, sendRequest, sendRequest, sendRequest, sendRequest, sendRequest, sendRequest, sendRequestHonorId, sendRequestHonorId, setConnectionTimeout, setHeartbeatInterval, setIdleTimeout, setLabel, setServerRequestHandler, setSessionId

Methods inherited from class java.lang.Object

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

Field Detail

RECONNECT_DELAY_TIME_MILLIS

protected static final long RECONNECT_DELAY_TIME_MILLIS

See Also:

Constant Field Values

maxPacketSize

protected static final int maxPacketSize

uri

protected URI uri

Constructor Detail

AbstractJsonRpcClientWebSocket

public AbstractJsonRpcClientWebSocket(String url,
                              JsonRpcWSConnectionListener connectionListener)

Method Detail

setRequestTimeout

public void setRequestTimeout(long timeout)

Configures the request timeout in this client. If a request doesn't receive a response before this time (in millis), a TransportException will be thrown.

Specified by:

setRequestTimeout in class JsonRpcClient

getRequestTimeout

public long getRequestTimeout()

setSendCloseMessage

public void setSendCloseMessage(boolean sendCloseMessage)

Configures if this client should send a close message to server when close() method is invoked. This close message is used to inform the server that client explicitly closed the connection. By default sendCloseMessage is false.

Parameters:

sendCloseMessage -

isSendCloseMessage

public boolean isSendCloseMessage()

setTryReconnectingForever

public void setTryReconnectingForever(boolean tryReconnectingForever)

isTryReconnectingForever

public boolean isTryReconnectingForever()

setConcurrentServerRequest

public void setConcurrentServerRequest(boolean concurrentServerRequest)

Configures how requests from server have to be processed. If concurrentServerRequest is true, then a executor service with several threads is used to execute the handler of the request. If concurrentServerRequest is false, the websocket library thread is used to execute the handler. In the current implementation (using Jetty as websocket client), this means that handler is executed sequentially. That is problematic if a synchronous request in sent to server in a handler because a deadlock is produced. By default, concurrentServerRequest is true.

Parameters:

concurrentServerRequest -

isConcurrentServerRequest

public boolean isConcurrentServerRequest()

fireReconnectedNewServer

protected void fireReconnectedNewServer()

fireReconnectedSameServer

protected void fireReconnectedSameServer()

fireConnectionFailed

protected void fireConnectionFailed()

fireConnected

protected void fireConnected()

fireReconnecting

protected void fireReconnecting()

fireDisconnected

protected void fireDisconnected()

createExecServiceIfNecessary

protected void createExecServiceIfNecessary()

internalSendRequestWebSocket

protected <P,R> Response<R> internalSendRequestWebSocket(Request<P> request,
                                             Class<R> resultClass)
                                            throws IOException

Throws:

IOException

internalSendRequestWebSocket

protected <P> void internalSendRequestWebSocket(Request<P> request,
                                    Class<com.google.gson.JsonElement> resultClass,
                                    Continuation<Response<com.google.gson.JsonElement>> continuation)

close

public void close()
           throws IOException

Description copied from class: JsonRpcClient

Closes this client. This method disables the heartbeat mechanism Once a client has been closed, it is not available for further networking use (i.e. can't be reconnected or rebound). A new client needs to be created.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class JsonRpcClient

Throws:

IOException - if an I/O error occurs when closing this client.

See Also:

#isClosed

closeClient

protected void closeClient(String reason)

handleResponseFromServer

protected void handleResponseFromServer(com.google.gson.JsonObject message)

receivedTextMessage

protected void receivedTextMessage(String message)

handleReconnectDisconnection

protected void handleReconnectDisconnection(int statusCode,
                                String closeReason)

closeWithReconnection

protected void closeWithReconnection()

Overrides:

closeWithReconnection in class JsonRpcClient

connect

public void connect()
             throws IOException

Specified by:

connect in class JsonRpcClient

Throws:

IOException

connectWithSession

public void connectWithSession()
                        throws IOException

Throws:

IOException

internalConnectIfNecessary

protected void internalConnectIfNecessary()
                                   throws IOException

Throws:

IOException

connectIfNecessary

protected void connectIfNecessary()
                           throws IOException

Throws:

IOException

onConnected

public void onConnected(Handler connectedHandler)

onConnectionFailed

public void onConnectionFailed(Handler connectionFailedHandler)

onDisconnected

public void onDisconnected(Handler disconnectedHandler)

onReconnecting

public void onReconnecting(Handler reconnectingHandler)

onReconnected

public void onReconnected(ReconnectedHandler reconnectedHandler)

setTryReconnectingMaxTime

public void setTryReconnectingMaxTime(long tryReconnectingMaxTime)

sendTextMessage

protected abstract void sendTextMessage(String jsonMessage)
                                 throws IOException

Throws:

IOException

closeNativeClient

protected abstract void closeNativeClient()

isNativeClientConnected

protected abstract boolean isNativeClientConnected()

connectNativeClient

protected abstract void connectNativeClient()
                                     throws TimeoutException,
                                            Exception

Throws:

TimeoutException

Exception