java.lang.Object
- swim.io.mqtt.MqttSocketModem<I,O>

All Implemented Interfaces:: FlowContext, IpContext, IpModem<Object,Object>, MqttSocketContext<I,O>

public class MqttSocketModem<I,O>
extends Object
implements IpModem<Object,Object>, MqttSocketContext<I,O>

Field Summary

Fields
Modifier and Type Field Description

protected IpModemContext<Object,Object> context

protected MqttSettings mqttSettings

protected MqttSocket<I,O> socket

Constructor Summary

Constructors
Constructor Description

MqttSocketModem(MqttSocket<I,O> socket, MqttSettings mqttSettings)

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)`	Lifecycle callback invoked by the modem context after it has `become` a new `socket` implementation.
`void`	`didConnect()`	Lifecycle callback invoked by the modem 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 modem context when the underlying network socket fails by throwing an `error`.
`void`	`didRead(Object input)`	I/O callback invoked by the modem context with the completed value of the current read `Decoder` after it has transitioned to the done state.
`void`	`didSecure()`	Lifecycle callback invoked by the modem context after the underlying network socket has established a secure connection.
`void`	`didTimeout()`	Lifecycle callback invoked by the modem context after the underlying network connection has timed out.
`void`	`didWrite(Object output)`	I/O callback invoked by the modem context with the completed value of the current write `Encoder` after it has transitioned to the done state.
`void`	`doRead()`	I/O callback invoked by the modem context asking this `IpModem` to provide an input `Decoder` by invoking the modem context's `read` method.
`void`	`doWrite()`	I/O callback invoked by the modem context asking this `IpModem` to provide an output `Encoder` by invoking the modem context's `write` method.
`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 `IpModem` should be closed due to inactivity.
`IpModemContext<Object,Object>`	`ipModemContext()`	Returns the socket modem context to which this `IpModem` is bound; returns `null` if this `IpModem` is unbound.
`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.
`MqttSettings`	`mqttSettings()`
`<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`	`setIpModemContext(IpModemContext<Object,Object> context)`	Sets the socket modem context to which this `IpModem` is bound.
`void`	`willBecome(IpSocket socket)`	Lifecycle callback invoked by the modem context before it has `become` a new `socket` implementation.
`void`	`willConnect()`	Lifecycle callback invoked by the modem context before the underlying network socket attempts to open a connection.
`void`	`willSecure()`	Lifecycle callback invoked by the modem context before the underlying network socket establishes a secure connection.
`<O2 extends O> void`	`write(MqttPacket<O2> packet)`

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

- Field Detail
  - socket
```
protected final MqttSocket<I,O> socket
```
  - mqttSettings
```
protected final MqttSettings mqttSettings
```
  - context
```
protected IpModemContext<Object,Object> context
```
- Constructor Detail
  - MqttSocketModem
```
public MqttSocketModem(MqttSocket<I,O> socket,
                       MqttSettings mqttSettings)
```
- Method Detail
  - ipModemContext
```
public IpModemContext<Object,Object> ipModemContext()
```
    Description copied from interface: IpModem
    
    Returns the socket modem context to which this IpModem is bound; returns null if this IpModem is unbound.
    
    Specified by:
    
    ipModemContext in interface IpModem<I,O>
  - setIpModemContext
```
public void setIpModemContext(IpModemContext<Object,Object> context)
```
    Description copied from interface: IpModem
    
    Sets the socket modem context to which this IpModem is bound.
    
    Specified by:
    
    setIpModemContext in interface IpModem<I,O>
  - idleTimeout
```
public long idleTimeout()
```
    Description copied from interface: IpModem
    
    Returns the number of idle milliseconds after which this IpModem 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 IpModem<I,O>
  - doRead
```
public void doRead()
```
    Description copied from interface: IpModem
    
    I/O callback invoked by the modem context asking this IpModem to provide an input Decoder by invoking the modem context's read method. The modem context will asynchronously feed input data to the provided read Decoder 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 read Decoder. May be invoked concurrently to other I/O callbacks, but never concurrently with other doRead or didRead calls.
    
    Specified by:
    
    doRead in interface IpModem<I,O>
  - didRead
```
public void didRead(Object input)
```
    Description copied from interface: IpModem
    
    I/O callback invoked by the modem context with the completed value of the current read Decoder after it has transitioned to the done state. May be invoked concurrently to other I/O callbacks, but never concurrently with other doRead or didRead calls.
    
    Specified by:
    
    didRead in interface IpModem<I,O>
  - doWrite
```
public void doWrite()
```
    Description copied from interface: IpModem
    
    I/O callback invoked by the modem context asking this IpModem to provide an output Encoder by invoking the modem context's write method. The modem context will asynchronously pull output data from the provided write Encoder 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 write Encoder. May be invoked concurrently to other I/O callbacks, but never concurrently with other doWrite or didWrite calls.
    
    Specified by:
    
    doWrite in interface IpModem<I,O>
  - didWrite
```
public void didWrite(Object output)
```
    Description copied from interface: IpModem
    
    I/O callback invoked by the modem context with the completed value of the current write Encoder after it has transitioned to the done state. May be invoked concurrently to other I/O callbacks, but never concurrently with other dodWrite or didWrite calls.
    
    Specified by:
    
    didWrite in interface IpModem<I,O>
  - 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 interface IpModem<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 interface IpModem<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 interface IpModem<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.
    
    Specified by:
    
    didSecure in interface IpModem<I,O>
  - willBecome
```
public void willBecome(IpSocket socket)
```
    Description copied from interface: IpModem
    
    Lifecycle callback invoked by the modem context before it has become a new socket implementation.
    
    Specified by:
    
    willBecome in interface IpModem<I,O>
  - didBecome
```
public void didBecome(IpSocket socket)
```
    Description copied from interface: IpModem
    
    Lifecycle callback invoked by the modem context after it has become a new socket implementation.
    
    Specified by:
    
    didBecome in interface IpModem<I,O>
  - 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 interface IpModem<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 interface IpModem<I,O>
  - didFail
```
public void didFail(Throwable error)
```
    Description copied from interface: IpModem
    
    Lifecycle callback invoked by the modem context when the underlying network socket fails by throwing an error. The modem will automatically be closed.
    
    Specified by:
    
    didFail in interface IpModem<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
  - mqttSettings
```
public MqttSettings mqttSettings()
```
    Specified by:
    
    mqttSettings in interface MqttSocketContext<I,O>
  - read
```
public <I2 extends I> void read(Decoder<I2> content)
```
    Specified by:
    
    read in interface MqttSocketContext<I,O>
  - write
```
public <O2 extends O> void write(MqttPacket<O2> packet)
```
    Specified by:
    
    write in interface MqttSocketContext<I,O>
  - become
```
public void become(IpSocket socket)
```
    Specified by:
    
    become in interface MqttSocketContext<I,O>
  - close
```
public void close()
```
    Specified by:
    
    close in interface MqttSocketContext<I,O>

Modifier and Type	Field	Description
`protected IpModemContext<Object,Object>`	`context`
`protected MqttSettings`	`mqttSettings`
`protected MqttSocket<I,O>`	`socket`

Class MqttSocketModem<I,​O>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

socket

mqttSettings

context

Constructor Detail

MqttSocketModem

Method Detail

ipModemContext

setIpModemContext

idleTimeout

doRead

didRead

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

mqttSettings

read

write

become

close

Class MqttSocketModem<I,O>