public interface LogicalConnection extends OutgoingFrames, SuspendToken
Modifier and Type | Method and Description |
---|---|
boolean |
canReadWebSocketFrames()
Test if Connection State allows for reading of frames.
|
boolean |
canWriteWebSocketFrames()
Test if Connection State allows for writing frames.
|
void |
close(CloseInfo closeInfo,
Callback callback)
Request a local close.
|
void |
close(Throwable cause)
Close the connection based on the cause.
|
void |
disconnect()
Terminate the connection (no close frame sent)
|
ByteBufferPool |
getBufferPool()
Get the ByteBufferPool in use by the connection
|
Executor |
getExecutor()
Get the Executor used by this connection.
|
String |
getId()
Get Unique ID for the Connection
|
long |
getIdleTimeout()
Get the read/write idle timeout.
|
InetSocketAddress |
getLocalAddress()
Get the local
InetSocketAddress in use for this connection. |
long |
getMaxIdleTimeout()
Set the maximum number of milliseconds of idleness before the connection is closed/disconnected, (ie no frames are either sent or received)
|
WebSocketPolicy |
getPolicy()
The policy that the connection is running under.
|
InetSocketAddress |
getRemoteAddress()
Get the remote Address in use for this connection.
|
boolean |
isOpen()
Test if logical connection is still open
|
boolean |
isReading()
Tests if the connection is actively reading.
|
boolean |
opened()
Set the state to opened (the application onOpen() method has been called successfully).
|
boolean |
opening()
Set the state to upgrade/opening handshake has completed.
|
void |
remoteClose(CloseInfo close)
Report that the Remote Endpoint CLOSE Frame has been received
|
void |
setMaxIdleTimeout(long ms)
Set the maximum number of milliseconds of idleness before the connection is closed/disconnected, (ie no frames are either sent or received)
|
void |
setNextIncomingFrames(IncomingFrames incoming)
Set where the connection should send the incoming frames to.
|
void |
setSession(WebSocketSession session)
Associate the Active Session with the connection.
|
SuspendToken |
suspend()
Suspend a the incoming read events on the connection.
|
String |
toStateString()
Get the Connection State as a String
|
outgoingFrame
resume
boolean canReadWebSocketFrames()
boolean canWriteWebSocketFrames()
void close(Throwable cause)
cause
- the causevoid disconnect()
ByteBufferPool getBufferPool()
Executor getExecutor()
String getId()
long getIdleTimeout()
InetSocketAddress getLocalAddress()
InetSocketAddress
in use for this connection.
Note: Non-physical connections, like during the Mux extensions, or during unit testing can result in a InetSocketAddress on port 0 and/or on localhost.
long getMaxIdleTimeout()
void setMaxIdleTimeout(long ms)
This idle timeout cannot be garunteed to take immediate effect for any active read/write actions. New read/write actions will have this new idle timeout.
ms
- the number of milliseconds of idle timeoutWebSocketPolicy getPolicy()
InetSocketAddress getRemoteAddress()
Note: Non-physical connections, like during the Mux extensions, or during unit testing can result in a InetSocketAddress on port 0 and/or on localhost.
boolean isOpen()
boolean isReading()
boolean opened()
Reads from network begin here.
boolean opening()
void remoteClose(CloseInfo close)
close
- the close frame detailsvoid setNextIncomingFrames(IncomingFrames incoming)
Often this is from the Parser to the start of the extension stack, and eventually on to the session.
incoming
- the incoming frames handlervoid setSession(WebSocketSession session)
session
- the session for this connectionSuspendToken suspend()
String toStateString()
Copyright © 2010 - 2020 Adobe. All Rights Reserved