io.appium.java_client.ws

Class StringWebSocketClient

java.lang.Object

io.appium.java_client.ws.WebSocketClient

io.appium.java_client.ws.StringWebSocketClient

All Implemented Interfaces:

CanHandleConnects, CanHandleDisconnects, CanHandleErrors, CanHandleMessages<java.lang.String>

public class StringWebSocketClient
extends WebSocketClient
implements CanHandleMessages<java.lang.String>, CanHandleErrors, CanHandleConnects, CanHandleDisconnects

Constructor Summary

Constructors

Constructor and Description
StringWebSocketClient()

Method Summary

Modifier and Type	Method and Description
void	connect(java.net.URI endpoint) Connects web socket client.
java.util.List<java.lang.Runnable>	getConnectionHandlers() Returns a list of all registered web socket connection handlers.
java.util.List<java.lang.Runnable>	getDisconnectionHandlers() Returns a list of all registered web socket disconnection handlers.
java.util.List<java.util.function.Consumer<java.lang.Throwable>>	getErrorHandlers() Returns a list of all registered web socket error handlers.
java.util.List<java.util.function.Consumer<java.lang.String>>	getMessageHandlers() Returns a list of all registered web socket messages handlers.
void	onClose() This event if fired when the client is disconnected from a web socket.
void	onError(java.lang.Throwable cause) This event if fired when there is an unexpected error in web socket connection.
void	onMessage(java.lang.String message) This event if fired when there is a new message from the web socket.
void	onOpen(javax.websocket.Session session) This event if fired when the client is successfully connected to a web socket.
void	removeAllHandlers() Remove all the registered handlers.

Methods inherited from class io.appium.java_client.ws.WebSocketClient

getEndpoint

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.appium.java_client.ws.CanHandleMessages

addMessageHandler, removeMessageHandlers

Methods inherited from interface io.appium.java_client.ws.CanHandleErrors

addErrorHandler, removeErrorHandlers

Methods inherited from interface io.appium.java_client.ws.CanHandleConnects

addConnectionHandler, removeConnectionHandlers

Methods inherited from interface io.appium.java_client.ws.CanHandleDisconnects

addDisconnectionHandler, removeDisconnectionHandlers

Constructor Detail

StringWebSocketClient

public StringWebSocketClient()

Method Detail

connect

public void connect(java.net.URI endpoint)

Description copied from class: WebSocketClient

Connects web socket client.

Overrides:

connect in class WebSocketClient

Parameters:

endpoint - The full address of an endpoint to connect to. Usually starts with 'ws://'.

onOpen

public void onOpen(javax.websocket.Session session)

This event if fired when the client is successfully connected to a web socket.

Parameters:

session - the actual web socket session instance

onClose

public void onClose()

This event if fired when the client is disconnected from a web socket.

onError

public void onError(java.lang.Throwable cause)

This event if fired when there is an unexpected error in web socket connection.

Parameters:

cause - the actual error reason

onMessage

public void onMessage(java.lang.String message)

This event if fired when there is a new message from the web socket.

Parameters:

message - the actual message content.

getMessageHandlers

public java.util.List<java.util.function.Consumer<java.lang.String>> getMessageHandlers()

Description copied from interface: CanHandleMessages

Returns a list of all registered web socket messages handlers.

Specified by:

getMessageHandlers in interface CanHandleMessages<java.lang.String>

Returns:

The list of web socket message handlers.

getErrorHandlers

public java.util.List<java.util.function.Consumer<java.lang.Throwable>> getErrorHandlers()

Description copied from interface: CanHandleErrors

Returns a list of all registered web socket error handlers.

Specified by:

getErrorHandlers in interface CanHandleErrors

Returns:

The list of web socket error handlers.

getConnectionHandlers

public java.util.List<java.lang.Runnable> getConnectionHandlers()

Description copied from interface: CanHandleConnects

Returns a list of all registered web socket connection handlers.

Specified by:

getConnectionHandlers in interface CanHandleConnects

Returns:

The list of web socket connection handlers.

getDisconnectionHandlers

public java.util.List<java.lang.Runnable> getDisconnectionHandlers()

Description copied from interface: CanHandleDisconnects

Returns a list of all registered web socket disconnection handlers.

Specified by:

getDisconnectionHandlers in interface CanHandleDisconnects

Returns:

The list of web socket disconnection handlers.

removeAllHandlers

public void removeAllHandlers()

Remove all the registered handlers.