org.tio.websocket.client

Interface WebSocket

All Known Implementing Classes:

WebSocketImpl

public interface WebSocket

Field Summary

Fields

Modifier and Type	Field and Description
static int	CLOSED
static int	CLOSING
static int	CONNECTING
static int	OPEN

Method Summary

Modifier and Type	Method and Description
Runnable	addOnClose(Consumer<CloseEvent> listener) To add listener of close event
Runnable	addOnError(Consumer<ErrorEvent> listener) To add listener of error event
Runnable	addOnMessage(Consumer<MessageEvent> listener) To add listener of message event
Runnable	addOnOpen(Consumer<OpenEvent> listener) To add listener of open event
Runnable	addOnThrows(Consumer<Throwable> listener) To add listener of throws event
default void	close() Close this WebSocket
default void	close(int code) Close this WebSocket by code
void	close(int code, String reason) Close this WebSocket by code and reason
void	connect() Connect to server
String	getExtensions()
io.reactivex.Observable<WsPacket>	getMessageStream() Get message stream from server
String	getProtocol()
int	getReadyState() ready state: CONNECTING, OPEN, CLOSING, CLOSED
String	getUrl() url
default void	send(byte[] data) Send message to server
default void	send(ByteBuffer data) Send message to server
void	send(String data) Send message to server
void	send(WsPacket packet) Send packet to server

Field Detail

CONNECTING

static final int CONNECTING

See Also:

Constant Field Values

OPEN

static final int OPEN

See Also:

Constant Field Values

CLOSING

static final int CLOSING

See Also:

Constant Field Values

CLOSED

static final int CLOSED

See Also:

Constant Field Values

Method Detail

getExtensions

String getExtensions()

addOnClose

Runnable addOnClose(Consumer<CloseEvent> listener)

To add listener of close event

Parameters:

listener - listener

Returns:

Runnable to remove this listener

addOnError

Runnable addOnError(Consumer<ErrorEvent> listener)

To add listener of error event

Parameters:

listener - listener

Returns:

Runnable to remove this listener

addOnMessage

Runnable addOnMessage(Consumer<MessageEvent> listener)

To add listener of message event

Parameters:

listener - listener

Returns:

Runnable to remove this listener

addOnOpen

Runnable addOnOpen(Consumer<OpenEvent> listener)

To add listener of open event

Parameters:

listener - listener

Returns:

Runnable to remove this listener

addOnThrows

Runnable addOnThrows(Consumer<Throwable> listener)

To add listener of throws event

Parameters:

listener - listener

Returns:

Runnable to remove this listener

getProtocol

String getProtocol()

getReadyState

int getReadyState()

ready state: CONNECTING, OPEN, CLOSING, CLOSED

Returns:

getUrl

String getUrl()

url

Returns:

connect

void connect()
      throws Exception

Connect to server

Throws:

Exception

close

default void close()

Close this WebSocket

close

default void close(int code)

Close this WebSocket by code

close

void close(int code,
           String reason)

Close this WebSocket by code and reason

send

default void send(byte[] data)

Send message to server

Parameters:

data -

send

default void send(ByteBuffer data)

Send message to server

Parameters:

data -

send

void send(String data)

Send message to server

Parameters:

data -

send

void send(WsPacket packet)

Send packet to server

Parameters:

packet -

getMessageStream

io.reactivex.Observable<WsPacket> getMessageStream()

Get message stream from server

Returns: