com.mixer.interactive.ws

Class InteractiveWebSocketClient

java.lang.Object

org.java_websocket.WebSocketAdapter

org.java_websocket.AbstractWebSocket

org.java_websocket.client.WebSocketClient

com.mixer.interactive.ws.InteractiveWebSocketClient

All Implemented Interfaces:

Runnable, org.java_websocket.WebSocket, org.java_websocket.WebSocketListener

public class InteractiveWebSocketClient
extends org.java_websocket.client.WebSocketClient

A websocket client designed specifically for use with the Interactive service. Messages received are posted to the GameClient that owns this connection. Messages sent/received to/from the Interactive service are sent in the current compression scheme set for the client.

Since:

1.0.0

Author:

Microsoft Corporation

Nested Class Summary

Nested classes/interfaces inherited from interface org.java_websocket.WebSocket

org.java_websocket.WebSocket.READYSTATE, org.java_websocket.WebSocket.Role

Field Summary

Fields inherited from class org.java_websocket.client.WebSocketClient

uri

Fields inherited from interface org.java_websocket.WebSocket

DEFAULT_PORT, DEFAULT_WSS_PORT

Constructor Summary

Constructors

Constructor and Description
InteractiveWebSocketClient(GameClient gameClient, URI uri, String token, Number projectVersionId) Initialize a new InteractiveWebSocketClient.
InteractiveWebSocketClient(GameClient gameClient, URI uri, String token, Number projectVersionId, String shareCode) Initialize a new InteractiveWebSocketClient.

Method Summary

Modifier and Type	Method and Description
int	claimNextPacketId() Retrieves the next available packet id, then increments the internal counter to reflect that the previous id has now been allocated.
CompressionScheme	getCompressionScheme() Retrieves the CompressionScheme this InteractiveWebSocketClient is using.
CompletableFuture<Boolean>	getConnectionPromise() Returns the CompletableFuture promise holding the result of a connection attempt using this websocket client.
int	getLastSequenceNumber() Returns the sequence number that the socket has last seen from the service.
ConcurrentMap<Integer,CompletableFuture<ReplyPacket>>	getWaitingFuturesMap() Retrieves the ConcurrentMap of waiting CompletableFuture promises and the IDs for the packets that made the request.
void	onClose(int code, String reason, boolean closedRemotely)
void	onError(Exception ex)
void	onMessage(ByteBuffer bytes)
void	onMessage(String message)
void	onOpen(org.java_websocket.handshake.ServerHandshake serverHandshake)
void	send(String message)
void	setCompressionScheme(CompressionScheme compressionScheme) Sets the CompressionScheme that this InteractiveWebSocketClient will use.
void	setCompressionScheme(String compressionScheme) Sets the CompressionScheme that this InteractiveWebSocketClient will use.
CompletableFuture<Boolean>	setConnectionPromise(CompletableFuture<Boolean> connectionPromise) Sets the CompletableFuture promise holding the result of a connection attempt using this websocket client.

Methods inherited from class org.java_websocket.client.WebSocketClient

close, close, close, closeBlocking, closeConnection, connect, connectBlocking, connections, getConnection, getDraft, getLocalSocketAddress, getLocalSocketAddress, getReadyState, getRemoteSocketAddress, getRemoteSocketAddress, getResourceDescriptor, getSocket, getURI, hasBufferedData, isClosed, isClosing, isConnecting, isFlushAndClose, isOpen, onCloseInitiated, onClosing, onFragment, onWebsocketClose, onWebsocketCloseInitiated, onWebsocketClosing, onWebsocketError, onWebsocketMessage, onWebsocketMessage, onWebsocketMessageFragment, onWebsocketOpen, onWriteDemand, run, send, send, sendFragmentedFrame, sendFrame, sendPing, setProxy, setSocket

Methods inherited from class org.java_websocket.AbstractWebSocket

getConnectionLostTimeout, isTcpNoDelay, setConnectionLostTimeout, setTcpNoDelay, startConnectionLostTimer, stopConnectionLostTimer

Methods inherited from class org.java_websocket.WebSocketAdapter

getFlashPolicy, onWebsocketHandshakeReceivedAsClient, onWebsocketHandshakeReceivedAsServer, onWebsocketHandshakeSentAsClient, onWebsocketPing, onWebsocketPong

Methods inherited from class java.lang.Object

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

Constructor Detail

InteractiveWebSocketClient

public InteractiveWebSocketClient(GameClient gameClient,
                                  URI uri,
                                  String token,
                                  Number projectVersionId)

Initialize a new InteractiveWebSocketClient.

Parameters:

gameClient - The GameClient that owns this websocket client

uri - The URI address for the InteractiveHost to connect to

token - Authorization token. Can be either an OAuth Bearer token or a xtoken

