Package org.apache.pekko.io
Interface Tcp.ConnectionClosed
-
- All Superinterfaces:
DeadLetterSuppression,NoSerializationVerificationNeeded,Tcp.Event,Tcp.Message
- All Known Implementing Classes:
Tcp.Aborted$,Tcp.Closed$,Tcp.ConfirmedClosed$,Tcp.ErrorClosed,Tcp.PeerClosed$
- Enclosing class:
- Tcp
public static interface Tcp.ConnectionClosed extends Tcp.Event, DeadLetterSuppression
This is the common interface for all events which indicate that a connection has been closed or half-closed.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.StringgetErrorCause()IfisErrorClosedreturns true, then the error condition can be retrieved by this method.booleanisAborted()trueiff the connection has been closed in response to anAbortcommand.booleanisConfirmed()trueiff the connection has been fully closed in response to aConfirmedClosecommand.booleanisErrorClosed()trueiff the connection has been closed due to an IO error.booleanisPeerClosed()trueiff the connection has been closed by the peer; in casekeepOpenOnPeerClosedis in effect as per theTcp.Registercommand, this connection’s reading half is now closed.
-
-
-
Method Detail
-
getErrorCause
java.lang.String getErrorCause()
IfisErrorClosedreturns true, then the error condition can be retrieved by this method.
-
isAborted
boolean isAborted()
trueiff the connection has been closed in response to anAbortcommand.
-
isConfirmed
boolean isConfirmed()
trueiff the connection has been fully closed in response to aConfirmedClosecommand.
-
isErrorClosed
boolean isErrorClosed()
trueiff the connection has been closed due to an IO error.
-
isPeerClosed
boolean isPeerClosed()
trueiff the connection has been closed by the peer; in casekeepOpenOnPeerClosedis in effect as per theTcp.Registercommand, this connection’s reading half is now closed.
-
-