io.github.mainstringargs.abstracts.websocket.client

Class AbstractWebsocketClientEndpoint<T>

java.lang.Object

io.github.mainstringargs.abstracts.websocket.client.AbstractWebsocketClientEndpoint<T>

Type Parameters:

T - the message type parameter

Direct Known Subclasses:

AlpacaWebsocketClientEndpoint, PolygonWebsocketClientEndpoint

public abstract class AbstractWebsocketClientEndpoint<T>
extends java.lang.Object

The type Abstract websocket client endpoint. You must annotate subclasses with ClientEndpoint because websocket annotations don't work with inheritance.

Constructor Summary

Constructors

Constructor and Description
AbstractWebsocketClientEndpoint(WebsocketClient websocketClient, java.net.URI endpointURI, java.lang.String messageThreadName) Instantiates a new Abstract websocket client endpoint.

Method Summary

Modifier and Type	Method and Description
void	connect() Connect.
void	disconnect() Disconnect.
javax.websocket.Session	getUserSession() Gets user session.
void	onClose(javax.websocket.Session userSession, javax.websocket.CloseReason reason) On close.
abstract void	onCloseAnnotated(javax.websocket.Session userSession, javax.websocket.CloseReason reason) On close annotated.
void	onMessage(java.lang.String message) On message.
abstract void	onMessageAnnotated(T message) On message annotated.
void	onOpen(javax.websocket.Session userSession) On open.
abstract void	onOpenAnnotated(javax.websocket.Session userSession) On open annotated.
void	sendMessage(java.lang.String message) Send a message.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractWebsocketClientEndpoint

public AbstractWebsocketClientEndpoint(WebsocketClient websocketClient,
                                       java.net.URI endpointURI,
                                       java.lang.String messageThreadName)

Instantiates a new Abstract websocket client endpoint.

Parameters:

websocketClient - the websocket client

endpointURI - the endpoint uri

messageThreadName - the message thread name

Method Detail

onOpenAnnotated

public abstract void onOpenAnnotated(javax.websocket.Session userSession)

On open annotated. You must annotate this with OnOpen and call onOpen(Session) because websocket annotations don't work with inheritance.

Parameters:

userSession - the user session

onCloseAnnotated

public abstract void onCloseAnnotated(javax.websocket.Session userSession,
                                      javax.websocket.CloseReason reason)

On close annotated. You must annotate this with OnClose and call onClose(Session, CloseReason)} because websocket annotations don't work with inheritance.

Parameters:

userSession - the user session

reason - the reason

onMessageAnnotated

public abstract void onMessageAnnotated(T message)

On message annotated. You must annotate this with OnMessage and call onMessage(String)} because websocket annotations don't work with inheritance.

Parameters:

message - the message

connect

public void connect()
             throws javax.websocket.DeploymentException,
                    java.io.IOException

Connect.

Throws:

javax.websocket.DeploymentException - the deployment exception

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

disconnect

public void disconnect()
                throws java.io.IOException

Disconnect.

Throws:

java.io.IOException - the io exception

onOpen

public void onOpen(javax.websocket.Session userSession)

On open.

Parameters:

userSession - the user session

onClose

public void onClose(javax.websocket.Session userSession,
                    javax.websocket.CloseReason reason)

On close.

Parameters:

userSession - the user session

reason - the reason

onMessage

public void onMessage(java.lang.String message)

On message.

Parameters:

message - the message

sendMessage

public void sendMessage(java.lang.String message)

Send a message.

Parameters:

message - the message

getUserSession

public javax.websocket.Session getUserSession()

Gets user session.

Returns:

the user session