Package io.appium.java_client.ws

Class StringWebSocketClient

java.lang.Object

io.appium.java_client.ws.StringWebSocketClient

All Implemented Interfaces:

CanHandleConnects, CanHandleDisconnects, CanHandleErrors, CanHandleMessages<java.lang.String>, java.util.function.Consumer<org.openqa.selenium.remote.http.Message>, org.openqa.selenium.remote.http.WebSocket.Listener

public class StringWebSocketClient
extends java.lang.Object
implements org.openqa.selenium.remote.http.WebSocket.Listener, CanHandleMessages<java.lang.String>, CanHandleErrors, CanHandleConnects, CanHandleDisconnects

Constructor Summary

Constructors

Constructor	Description
StringWebSocketClient(org.openqa.selenium.remote.http.HttpClient httpClient)

Method Summary

Modifier and Type	Method	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.
@Nullable java.net.URI	getEndpoint()
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.
boolean	isListening()
void	onClose(int code, java.lang.String reason)
void	onError(java.lang.Throwable t)
void	onOpen()	The callback method invoked on websocket opening.
void	onText(java.lang.CharSequence data)
void	removeAllHandlers()	Remove all the registered handlers.

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.CanHandleConnects

addConnectionHandler, removeConnectionHandlers

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

addDisconnectionHandler, removeDisconnectionHandlers

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

addErrorHandler, removeErrorHandlers

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

addMessageHandler, removeMessageHandlers

Methods inherited from interface java.util.function.Consumer

andThen

Methods inherited from interface org.openqa.selenium.remote.http.WebSocket.Listener

accept, onBinary

Constructor Detail

StringWebSocketClient

public StringWebSocketClient(org.openqa.selenium.remote.http.HttpClient httpClient)

Method Detail

getEndpoint

public @Nullable java.net.URI getEndpoint()

isListening

public boolean isListening()

connect

public void connect(java.net.URI endpoint)

Connects web socket client.

Parameters:

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

onOpen

public void onOpen()

The callback method invoked on websocket opening.

onClose

public void onClose(int code,
                    java.lang.String reason)

Specified by:

onClose in interface org.openqa.selenium.remote.http.WebSocket.Listener

onError

public void onError(java.lang.Throwable t)

Specified by:

onError in interface org.openqa.selenium.remote.http.WebSocket.Listener

onText

public void onText(java.lang.CharSequence data)

Specified by:

onText in interface org.openqa.selenium.remote.http.WebSocket.Listener

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.