public interface Connection extends Closeable
A Connection
is associated to an EndPoint
so that I/O events
happening on the EndPoint
can be processed by the Connection
.
A typical implementation of Connection
overrides onOpen()
to
set read interest
on the EndPoint
,
and when the EndPoint
signals read readyness, this Connection
can
read bytes from the network and interpret them.
Modifier and Type | Interface and Description |
---|---|
static interface |
Connection.Listener
A Listener for connection events.
|
static interface |
Connection.UpgradeFrom |
static interface |
Connection.UpgradeTo |
Modifier and Type | Method and Description |
---|---|
void |
addListener(Connection.Listener listener)
Adds a listener of connection events.
|
void |
close()
Performs a logical close of this connection.
|
long |
getBytesIn() |
long |
getBytesOut() |
long |
getCreatedTimeStamp() |
EndPoint |
getEndPoint() |
long |
getMessagesIn() |
long |
getMessagesOut() |
void |
onClose()
Callback method invoked when this connection is closed.
|
boolean |
onIdleExpired()
Callback method invoked upon an idle timeout event.
|
void |
onOpen()
Callback method invoked when this connection is opened.
|
void |
removeListener(Connection.Listener listener)
Removes a listener of connection events.
|
void addListener(Connection.Listener listener)
Adds a listener of connection events.
listener
- the listener to addvoid removeListener(Connection.Listener listener)
Removes a listener of connection events.
listener
- the listener to removevoid onOpen()
Callback method invoked when this connection is opened.
Creators of the connection implementation are responsible for calling this method.
void onClose()
Callback method invoked when this connection is closed.
Creators of the connection implementation are responsible for calling this method.
void close()
Performs a logical close of this connection.
For simple connections, this may just mean to delegate the close to the associated
EndPoint
but, for example, SSL connections should write the SSL close message
before closing the associated EndPoint
.
close
in interface AutoCloseable
close
in interface Closeable
boolean onIdleExpired()
Callback method invoked upon an idle timeout event.
Implementations of this method may return true to indicate that the idle timeout handling should proceed normally, typically failing the EndPoint and causing it to be closed.
When false is returned, the handling of the idle timeout event is halted immediately and the EndPoint left in the state it was before the idle timeout event.
long getMessagesIn()
long getMessagesOut()
long getBytesIn()
long getBytesOut()
long getCreatedTimeStamp()
Copyright © 2010 - 2020 Adobe. All Rights Reserved