akka.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

Modifier and Type	Method and Description
java.lang.String	getErrorCause() If isErrorClosed returns true, then the error condition can be retrieved by this method.
boolean	isAborted() true iff the connection has been closed in response to an Abort command.
boolean	isConfirmed() true iff the connection has been fully closed in response to a ConfirmedClose command.
boolean	isErrorClosed() true iff the connection has been closed due to an IO error.
boolean	isPeerClosed() true iff the connection has been closed by the peer; in case keepOpenOnPeerClosed is in effect as per the Tcp.Register command, this connection’s reading half is now closed.

Method Detail

isAborted

boolean isAborted()

true iff the connection has been closed in response to an Abort command.

Returns:

(undocumented)

isConfirmed

boolean isConfirmed()

true iff the connection has been fully closed in response to a ConfirmedClose command.

Returns:

(undocumented)

isPeerClosed

boolean isPeerClosed()

true iff the connection has been closed by the peer; in case keepOpenOnPeerClosed is in effect as per the Tcp.Register command, this connection’s reading half is now closed.

Returns:

(undocumented)

isErrorClosed

boolean isErrorClosed()

true iff the connection has been closed due to an IO error.

Returns:

(undocumented)

getErrorCause

java.lang.String getErrorCause()

If isErrorClosed returns true, then the error condition can be retrieved by this method.

Returns:

(undocumented)