java.lang.Object
- swim.io.ws.AbstractWebSocket<I,O>

All Implemented Interfaces:: FlowContext, IpContext, WebSocket<I,O>

public abstract class AbstractWebSocket<I,O>
extends Object
implements WebSocket<I,O>, IpContext, FlowContext

Field Summary

Fields
Modifier and Type Field Description

protected WebSocketContext<I,O> context

Constructor Summary

Constructors
Constructor Description

AbstractWebSocket()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`become(IpSocket socket)`
`String`	`cipherSuite()`	Returns the cryptographic cipher suite used by the underlying network connection.
`void`	`close()`
`void`	`didBecome(IpSocket socket)`
`void`	`didConnect()`
`void`	`didDisconnect()`
`void`	`didFail(Throwable error)`
`void`	`didRead(WsFrame<? extends I> frame)`
`void`	`didSecure()`
`void`	`didTimeout()`
`void`	`didUpgrade(HttpRequest<?> httpRequest, HttpResponse<?> httpResponse)`
`void`	`didWrite(WsFrame<? extends O> frame)`
`void`	`doRead()`
`void`	`doWrite()`
`FlowControl`	`flowControl()`	Returns the current `FlowControl` 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 new `flowControl`.
`FlowControl`	`flowControl(FlowModifier flowModifier)`	Enqueues an atomic modification to the underlying network channel's flow control state by applying a `flowModifier` delta.
`long`	`idleTimeout()`
`boolean`	`isClient()`	Returns `true` if the underlying network channel initiated an outgoing connection.
`boolean`	`isConnected()`	Returns `true` if the underlying network channel is currently connected.
`boolean`	`isSecure()`	Returns `true` if the underlying network transport is encrypted.
`boolean`	`isServer()`	Returns `true` if the underlying network channel accepted an incoming connection.
`InetSocketAddress`	`localAddress()`	Returns the IP address and port of the local endpoint of the underlying network connection.
`Collection<Certificate>`	`localCertificates()`	Returns the certificate chain used to authenticate the local endpoint of the underlying network connection.
`Principal`	`localPrincipal()`	Returns the authenticated identity of the local endpoint of the underlying network connection.
`<I2 extends I> void`	`read(Decoder<I2> content)`
`InetSocketAddress`	`remoteAddress()`	Returns the IP address and port of the remote endpoint of the underlying network connection.
`Collection<Certificate>`	`remoteCertificates()`	Returns the certificate chain used to authenticate the remote endpoint of the underlying network connection.
`Principal`	`remotePrincipal()`	Returns the authenticated identity of the remote endpoint of the underlying network connection.
`String`	`securityProtocol()`	Returns the name of the transport-layer security protocol used by the underlying network connection.
`void`	`setWebSocketContext(WebSocketContext<I,O> context)`
`WebSocketContext<I,O>`	`webSocketContext()`
`void`	`willBecome(IpSocket socket)`
`void`	`willConnect()`
`void`	`willSecure()`
`<O2 extends O> void`	`write(WsControl<?,O2> frame)`
`<O2 extends O> void`	`write(WsData<O2> frame)`
`WsSettings`	`wsSettings()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - context
```
protected WebSocketContext<I,O> context
```
- Constructor Detail
  - AbstractWebSocket
```
public AbstractWebSocket()
```
- Method Detail
  - webSocketContext
```
public WebSocketContext<I,O> webSocketContext()
```
    Specified by:
    
    webSocketContext in interface WebSocket<I,O>
  - setWebSocketContext
```
public void setWebSocketContext(WebSocketContext<I,O> context)
```
    Specified by:
    
    setWebSocketContext in interface WebSocket<I,O>
  - idleTimeout
```
public long idleTimeout()
```
    Specified by:
    
    idleTimeout in interface WebSocket<I,O>
  - doRead
```
public void doRead()
```
    Specified by:
    
    doRead in interface WebSocket<I,O>
  - didRead
```
public void didRead(WsFrame<? extends I> frame)
```
    Specified by:
    
    didRead in interface WebSocket<I,O>
  - doWrite
```
public void doWrite()
```
    Specified by:
    
    doWrite in interface WebSocket<I,O>
  - didWrite
```
public void didWrite(WsFrame<? extends O> frame)
```
    Specified by:
    
    didWrite in interface WebSocket<I,O>
  - didUpgrade
```
public void didUpgrade(HttpRequest<?> httpRequest,
                       HttpResponse<?> httpResponse)
