java.lang.Object
- swim.io.warp.WarpWebSocket

All Implemented Interfaces:: PullContext<Envelope>, StayContext, FlowContext, IpContext, WarpSocketContext, WebSocket<Envelope,Envelope>

public class WarpWebSocket
extends Object
implements WebSocket<Envelope,Envelope>, WarpSocketContext, PullContext<Envelope>, StayContext

Field Summary

Fields
Modifier and Type Field Description

protected WebSocketContext<Envelope,Envelope> context

protected WarpSocket socket

protected WarpSettings warpSettings

Constructor Summary

Constructors
Constructor Description

WarpWebSocket(WarpSocket socket, WarpSettings warpSettings)

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 Envelope> frame)`
`void`	`didSecure()`
`void`	`didTimeout()`
`void`	`didUpgrade(HttpRequest<?> httpRequest, HttpResponse<?> httpResponse)`
`void`	`didWrite(WsFrame<? extends Envelope> frame)`
`void`	`doRead()`
`void`	`doWrite()`
`void`	`feed(PullRequest<Envelope> pullRequest)`
`void`	`feed(Envelope envelope)`
`void`	`feed(Envelope envelope, float prio)`
`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.
`protected void`	`generateDemand()`
`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.
`void`	`push(Envelope envelope)`
`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<Envelope,Envelope> context)`
`void`	`skip()`
`WarpSettings`	`warpSettings()`
`WebSocketContext<Envelope,Envelope>`	`webSocketContext()`
`void`	`willBecome(IpSocket socket)`
`void`	`willConnect()`
`void`	`willSecure()`
`void`	`write(WsControlFrame<?,? extends Envelope> frame)`

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

- Field Detail
  - socket
```
protected final WarpSocket socket
```
  - warpSettings
```
protected final WarpSettings warpSettings
```
  - context
```
protected WebSocketContext<Envelope,Envelope> context
```
- Constructor Detail
  - WarpWebSocket
```
public WarpWebSocket(WarpSocket socket,
                     WarpSettings warpSettings)
```
- Method Detail
  - webSocketContext
```
public WebSocketContext<Envelope,Envelope> webSocketContext()
```
    Specified by:
    
    webSocketContext in interface WebSocket<Envelope,Envelope>
  - setWebSocketContext
```
public void setWebSocketContext(WebSocketContext<Envelope,Envelope> context)
```
    Specified by:
    
    setWebSocketContext in interface WebSocket<Envelope,Envelope>
  - idleTimeout
```
public long idleTimeout()
```
    Specified by:
    
    idleTimeout in interface WebSocket<Envelope,Envelope>
  - doRead
```
public void doRead()
```
    Specified by:
    
    doRead in interface WebSocket<Envelope,Envelope>
  - didRead
```
public void didRead(WsFrame<? extends Envelope> frame)
```
    Specified by:
    
    didRead in interface WebSocket<Envelope,Envelope>
  - doWrite
```
public void doWrite()
```
    Specified by:
    
    doWrite in interface WebSocket<Envelope,Envelope>
  - didWrite
```
public void didWrite(WsFrame<? extends Envelope> frame)
```
    Specified by:
    
    didWrite in interface WebSocket<Envelope,Envelope>
  - didUpgrade
```
public void didUpgrade(HttpRequest<?> httpRequest,
                       HttpResponse<?> httpResponse)
```
    Specified by:
    
    didUpgrade in interface WebSocket<Envelope,Envelope>
  - willConnect
```
public void willConnect()
```
    Specified by:
    
    willConnect in interface WebSocket<Envelope,Envelope>
  - didConnect
```
public void didConnect()
```
    Specified by:
    
    didConnect in interface WebSocket<Envelope,Envelope>
  - willSecure
```
public void willSecure()
```
    Specified by:
    
    willSecure in interface WebSocket<Envelope,Envelope>
  - didSecure
```
public void didSecure()
```
    Specified by:
    
    didSecure in interface WebSocket<Envelope,Envelope>
  - willBecome
```
public void willBecome(IpSocket socket)
```
    Specified by:
    
    willBecome in interface WebSocket<Envelope,Envelope>
  - didBecome
```
public void didBecome(IpSocket socket)
```
    Specified by:
    
    didBecome in interface WebSocket<Envelope,Envelope>
  - didTimeout
```
public void didTimeout()
```
    Specified by:
    
    didTimeout in interface WebSocket<Envelope,Envelope>
  - didDisconnect
```
public void didDisconnect()
```
    Specified by:
    
    didDisconnect in interface WebSocket<Envelope,Envelope>
  - didFail
```
public void didFail(Throwable error)
```
    Specified by:
    
    didFail in interface WebSocket<Envelope,Envelope>
  - 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
  - warpSettings
```
public WarpSettings warpSettings()
```
    Specified by:
    
    warpSettings in interface WarpSocketContext
  - feed
```
public void feed(PullRequest<Envelope> pullRequest)
```
    Specified by:
    
    feed in interface WarpSocketContext
  - feed
```
public void feed(Envelope envelope,
                 float prio)
```
    Specified by:
    
    feed in interface WarpSocketContext
  - feed
```
public void feed(Envelope envelope)
```
    Specified by:
    
    feed in interface WarpSocketContext
  - push
```
public void push(Envelope envelope)
```
    Specified by:
    
    push in interface PullContext<Envelope>
  - skip
```
public void skip()
```
    Specified by:
    
    skip in interface PullContext<Envelope>
  - generateDemand
```
protected void generateDemand()
```
  - write
```
public void write(WsControlFrame<?,? extends Envelope> frame)
```
    Specified by:
    
    write in interface WarpSocketContext
  - become
```
public void become(IpSocket socket)
```
    Specified by:
    
    become in interface WarpSocketContext
  - close
```
public void close()
```
    Specified by:
    
    close in interface WarpSocketContext

Modifier and Type	Field	Description
`protected WebSocketContext<Envelope,Envelope>`	`context`
`protected WarpSocket`	`socket`
`protected WarpSettings`	`warpSettings`

Class WarpWebSocket

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

socket

warpSettings

context

Constructor Detail

WarpWebSocket

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

warpSettings

feed

feed

feed

push

skip

generateDemand

write

become

close