io.appium.java_client.ws

Class StringWebSocketClient

java.lang.Object

okhttp3.WebSocketListener

io.appium.java_client.ws.StringWebSocketClient

All Implemented Interfaces:

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

public class StringWebSocketClient
extends okhttp3.WebSocketListener
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.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	onClosing(okhttp3.WebSocket webSocket, int code, java.lang.String reason)
void	onFailure(okhttp3.WebSocket webSocket, java.lang.Throwable t, okhttp3.Response response)
void	onMessage(okhttp3.WebSocket webSocket, java.lang.String text)
void	onOpen(okhttp3.WebSocket webSocket, okhttp3.Response response)
void	removeAllHandlers() Remove all the registered handlers.

Methods inherited from class okhttp3.WebSocketListener

onClosed, onMessage

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

getEndpoint

@Nullable
public 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(okhttp3.WebSocket webSocket,
                   okhttp3.Response response)

Overrides:

onOpen in class okhttp3.WebSocketListener

onClosing

public void onClosing(okhttp3.WebSocket webSocket,
                      int code,
                      java.lang.String reason)

Overrides:

onClosing in class okhttp3.WebSocketListener

onFailure

public void onFailure(okhttp3.WebSocket webSocket,
                      java.lang.Throwable t,
                      okhttp3.Response response)

Overrides:

onFailure in class okhttp3.WebSocketListener

onMessage

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

Overrides:

onMessage in class okhttp3.WebSocketListener

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.