projectVersionId - The project version ID for the Interactive integration to connect to

Since:

1.0.0

InteractiveWebSocketClient

public InteractiveWebSocketClient(GameClient gameClient,
                                  URI uri,
                                  String token,
                                  Number projectVersionId,
                                  String shareCode)

Initialize a new InteractiveWebSocketClient.

Parameters:

gameClient - The GameClient that owns this websocket client

uri - The URI address for the InteractiveHost to connect to

token - Authorization token. Can be either an OAuth Bearer token or a xtoken

projectVersionId - The project version ID for the Interactive integration to connect to

shareCode - The share code provided by the author of the Interactive integration

Since:

1.0.0

Method Detail

getWaitingFuturesMap

public ConcurrentMap<Integer,CompletableFuture<ReplyPacket>> getWaitingFuturesMap()

Retrieves the ConcurrentMap of waiting CompletableFuture promises and the IDs for the packets that made the request.

Returns:

ConcurrentMap of waiting CompletableFuture promises and the IDs for the packets that made the request

Since:

2.0.0

getConnectionPromise

public CompletableFuture<Boolean> getConnectionPromise()

Returns the CompletableFuture promise holding the result of a connection attempt using this websocket client.

Returns:

The CompletableFuture promise holding the result of a connection attempt using this websocket client.

Since:

2.1.0

setConnectionPromise

public CompletableFuture<Boolean> setConnectionPromise(CompletableFuture<Boolean> connectionPromise)

Sets the CompletableFuture promise holding the result of a connection attempt using this websocket client.

Parameters:

connectionPromise - The CompletableFuture promise holding the result of a connection attempt using this websocket client.

Returns:

The CompletableFuture promise holding the result of a connection attempt using this websocket client.

Since:

2.1.0

claimNextPacketId

public int claimNextPacketId()

Retrieves the next available packet id, then increments the internal counter to reflect that the previous id has now been allocated.

Returns:

The next available packet id

Since:

1.0.0

getLastSequenceNumber

public int getLastSequenceNumber()

Returns the sequence number that the socket has last seen from the service.

Returns:

The next last packet sequence number

Since:

1.0.0

getCompressionScheme

public CompressionScheme getCompressionScheme()

Retrieves the CompressionScheme this InteractiveWebSocketClient is using.

Returns:

The CompressionScheme this InteractiveWebSocketClient is using

Since:

1.0.0

setCompressionScheme

public void setCompressionScheme(String compressionScheme)

Sets the CompressionScheme that this InteractiveWebSocketClient will use.

Parameters:

compressionScheme - The compression scheme that this InteractiveWebSocketClient will use

Since:

1.0.0

setCompressionScheme

public void setCompressionScheme(CompressionScheme compressionScheme)

Sets the CompressionScheme that this InteractiveWebSocketClient will use.

Parameters:

compressionScheme - CompressionScheme that this InteractiveWebSocketClient will use

Since:

1.0.0

onOpen

public void onOpen(org.java_websocket.handshake.ServerHandshake serverHandshake)

Specified by:

onOpen in class org.java_websocket.client.WebSocketClient

Parameters:

serverHandshake - The handshake returned by the Interactive service

Since:

1.0.0

See Also:

WebSocketClient.onOpen(ServerHandshake)

send

public void send(String message)

Specified by:

send in interface org.java_websocket.WebSocket

Overrides:

send in class org.java_websocket.client.WebSocketClient

Parameters:

message - The message to send to the Interactive service

Since:

1.0.0

See Also:

WebSocketClient.send(String)

onMessage

public void onMessage(ByteBuffer bytes)

Overrides:

onMessage in class org.java_websocket.client.WebSocketClient

Parameters:

bytes - ByteBuffer containing message received from the Interactive service (as an array of bytes)

Since:

1.0.0

See Also:

WebSocketClient.onMessage(ByteBuffer)

onMessage

public void onMessage(String message)

Specified by:

onMessage in class org.java_websocket.client.WebSocketClient

Parameters:

message - The message received from the Interactive service

Since:

1.0.0

See Also:

WebSocketClient.onMessage(String)

onClose

public void onClose(int code,
                    String reason,
                    boolean closedRemotely)

Specified by:

onClose in class org.java_websocket.client.WebSocketClient

Parameters:

code - HTTP status code

reason - HTTP status reason

closedRemotely - true if the connection was closed remotely, false otherwise

Since:

1.0.0

See Also:

WebSocketClient.onClose(int, String, boolean)

onError

public void onError(Exception ex)

Specified by:

onError in class org.java_websocket.client.WebSocketClient

Parameters:

ex - The Exception thrown when the WebSocketClient connection errored

Since:

1.0.0

See Also:

WebSocketClient.onError(Exception)