org.ocast.sdk.core

Class WebSocket

org.ocast.sdk.core.WebSocket

public class WebSocket

This class represents a web socket.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebSocket.Companion The companion object.

Field Summary

Fields

Modifier and Type	Field and Description
static WebSocket.Companion	Companion The companion object.
static int	MAX_PAYLOAD_SIZE The maximum payload size in bytes.
static long	PING_INTERVAL The ping interval in seconds.

Constructor Summary

Constructors

Constructor and Description
WebSocket(java.lang.String webSocketURL, SSLConfiguration sslConfiguration, WebSocket.Listener listener) Creates an instance of class WebSocket.

Method Summary

Modifier and Type	Method and Description
boolean	connect() Connects the web socket to the remote host.
protected okhttp3.WebSocket	createWebSocket() Creates and returns a web socket.
boolean	disconnect() Disconnects the web socket from the remote host.
WebSocket.State	getState() The current state of the web socket.
java.lang.String	getWebSocketURL() The web socket URL.
void	onClosed(okhttp3.WebSocket webSocket, int code, java.lang.String reason)
void	onFailure(okhttp3.WebSocket webSocket, java.lang.Throwable throwable, okhttp3.Response response)
void	onMessage(okhttp3.WebSocket webSocket, java.lang.String text)
void	onOpen(okhttp3.WebSocket webSocket, okhttp3.Response response)
boolean	send(java.lang.String message) Sends a message on the web socket.

Field Detail

MAX_PAYLOAD_SIZE

public static int MAX_PAYLOAD_SIZE

The maximum payload size in bytes.

See Also:

Constant Field Values

PING_INTERVAL

public static long PING_INTERVAL

The ping interval in seconds.

See Also:

Constant Field Values

Companion

public static WebSocket.Companion Companion

The companion object.

Constructor Detail

WebSocket

public WebSocket(@NotNull
                 java.lang.String webSocketURL,
                 @Nullable
                 SSLConfiguration sslConfiguration,
                 @NotNull
                 WebSocket.Listener listener)

Creates an instance of class WebSocket.

Parameters:

webSocketURL - The web socket URL.

sslConfiguration - The SSL configuration if the web socket is secure, or null if is not secure.

listener - The listener of the web socket events.

See Also:

class WebSocket

Method Detail

getState

@NotNull
public WebSocket.State getState()

The current state of the web socket.

connect

public boolean connect()

Connects the web socket to the remote host.

Returns:

true is the web socket connected successfully, otherwise false.

disconnect

public boolean disconnect()

Disconnects the web socket from the remote host.

Returns:

true is the web socket disconnected successfully, otherwise false.

send

public boolean send(@NotNull
                    java.lang.String message)

Sends a message on the web socket.

Parameters:

message - The message to send.

Returns:

true if the message was sent successfully, otherwise false.

createWebSocket

@NotNull
protected okhttp3.WebSocket createWebSocket()

Creates and returns a web socket.

Returns:

The web socket.

onOpen

public void onOpen(@NotNull
                   okhttp3.WebSocket webSocket,
                   @NotNull
                   okhttp3.Response response)

onMessage

public void onMessage(@NotNull
                      okhttp3.WebSocket webSocket,
                      @NotNull
                      java.lang.String text)

onClosed

public void onClosed(@NotNull
                     okhttp3.WebSocket webSocket,
                     int code,
                     @NotNull
                     java.lang.String reason)

onFailure

public void onFailure(@NotNull
                      okhttp3.WebSocket webSocket,
                      @NotNull
                      java.lang.Throwable throwable,
                      @Nullable
                      okhttp3.Response response)

getWebSocketURL

@NotNull
public java.lang.String getWebSocketURL()

The web socket URL.