java.lang.Object
swim.io.ws.WebSocketModem<I,O>
- All Implemented Interfaces:
FlowContext
,IpContext
,IpModem<Object,
,Object> WebSocketContext<I,
O>
public class WebSocketModem<I,O>
extends Object
implements IpModem<Object,Object>, WebSocketContext<I,O>
-
Field Summary
Modifier and TypeFieldDescriptionprotected IpModemContext<Object,
Object> protected final WsDecoder
protected final WsEncoder
protected final WsSettings
-
Constructor Summary
ConstructorDescriptionWebSocketModem
(WebSocket<I, O> socket, WsSettings wsSettings, WsDecoder decoder, WsEncoder encoder) -
Method Summary
Modifier and TypeMethodDescriptionvoid
Returns the cryptographic cipher suite used by the underlying network connection.void
close()
void
Lifecycle callback invoked by the modem context after it hasbecome
a newsocket
implementation.void
Lifecycle callback invoked by the modem context after the underlying network socket has opened a connection.void
Lifecycle callback invoked by the socket context after the underlying network connection has disconnected.void
Lifecycle callback invoked by the modem context when the underlying network socket fails by throwing anerror
.void
I/O callback invoked by the modem context with the completed value of the current readDecoder
after it has transitioned to the done state.void
Lifecycle callback invoked by the modem context after the underlying network socket has established a secure connection.void
Lifecycle callback invoked by the modem context after the underlying network connection has timed out.void
I/O callback invoked by the modem context with the completed value of the current writeEncoder
after it has transitioned to the done state.void
doRead()
void
doWrite()
Returns the currentFlowControl
state of the underlying network channel.void
flowControl
(FlowControl flowControl) Enqueues an atomic replacement of the underlying network channel's flow control state with a newflowControl
.flowControl
(FlowModifier flowModifier) Enqueues an atomic modification to the underlying network channel's flow control state by applying aflowModifier
delta.long
Returns the number of idle milliseconds after which thisIpModem
should be closed due to inactivity.Returns the socket modem context to which thisIpModem
is bound; returnsnull
if thisIpModem
is unbound.boolean
isClient()
Returnstrue
if the underlying network channel initiated an outgoing connection.boolean
Returnstrue
if the underlying network channel is currently connected.boolean
isSecure()
Returnstrue
if the underlying network transport is encrypted.boolean
isServer()
Returnstrue
if the underlying network channel accepted an incoming connection.Returns the IP address and port of the local endpoint of the underlying network connection.Returns the certificate chain used to authenticate the local endpoint of the underlying network connection.Returns the authenticated identity of the local endpoint of the underlying network connection.<I2 extends I>
void<I2 extends I>
voidReturns the IP address and port of the remote endpoint of the underlying network connection.Returns the certificate chain used to authenticate the remote endpoint of the underlying network connection.Returns the authenticated identity of the remote endpoint of the underlying network connection.Returns the name of the transport-layer security protocol used by the underlying network connection.void
setIpModemContext
(IpModemContext<Object, Object> context) Sets the socket modem context to which thisIpModem
is bound.void
willBecome
(IpSocket socket) Lifecycle callback invoked by the modem context before it hasbecome
a newsocket
implementation.void
Lifecycle callback invoked by the modem context before the underlying network socket attempts to open a connection.void
Lifecycle callback invoked by the modem context before the underlying network socket establishes a secure connection.<O2 extends O>
voidwrite
(WsControlFrame<?, O2> frame) <O2 extends O>
voidwrite
(WsDataFrame<O2> frame)
-
Field Details
-
socket
-
wsSettings
-
decoder
-
encoder
-
context
-
-
Constructor Details
-
WebSocketModem
-
-
Method Details
-
ipModemContext
Description copied from interface:IpModem
Returns the socket modem context to which thisIpModem
is bound; returnsnull
if thisIpModem
is unbound.- Specified by:
ipModemContext
in interfaceIpModem<I,
O>
-
setIpModemContext
Description copied from interface:IpModem
Sets the socket modem context to which thisIpModem
is bound.- Specified by:
setIpModemContext
in interfaceIpModem<I,
O>
-
idleTimeout
public long idleTimeout()Description copied from interface:IpModem
Returns the number of idle milliseconds after which thisIpModem
should be closed due to inactivity. Returns-1
if a default idle timeout should be used. Returns0
if the underlying network socket should not time out.- Specified by:
idleTimeout
in interfaceIpModem<I,
O>
-
doRead
public void doRead()Description copied from interface:IpModem
I/O callback invoked by the modem context asking thisIpModem
to provide an inputDecoder
by invoking the modem context'sread
method. The modem context will asynchronously feed input data to the provided readDecoder
until it transitions out of the cont state. The read flow control of the underlying network socket is automatically managed by the modem context using the state of the readDecoder
. May be invoked concurrently to other I/O callbacks, but never concurrently with otherdoRead
ordidRead
calls. -
didRead
Description copied from interface:IpModem
I/O callback invoked by the modem context with the completed value of the current readDecoder
after it has transitioned to the done state. May be invoked concurrently to other I/O callbacks, but never concurrently with otherdoRead
ordidRead
calls. -
doWrite
public void doWrite()Description copied from interface:IpModem
I/O callback invoked by the modem context asking thisIpModem
to provide an outputEncoder
by invoking the modem context'swrite
method. The modem context will asynchronously pull output data from the provided writeEncoder
until it transitions out of the cont state. The write flow control of the underlying network socket is automatically managed by the modem context using the state of the writeEncoder
. May be invoked concurrently to other I/O callbacks, but never concurrently with otherdoWrite
ordidWrite
calls. -
didWrite
Description copied from interface:IpModem
I/O callback invoked by the modem context with the completed value of the current writeEncoder
after it has transitioned to the done state. May be invoked concurrently to other I/O callbacks, but never concurrently with otherdodWrite
ordidWrite
calls. -
willConnect
public void willConnect()Description copied from interface:IpModem
Lifecycle callback invoked by the modem context before the underlying network socket attempts to open a connection.- Specified by:
willConnect
in interfaceIpModem<I,
O>
-
didConnect
public void didConnect()Description copied from interface:IpModem
Lifecycle callback invoked by the modem context after the underlying network socket has opened a connection.- Specified by:
didConnect
in interfaceIpModem<I,
O>
-
willSecure
public void willSecure()Description copied from interface:IpModem
Lifecycle callback invoked by the modem context before the underlying network socket establishes a secure connection.- Specified by:
willSecure
in interfaceIpModem<I,
O>
-
didSecure
public void didSecure()Description copied from interface:IpModem
Lifecycle callback invoked by the modem context after the underlying network socket has established a secure connection. -
willBecome
Description copied from interface:IpModem
Lifecycle callback invoked by the modem context before it hasbecome
a newsocket
implementation.- Specified by:
willBecome
in interfaceIpModem<I,
O>
-
didBecome
Description copied from interface:IpModem
Lifecycle callback invoked by the modem context after it hasbecome
a newsocket
implementation. -
didTimeout
public void didTimeout()Description copied from interface:IpModem
Lifecycle callback invoked by the modem context after the underlying network connection has timed out. The modem will automatically be closed.- Specified by:
didTimeout
in interfaceIpModem<I,
O>
-
didDisconnect
public void didDisconnect()Description copied from interface:IpModem
Lifecycle callback invoked by the socket context after the underlying network connection has disconnected.- Specified by:
didDisconnect
in interfaceIpModem<I,
O>
-
didFail
Description copied from interface:IpModem
Lifecycle callback invoked by the modem context when the underlying network socket fails by throwing anerror
. The modem will automatically be closed. -
isConnected
public boolean isConnected()Description copied from interface:IpContext
Returnstrue
if the underlying network channel is currently connected.- Specified by:
isConnected
in interfaceIpContext
-
isClient
public boolean isClient()Description copied from interface:IpContext
Returnstrue
if the underlying network channel initiated an outgoing connection. -
isServer
public boolean isServer()Description copied from interface:IpContext
Returnstrue
if the underlying network channel accepted an incoming connection. -
isSecure
public boolean isSecure()Description copied from interface:IpContext
Returnstrue
if the underlying network transport is encrypted. -
securityProtocol
Description copied from interface:IpContext
Returns the name of the transport-layer security protocol used by the underlying network connection. Returnsnull
if the underlying network channel is not currently connected, or if the underlying network connection is not secure.- Specified by:
securityProtocol
in interfaceIpContext
-
cipherSuite
Description copied from interface:IpContext
Returns the cryptographic cipher suite used by the underlying network connection. Returnsnull
if the underlying network channel is not currently connected, or if the underlying network connection is not secure.- Specified by:
cipherSuite
in interfaceIpContext
-
localAddress
Description copied from interface:IpContext
Returns the IP address and port of the local endpoint of the underlying network connection. Returnsnull
if the underlying network channel is not currently connected.- Specified by:
localAddress
in interfaceIpContext
-
localPrincipal
Description copied from interface:IpContext
Returns the authenticated identity of the local endpoint of the underlying network connection. Returnsnull
if the underlying network channel is not currently connected, or if the underlying network connection is not authenticated.- Specified by:
localPrincipal
in interfaceIpContext
-
localCertificates
Description copied from interface:IpContext
Returns the certificate chain used to authenticate the local endpoint of the underlying network connection. Returnsnull
if the underlying network channel is not currently connected, or if the underlying network connection is not authenticated.- Specified by:
localCertificates
in interfaceIpContext
-
remoteAddress
Description copied from interface:IpContext
Returns the IP address and port of the remote endpoint of the underlying network connection. Returnsnull
if the underlying network channel is not currently connected.- Specified by:
remoteAddress
in interfaceIpContext
-
remotePrincipal
Description copied from interface:IpContext
Returns the authenticated identity of the remote endpoint of the underlying network connection. Returnsnull
if the underlying network channel is not currently connected, or if the underlying network connection is not authenticated.- Specified by:
remotePrincipal
in interfaceIpContext
-
remoteCertificates
Description copied from interface:IpContext
Returns the certificate chain used to authenticate the remote endpoint of the underlying network connection. Returnsnull
if the underlying network channel is not currently connected, or if the underlying network connection is not authenticated.- Specified by:
remoteCertificates
in interfaceIpContext
-
flowControl
Description copied from interface:FlowContext
Returns the currentFlowControl
state of the underlying network channel.- Specified by:
flowControl
in interfaceFlowContext
-
flowControl
Description copied from interface:FlowContext
Enqueues an atomic replacement of the underlying network channel's flow control state with a newflowControl
.- Specified by:
flowControl
in interfaceFlowContext
-
flowControl
Description copied from interface:FlowContext
Enqueues an atomic modification to the underlying network channel's flow control state by applying aflowModifier
delta.- Specified by:
flowControl
in interfaceFlowContext
-
wsSettings
- Specified by:
wsSettings
in interfaceWebSocketContext<I,
O>
-
read
- Specified by:
read
in interfaceWebSocketContext<I,
O>
-
read
- Specified by:
read
in interfaceWebSocketContext<I,
O>
-
write
- Specified by:
write
in interfaceWebSocketContext<I,
O>
-
write
- Specified by:
write
in interfaceWebSocketContext<I,
O>
-
become
- Specified by:
become
in interfaceWebSocketContext<I,
O>
-
close
public void close()- Specified by:
close
in interfaceWebSocketContext<I,
O>
-