java.lang.Object
- swim.io.AbstractSocket

All Implemented Interfaces:: ConnectionContext, FlowContext, Socket

public abstract class AbstractSocket
extends Object
implements Socket, ConnectionContext, FlowContext

Field Summary

Fields
Modifier and Type Field Description

protected SocketContext context

Constructor Summary

Constructors
Constructor Description

AbstractSocket()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`become(Socket socket)`
`String`	`cipherSuite()`	Returns the cryptographic cipher suite used by the underlying network connection.
`void`	`close()`
`void`	`didBecome(Socket socket)`	Lifecycle callback invoked by the socket context after it has `become` a new `socket` implementation.
`void`	`didConnect()`	Lifecycle callback invoked by the socket context after the underlying network socket has opened a connection.
`void`	`didDisconnect()`	Lifecycle callback invoked by the socket context after the underlying network connection has disconnected.
`void`	`didFail(Throwable error)`	Lifecycle callback invoked by the socket context when the underlying network socket fails by throwing an `error`.
`void`	`didSecure()`	Lifecycle callback invoked by the socket context after the underlying network socket has established a secure connection.
`void`	`didTimeout()`	Lifecycle callback invoked by the socket context after the underlying network connection has timed out.
`void`	`didWrite()`	I/O callback invoked by the socket context after the underlying network socket has completed writing all data in its `outputBuffer`.
`void`	`doRead()`	I/O callback invoked by the socket context asking this `Socket` to read input data out of the socket context's `inputBuffer`.
`void`	`doWrite()`	I/O callback invoked by the socket context asking this `Socket` to write output data into the socket context's `outputBuffer`.
`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()`	Returns the number of idle milliseconds after which this `Socket` should be closed due to inactivity.
`swim.codec.InputBuffer`	`inputBuffer()`
`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.
`swim.codec.OutputBuffer<?>`	`outputBuffer()`
`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`	`setSocketContext(SocketContext context)`	Sets the network socket context to which this `Socket` is bound.
`SocketContext`	`socketContext()`	Returns the network socket context to which this `Socket` is bound; returns `null` if this `Socket` is unbound.
`SocketSettings`	`socketSettings()`
`void`	`willBecome(Socket socket)`	Lifecycle callback invoked by the socket context before it has `become` a new `socket` implementation.
`void`	`willConnect()`	Lifecycle callback invoked by the socket context before the underlying network socket attempts to open a connection.
`void`	`willSecure()`	Lifecycle callback invoked by the socket context before the underlying network socket establishes a secure connection.

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

- Field Detail
  - context
```
protected SocketContext context
```
- Constructor Detail
  - AbstractSocket
```
public AbstractSocket()
```
- Method Detail
  - socketContext
```
public SocketContext socketContext()
```
    Description copied from interface: Socket
    
    Returns the network socket context to which this Socket is bound; returns null if this Socket is unbound.
    
    Specified by:
    
    socketContext in interface Socket
  - setSocketContext
```
public void setSocketContext(SocketContext context)
```
    Description copied from interface: Socket
    
    Sets the network socket context to which this Socket is bound.
    
    Specified by:
    
    setSocketContext in interface Socket
  - idleTimeout
```
public long idleTimeout()
```
    Description copied from interface: Socket
    
    Returns the number of idle milliseconds after which this Socket should be closed due to inactivity. Returns -1 if a default idle timeout should be used. Returns 0 if the underlying network socket should not time out.
    
    Specified by:
    
    idleTimeout in interface Socket
  - doRead
```
public void doRead()
```
    Description copied from interface: Socket
    
    I/O callback invoked by the socket context asking this Socket to read input data out of the socket context's inputBuffer. May be invoked concurrently to other I/O callbacks, but never concurrently with other doRead calls.
    
    Specified by:
    
    doRead in interface Socket
  - doWrite
```
public void doWrite()
```
    Description copied from interface: Socket
    
    I/O callback invoked by the socket context asking this Socket to write output data into the socket context's outputBuffer. May be invoked concurrently to other I/O callbacks, but never concurrently with other doWrite or didWrite calls.
    
    Specified by:
    
    doWrite in interface Socket
  - didWrite
```
public void didWrite()
```
    Description copied from interface: Socket
    
    I/O callback invoked by the socket context after the underlying network socket has completed writing all data in its outputBuffer. May be invoked concurrently to other I/O callbacks, but never concurrently with other doWrite or didWrite calls.
    
    Specified by:
    
    didWrite in interface Socket
  - willConnect
```
public void willConnect()
```
    Description copied from interface: Socket
    
    Lifecycle callback invoked by the socket context before the underlying network socket attempts to open a connection.
    
    Specified by:
    
    willConnect in interface Socket
  - didConnect
```
public void didConnect()
```
    Description copied from interface: Socket
    
    Lifecycle callback invoked by the socket context after the underlying network socket has opened a connection.
    
    Specified by:
    
    didConnect in interface Socket
  - willSecure
```
public void willSecure()
```
    Description copied from interface: Socket
    
    Lifecycle callback invoked by the socket context before the underlying network socket establishes a secure connection.
    
    Specified by:
    
    willSecure in interface Socket
  - didSecure
```
public void didSecure()
```
    Description copied from interface: Socket
    
    Lifecycle callback invoked by the socket context after the underlying network socket has established a secure connection.
    
    Specified by:
    
    didSecure in interface Socket
  - willBecome
```
public void willBecome(Socket socket)
```
    Description copied from interface: Socket
    
    Lifecycle callback invoked by the socket context before it has become a new socket implementation.
    
    Specified by:
    
    willBecome in interface Socket
  - didBecome
```
public void didBecome(Socket socket)
```
    Description copied from interface: Socket
    
    Lifecycle callback invoked by the socket context after it has become a new socket implementation.
    
    Specified by:
    
    didBecome in interface Socket
  - didTimeout
```
public void didTimeout()
```
    Description copied from interface: Socket
    
    Lifecycle callback invoked by the socket context after the underlying network connection has timed out. The socket will automatically be closed.
    
    Specified by:
    
    didTimeout in interface Socket
  - didDisconnect
```
public void didDisconnect()
```
    Description copied from interface: Socket
    
    Lifecycle callback invoked by the socket context after the underlying network connection has disconnected.
    
    Specified by:
    
    didDisconnect in interface Socket
  - didFail
```
public void didFail(Throwable error)
```
    Description copied from interface: Socket
    
    Lifecycle callback invoked by the socket context when the underlying network socket fails by throwing an error. The socket will automatically be closed.
    
    Specified by:
    
    didFail in interface Socket
  - isConnected
```
public boolean isConnected()
```
    Description copied from interface: ConnectionContext
    
    Returns true if the underlying network channel is currently connected.
    
    Specified by:
    
    isConnected in interface ConnectionContext
  - isClient
```
public boolean isClient()
```
    Description copied from interface: ConnectionContext
    
    Returns true if the underlying network channel initiated an outgoing connection.
    
    Specified by:
    
    isClient in interface ConnectionContext
  - isServer
```
public boolean isServer()
```
    Description copied from interface: ConnectionContext
    
    Returns true if the underlying network channel accepted an incoming connection.
    
    Specified by:
    
    isServer in interface ConnectionContext
  - isSecure
```
public boolean isSecure()
```
    Description copied from interface: ConnectionContext
    
    Returns true if the underlying network transport is encrypted.
    
    Specified by:
    
    isSecure in interface ConnectionContext
  - securityProtocol
```
public String securityProtocol()
```
    Description copied from interface: ConnectionContext
    
    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 ConnectionContext
  - cipherSuite
```
public String cipherSuite()
```
    Description copied from interface: ConnectionContext
    
    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 ConnectionContext
  - localAddress
```
public InetSocketAddress localAddress()
```
    Description copied from interface: ConnectionContext
    
    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 ConnectionContext
  - localPrincipal
```
public Principal localPrincipal()
```
    Description copied from interface: ConnectionContext
    
    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 ConnectionContext
  - localCertificates
```
public Collection<Certificate> localCertificates()
```
    Description copied from interface: ConnectionContext
    
    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 ConnectionContext
  - remoteAddress
```
public InetSocketAddress remoteAddress()
```
    Description copied from interface: ConnectionContext
    
    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 ConnectionContext
  - remotePrincipal
```
public Principal remotePrincipal()
```
    Description copied from interface: ConnectionContext
    
    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 ConnectionContext
  - remoteCertificates
```
public Collection<Certificate> remoteCertificates()
```
    Description copied from interface: ConnectionContext
    
    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 ConnectionContext
  - 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
  - socketSettings
```
public SocketSettings socketSettings()
```
  - inputBuffer
```
public swim.codec.InputBuffer inputBuffer()
```
  - outputBuffer
```
public swim.codec.OutputBuffer<?> outputBuffer()
```
  - become
```
public void become(Socket socket)
```
  - close
```
public void close()
```

Class AbstractSocket

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

context

Constructor Detail

AbstractSocket

Method Detail

socketContext

setSocketContext

idleTimeout

doRead

doWrite

didWrite

willConnect

didConnect

willSecure

didSecure

willBecome

didBecome

didTimeout

didDisconnect

didFail

isConnected

isClient

isServer

isSecure

securityProtocol

cipherSuite

localAddress

localPrincipal

localCertificates

remoteAddress

remotePrincipal

remoteCertificates

flowControl

flowControl

flowControl

socketSettings

inputBuffer

outputBuffer

become

close