```
    Specified by:
    
    didUpgrade in interface WebSocket<I,O>
  - willConnect
```
public void willConnect()
```
    Specified by:
    
    willConnect in interface WebSocket<I,O>
  - didConnect
```
public void didConnect()
```
    Specified by:
    
    didConnect in interface WebSocket<I,O>
  - willSecure
```
public void willSecure()
```
    Specified by:
    
    willSecure in interface WebSocket<I,O>
  - didSecure
```
public void didSecure()
```
    Specified by:
    
    didSecure in interface WebSocket<I,O>
  - willBecome
```
public void willBecome(IpSocket socket)
```
    Specified by:
    
    willBecome in interface WebSocket<I,O>
  - didBecome
```
public void didBecome(IpSocket socket)
```
    Specified by:
    
    didBecome in interface WebSocket<I,O>
  - didTimeout
```
public void didTimeout()
```
    Specified by:
    
    didTimeout in interface WebSocket<I,O>
  - didDisconnect
```
public void didDisconnect()
```
    Specified by:
    
    didDisconnect in interface WebSocket<I,O>
  - didFail
```
public void didFail(Throwable error)
```
    Specified by:
    
    didFail in interface WebSocket<I,O>
  - isConnected
```
public boolean isConnected()
```
    Description copied from interface: IpContext
    
    Returns true if the underlying network channel is currently connected.
    
    Specified by:
    
    isConnected in interface IpContext
  - isClient
```
public boolean isClient()
```
    Description copied from interface: IpContext
    
    Returns true if the underlying network channel initiated an outgoing connection.
    
    Specified by:
    
    isClient in interface IpContext
  - isServer
```
public boolean isServer()
```
    Description copied from interface: IpContext
    
    Returns true if the underlying network channel accepted an incoming connection.
    
    Specified by:
    
    isServer in interface IpContext
  - isSecure
```
public boolean isSecure()
```
    Description copied from interface: IpContext
    
    Returns true if the underlying network transport is encrypted.
    
    Specified by:
    
    isSecure in interface IpContext
  - securityProtocol
```
public String securityProtocol()
```
    Description copied from interface: IpContext
    
    Returns the name of the transport-layer security protocol used by the underlying network connection. Returns null if the underlying network channel is not currently connected, or if the underlying network connection is not secure.
    
    Specified by:
    
    securityProtocol in interface IpContext
  - cipherSuite
```
public String cipherSuite()
```
    Description copied from interface: IpContext
    
    Returns the cryptographic cipher suite used by the underlying network connection. Returns null if the underlying network channel is not currently connected, or if the underlying network connection is not secure.
    
    Specified by:
    
    cipherSuite in interface IpContext
  - localAddress
```
public InetSocketAddress localAddress()
```
    Description copied from interface: IpContext
    
    Returns the IP address and port of the local endpoint of the underlying network connection. Returns null if the underlying network channel is not currently connected.
    
    Specified by:
    
    localAddress in interface IpContext
  - localPrincipal
```
public Principal localPrincipal()
```
    Description copied from interface: IpContext
    
    Returns the authenticated identity of the local endpoint of the underlying network connection. Returns null if the underlying network channel is not currently connected, or if the underlying network connection is not authenticated.
    
    Specified by:
    
    localPrincipal in interface IpContext
  - localCertificates
```
public Collection<Certificate> localCertificates()
```
    Description copied from interface: IpContext
    
    Returns the certificate chain used to authenticate the local endpoint of the underlying network connection. Returns null if the underlying network channel is not currently connected, or if the underlying network connection is not authenticated.
    
    Specified by:
    
    localCertificates in interface IpContext
  - remoteAddress
```
public InetSocketAddress remoteAddress()
```
    Description copied from interface: IpContext
    
    Returns the IP address and port of the remote endpoint of the underlying network connection. Returns null if the underlying network channel is not currently connected.
    
    Specified by:
    
    remoteAddress in interface IpContext
  - remotePrincipal
```
public Principal remotePrincipal()
```
    Description copied from interface: IpContext
    
    Returns the authenticated identity of the remote endpoint of the underlying network connection. Returns null if the underlying network channel is not currently connected, or if the underlying network connection is not authenticated.
    
    Specified by:
    
    remotePrincipal in interface IpContext
  - remoteCertificates
```
public Collection<Certificate> remoteCertificates()
```
    Description copied from interface: IpContext
    
    Returns the certificate chain used to authenticate the remote endpoint of the underlying network connection. Returns null if the underlying network channel is not currently connected, or if the underlying network connection is not authenticated.
    
    Specified by:
    
    remoteCertificates in interface IpContext
  - flowControl
```
public FlowControl flowControl()
```
    Description copied from interface: FlowContext
    
    Returns the current FlowControl state of the underlying network channel.
    
    Specified by:
    
    flowControl in interface FlowContext
  - flowControl
```
public void flowControl(FlowControl flowControl)
```
    Description copied from interface: FlowContext
    
    Enqueues an atomic replacement of the underlying network channel's flow control state with a new flowControl.
    
    Specified by:
    
    flowControl in interface FlowContext
  - flowControl
```
public FlowControl flowControl(FlowModifier flowModifier)
```
    Description copied from interface: FlowContext
    
    Enqueues an atomic modification to the underlying network channel's flow control state by applying a flowModifier delta.
    
    Specified by:
    
    flowControl in interface FlowContext
  - wsSettings
```
public WsSettings wsSettings()
```
  - read
```
public <I2 extends I> void read(Decoder<I2> content)
```
  - write
```
public <O2 extends O> void write(WsData<O2> frame)
```
  - write
```
public <O2 extends O> void write(WsControl<?,O2> frame)
```
  - become
```
public void become(IpSocket socket)
```
  - close
```
public void close()
```

Class AbstractWebSocket<I,​O>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

context

Constructor Detail

AbstractWebSocket

Method Detail

webSocketContext

setWebSocketContext

idleTimeout

doRead

didRead

doWrite

didWrite

didUpgrade

willConnect

didConnect

willSecure

didSecure

willBecome

didBecome

didTimeout

didDisconnect

didFail

isConnected

isClient

isServer

isSecure

securityProtocol

cipherSuite

localAddress

localPrincipal

localCertificates

remoteAddress

remotePrincipal

remoteCertificates

flowControl

flowControl

flowControl

wsSettings

read

write

write

become

close

Class AbstractWebSocket<I,O>