Module uk.oczadly.karl.jnano

Package uk.oczadly.karl.jnano.websocket

Class Topic<M>

java.lang.Object

uk.oczadly.karl.jnano.websocket.Topic<M>

Direct Known Subclasses:

TopicActiveDifficulty, TopicBootstrap, TopicConfirmation, TopicStoppedElection, TopicTelemetry, TopicUnconfirmedBlocks, TopicVote, TopicWork

public class Topic<M>
extends Object

Constructor Summary

Constructors

Constructor	Description
Topic(String topicName, NanoWebSocketClient client, Class<M> classMessage)

Method Summary

Modifier and Type	Method	Description
protected void	_subscribe(Object options)
protected boolean	_subscribeBlocking(long timeout, Object options)
protected void	_update(Object options)
protected boolean	_updateBlocking(long timeout, Object options)
protected com.google.gson.JsonObject	createJson(String action)	Creates a template JsonObject for building requests.
protected com.google.gson.JsonObject	createJson(String action, Object options)	Creates a template JsonObject for building requests.
boolean	deregisterListener(TopicListener<M> listener)	De-registers a listener for this topic.
protected NanoWebSocketClient	getClient()
List<TopicListener<M>>	getListeners()
Class<M>	getMessageClass()
String	getTopicName()
void	registerListener(TopicListener<M> listener)	Registers a new listener for this topic.
void	subscribe()	Subscribe to this topic without any options or configurations.
boolean	subscribeBlocking()	Subscribe to this topic without any options or configurations.
boolean	subscribeBlocking(long timeout)	Subscribe to this topic without any options or configurations.
void	unsubscribe()	Unsubscribes from this topic without any options or configurations.
boolean	unsubscribeBlocking()	Unsubscribes from this topic without any options or configurations.
boolean	unsubscribeBlocking(long timeout)	Unsubscribes from this topic without any options or configurations.

Methods inherited from class java.lang.Object

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

Constructor Detail

Topic

public Topic(String topicName,
             NanoWebSocketClient client,
             Class<M> classMessage)

Method Detail

getTopicName

public final String getTopicName()

Returns:

the name of the topic

getMessageClass

public final Class<M> getMessageClass()

Returns:

the class type which is used to represent messages for this topic

getClient

protected final NanoWebSocketClient getClient()

Returns:

the client which handles this topic

registerListener

public final void registerListener(TopicListener<M> listener)

Registers a new listener for this topic.

Parameters:

listener - the listener to register

deregisterListener

public final boolean deregisterListener(TopicListener<M> listener)

De-registers a listener for this topic.

Parameters:

listener - the listener to remove

Returns:

true if the listener was removed

getListeners

public final List<TopicListener<M>> getListeners()

Returns:

a list of objects listening to this topic

subscribe

public final void subscribe()

Subscribe to this topic without any options or configurations. The underlying WebSocket must be open before you call this method.

This method will process asynchronously and will not block the thread or verify completion.

Throws:

IllegalStateException - if the WebSocket is not currently open

subscribeBlocking

public final boolean subscribeBlocking()
                                throws InterruptedException

Subscribe to this topic without any options or configurations. The underlying WebSocket must be open before you call this method.

This method will block indefinitely and wait for the associated acknowledgement message to be received before continuing and returning true, false if the WebSocket closed, or throw an InterruptedException if the thread is interrupted.

Returns:

true if the action completed successfully, false if the WS is closed

Throws:

IllegalStateException - if the WebSocket is not currently open

InterruptedException - if the thread is interrupted

subscribeBlocking

public final boolean subscribeBlocking(long timeout)
                                throws InterruptedException

Subscribe to this topic without any options or configurations. The underlying WebSocket must be open before you call this method.

This method will block indefinitely and wait for the associated acknowledgement message to be received before continuing and returning true, false if the WebSocket closed, or throw an InterruptedException if the thread is interrupted.

Returns:

true if the action completed successfully, false if the WS is closed

Throws:

IllegalStateException - if the WebSocket is not currently open

InterruptedException - if the thread is interrupted

unsubscribe

public final void unsubscribe()

Unsubscribes from this topic without any options or configurations. The underlying WebSocket must be open before you call this method.

This method will process asynchronously and will not block the thread or verify completion.

Throws:

IllegalStateException - if the WebSocket is not currently open

unsubscribeBlocking

public final boolean unsubscribeBlocking()
                                  throws InterruptedException

Unsubscribes from this topic without any options or configurations. The underlying WebSocket must be open before you call this method.

This method will block indefinitely and wait for the associated acknowledgement message to be received before continuing and returning true, false if the WebSocket closed, or throw an InterruptedException if the thread is interrupted.

Returns:

true if the action completed successfully, false if the WS is closed

Throws:

IllegalStateException - if the WebSocket is not currently open

InterruptedException - if the thread is interrupted

unsubscribeBlocking

public final boolean unsubscribeBlocking(long timeout)
                                  throws InterruptedException

Unsubscribes from this topic without any options or configurations. The underlying WebSocket must be open before you call this method.

This method will block and wait for the associated acknowledgement message to be received before continuing and returning true, false if the WebSocket closed or the timeout period expires, or throw an InterruptedException if the thread is interrupted.

Parameters:

timeout - the timeout in milliseconds, or zero for no timeout

Returns:

true if the action completed successfully, false if the WS is closed or the timeout expires

Throws:

IllegalStateException - if the WebSocket is not currently open

InterruptedException - if the thread is interrupted

_subscribe

protected final void _subscribe(Object options)

_subscribeBlocking

protected final boolean _subscribeBlocking(long timeout,
                                           Object options)
                                    throws InterruptedException

Throws:

InterruptedException

_update

protected final void _update(Object options)

_updateBlocking

protected final boolean _updateBlocking(long timeout,
                                        Object options)
                                 throws InterruptedException

Throws:

InterruptedException

createJson

protected final com.google.gson.JsonObject createJson(String action)

Creates a template JsonObject for building requests.

Parameters:

action - the action of the request

Returns:

the json object

createJson

protected final com.google.gson.JsonObject createJson(String action,
                                                      Object options)

Creates a template JsonObject for building requests.

Parameters:

action - the action of the request

options - an object containing a set of serializable options

Returns:

the json object