io.github.mainstringargs.abstracts.websocket.client

Class AbstractWebsocketClientEndpoint

java.lang.Object

io.github.mainstringargs.abstracts.websocket.client.AbstractWebsocketClientEndpoint

Direct Known Subclasses:

AlpacaWebsocketClientEndpoint, PolygonWebsocketClientEndpoint

public abstract class AbstractWebsocketClientEndpoint
extends java.lang.Object

The type Abstract websocket client endpoint. You must annotate a subclass with ClientEndpoint and the appropriate websocket subprotocols because websocket annotations don't work with inheritance. The subclass must also contain separate methods with the following annotations: OnOpen, OnClose, and OnMessage.

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.
protected void	onClose(javax.websocket.Session userSession, javax.websocket.CloseReason reason) On close.
protected void	onMessage(java.lang.String message) On message.
protected void	onOpen(javax.websocket.Session userSession) On open.
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

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

protected void onOpen(javax.websocket.Session userSession)

On open.

Parameters:

userSession - the user session

onClose

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

On close.

Parameters:

userSession - the user session

reason - the reason

onMessage

protected 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