Package com.linecorp.armeria.client.websocket

Class WebSocketSession

java.lang.Object

com.linecorp.armeria.client.websocket.WebSocketSession

@UnstableApi
public final class WebSocketSession
extends Object

A WebSocket session that is created after WebSocketClient.connect(String) succeeds. You can start sending WebSocketFrames via setOutbound(Publisher). You can also subscribe to inbound() to receive WebSocketFrames from the server.

Method Summary

Modifier and Type	Method	Description
ClientRequestContext	context()	Returns the ClientRequestContext.
WebSocket	inbound()	Returns the WebSocket that is used to receive WebSocket frames from the server.
WebSocketWriter	outbound()	Returns the WebSocketWriter that is used to send WebSocket frames to the server.
ResponseHeaders	responseHeaders()	Returns the ResponseHeaders.
void	setOutbound(org.reactivestreams.Publisher<? extends WebSocketFrame> outbound)	Sets the WebSocket that is used to send WebSocket frames to the server.
@Nullable String	subprotocol()	Returns the subprotocol negotiated between the client and the server.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

context

public ClientRequestContext context()

Returns the ClientRequestContext.

responseHeaders

public ResponseHeaders responseHeaders()

Returns the ResponseHeaders.

subprotocol

@Nullable
public @Nullable String subprotocol()

Returns the subprotocol negotiated between the client and the server.

inbound

public WebSocket inbound()

Returns the WebSocket that is used to receive WebSocket frames from the server.

outbound

public WebSocketWriter outbound()

Returns the WebSocketWriter that is used to send WebSocket frames to the server.

Throws:

IllegalStateException - if this method or setOutbound(Publisher) has been called already.

setOutbound

public void setOutbound(org.reactivestreams.Publisher<? extends WebSocketFrame> outbound)

Sets the WebSocket that is used to send WebSocket frames to the server.

Throws:

IllegalStateException - if this method or outbound() has been called already.

toString

public String toString()

Overrides:

toString in class Object