Package com.microsoft.playwright.impl

Class WebSocketImpl

java.lang.Object

com.microsoft.playwright.impl.LoggingSupport

com.microsoft.playwright.impl.ChannelOwner

com.microsoft.playwright.impl.WebSocketImpl

All Implemented Interfaces:

WebSocket

class WebSocketImpl
extends ChannelOwner
implements WebSocket

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static enum	WebSocketImpl.EventType
private class	WebSocketImpl.WaitableWebSocketClose<T>
private class	WebSocketImpl.WaitableWebSocketError<T>
private static class	WebSocketImpl.WebSocketFrameImpl

Nested classes/interfaces inherited from interface com.microsoft.playwright.WebSocket

WebSocket.WaitForFrameReceivedOptions, WebSocket.WaitForFrameSentOptions

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	isClosed
private final ListenerCollection<WebSocketImpl.EventType>	listeners
private final PageImpl	page

Fields inherited from class com.microsoft.playwright.impl.ChannelOwner

connection, guid, initializer, type

Constructor Summary

Constructors

Constructor	Description
WebSocketImpl(ChannelOwner parent, String type, String guid, com.google.gson.JsonObject initializer)

Method Summary

Modifier and Type	Method	Description
(package private) void	handleEvent(String event, com.google.gson.JsonObject parameters)
boolean	isClosed()	Indicates that the web socket has been closed.
void	offClose(Consumer<WebSocket> handler)	Removes handler that was previously added with onClose(handler).
void	offFrameReceived(Consumer<WebSocketFrame> handler)	Removes handler that was previously added with onFrameReceived(handler).
void	offFrameSent(Consumer<WebSocketFrame> handler)	Removes handler that was previously added with onFrameSent(handler).
void	offSocketError(Consumer<String> handler)	Removes handler that was previously added with onSocketError(handler).
void	onClose(Consumer<WebSocket> handler)	Fired when the websocket closes.
void	onFrameReceived(Consumer<WebSocketFrame> handler)	Fired when the websocket receives a frame.
void	onFrameSent(Consumer<WebSocketFrame> handler)	Fired when the websocket sends a frame.
void	onSocketError(Consumer<String> handler)	Fired when the websocket has an error.
String	url()	Contains the URL of the WebSocket.
private WebSocketFrame	waitForEventWithTimeout(WebSocketImpl.EventType eventType, Runnable code, Predicate<WebSocketFrame> predicate, Double timeout)
WebSocketFrame	waitForFrameReceived(WebSocket.WaitForFrameReceivedOptions options, Runnable code)	Performs action and waits for a frame to be sent.
private WebSocketFrame	waitForFrameReceivedImpl(WebSocket.WaitForFrameReceivedOptions options, Runnable code)
WebSocketFrame	waitForFrameSent(WebSocket.WaitForFrameSentOptions options, Runnable code)	Performs action and waits for a frame to be sent.
private WebSocketFrame	waitForFrameSentImpl(WebSocket.WaitForFrameSentOptions options, Runnable code)

Methods inherited from class com.microsoft.playwright.impl.ChannelOwner

adopt, disposeChannelOwner, runUntil, sendMessage, sendMessage, sendMessageAsync, toProtocolRef, withLogging, withWaitLogging

Methods inherited from class com.microsoft.playwright.impl.LoggingSupport

logApi, logApiIfEnabled, logWithTimestamp, withLogging

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.microsoft.playwright.WebSocket

waitForFrameReceived, waitForFrameSent

Field Details

listeners

private final ListenerCollection<WebSocketImpl.EventType> listeners

page

private final PageImpl page

isClosed

private boolean isClosed

Constructor Details

WebSocketImpl

WebSocketImpl(ChannelOwner parent,
 String type,
 String guid,
 com.google.gson.JsonObject initializer)

Method Details

onClose

public void onClose(Consumer<WebSocket> handler)

Description copied from interface: WebSocket

Fired when the websocket closes.

Specified by:

onClose in interface WebSocket

offClose

public void offClose(Consumer<WebSocket> handler)

Description copied from interface: WebSocket

Removes handler that was previously added with onClose(handler).

Specified by:

offClose in interface WebSocket

onFrameReceived

public void onFrameReceived(Consumer<WebSocketFrame> handler)

Description copied from interface: WebSocket

Fired when the websocket receives a frame.

Specified by:

onFrameReceived in interface WebSocket

offFrameReceived

public void offFrameReceived(Consumer<WebSocketFrame> handler)

Description copied from interface: WebSocket

Removes handler that was previously added with onFrameReceived(handler).

Specified by:

offFrameReceived in interface WebSocket

onFrameSent

public void onFrameSent(Consumer<WebSocketFrame> handler)

Description copied from interface: WebSocket

Fired when the websocket sends a frame.

Specified by:

onFrameSent in interface WebSocket

offFrameSent

public void offFrameSent(Consumer<WebSocketFrame> handler)

Description copied from interface: WebSocket

Removes handler that was previously added with onFrameSent(handler).

Specified by:

offFrameSent in interface WebSocket

onSocketError

public void onSocketError(Consumer<String> handler)

Description copied from interface: WebSocket

Fired when the websocket has an error.

Specified by:

onSocketError in interface WebSocket

offSocketError

public void offSocketError(Consumer<String> handler)

Description copied from interface: WebSocket

Removes handler that was previously added with onSocketError(handler).

Specified by:

offSocketError in interface WebSocket

waitForFrameReceived

public WebSocketFrame waitForFrameReceived(WebSocket.WaitForFrameReceivedOptions options,
 Runnable code)

Description copied from interface: WebSocket

Performs action and waits for a frame to be sent. If predicate is provided, it passes WebSocketFrame value into the predicate function and waits for predicate(webSocketFrame) to return a truthy value. Will throw an error if the WebSocket or Page is closed before the frame is received.

Specified by:

waitForFrameReceived in interface WebSocket

Parameters:

code - Callback that performs the action triggering the event.

waitForFrameReceivedImpl

private WebSocketFrame waitForFrameReceivedImpl(WebSocket.WaitForFrameReceivedOptions options,
 Runnable code)

waitForFrameSent

public WebSocketFrame waitForFrameSent(WebSocket.WaitForFrameSentOptions options,
 Runnable code)

Description copied from interface: WebSocket

Performs action and waits for a frame to be sent. If predicate is provided, it passes WebSocketFrame value into the predicate function and waits for predicate(webSocketFrame) to return a truthy value. Will throw an error if the WebSocket or Page is closed before the frame is sent.

Specified by:

waitForFrameSent in interface WebSocket

Parameters:

code - Callback that performs the action triggering the event.

waitForFrameSentImpl

private WebSocketFrame waitForFrameSentImpl(WebSocket.WaitForFrameSentOptions options,
 Runnable code)

isClosed

public boolean isClosed()

Description copied from interface: WebSocket

Indicates that the web socket has been closed.

Specified by:

isClosed in interface WebSocket

url

public String url()

Description copied from interface: WebSocket

Contains the URL of the WebSocket.

Specified by:

url in interface WebSocket

waitForEventWithTimeout

private WebSocketFrame waitForEventWithTimeout(WebSocketImpl.EventType eventType,
 Runnable code,
 Predicate<WebSocketFrame> predicate,
 Double timeout)

handleEvent

void handleEvent(String event,
 com.google.gson.JsonObject parameters)

Overrides:

handleEvent in class ChannelOwner