Package io.github.mainstringargs.alpaca.websocket

Class AlpacaWebsocketClientEndpoint

java.lang.Object

io.github.mainstringargs.alpaca.websocket.AlpacaWebsocketClientEndpoint

public class AlpacaWebsocketClientEndpoint
extends java.lang.Object

The Class WebsocketClientEndpoint.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AlpacaWebsocketClientEndpoint.MessageHandler	Message handler.

Constructor Summary

Constructors

Constructor	Description
AlpacaWebsocketClientEndpoint(java.net.URI endpointURI)	Instantiates a new websocket client endpoint.

Method Summary

Modifier and Type	Method	Description
void	addMessageHandler(AlpacaWebsocketClientEndpoint.MessageHandler msgHandler)	register message handler.
javax.websocket.Session	getUserSession()	Gets the user session.
void	onClose(javax.websocket.Session userSession, javax.websocket.CloseReason reason)	Callback hook for Connection close events.
void	onMessage(byte[] message)	Callback hook for Message Events.
void	onOpen(javax.websocket.Session userSession)	Callback hook for Connection open events.
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

AlpacaWebsocketClientEndpoint

public AlpacaWebsocketClientEndpoint(java.net.URI endpointURI)

Instantiates a new websocket client endpoint.

Parameters:

endpointURI - the endpoint URI

Method Detail

onOpen

public void onOpen(javax.websocket.Session userSession)

Callback hook for Connection open events.

Parameters:

userSession - the userSession which is opened.

onClose

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

Callback hook for Connection close events.

Parameters:

userSession - the userSession which is getting closed.

reason - the reason for connection close

onMessage

public void onMessage(byte[] message)

Callback hook for Message Events. This method will be invoked when a client send a message.

Parameters:

message - The text message

addMessageHandler

public void addMessageHandler(AlpacaWebsocketClientEndpoint.MessageHandler msgHandler)

register message handler.

Parameters:

msgHandler - the msg handler

sendMessage

public void sendMessage(java.lang.String message)

Send a message.

Parameters:

message - the message

getUserSession

public javax.websocket.Session getUserSession()

Gets the user session.

Returns:

the user session