org.eclipse.californium.scandium.dtls

Class DtlsException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.eclipse.californium.scandium.dtls.DtlsException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ConnectionEvictedException, DtlsHandshakeException, DtlsHandshakeTimeoutException

public class DtlsException
extends RuntimeException

DtlsException is the superclass of those exceptions that can be thrown in the context of a DTLS connection with a peer.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DtlsException(String message, InetSocketAddress peer) Constructs a new DTLS exception with the specified detail message and peer address.
DtlsException(String message, InetSocketAddress peer, Throwable cause) Constructs a new DTLS exception with the specified detail message, peer address and cause.

Method Summary

Methods

Modifier and Type	Method and Description
InetSocketAddress	getPeer() The IP and port of the peer of the DTLS connection.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DtlsException

public DtlsException(String message,
             InetSocketAddress peer)

Constructs a new DTLS exception with the specified detail message and peer address.

Parameters:

message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).

peer - the IP address and port of the DTLS connection peer

DtlsException

public DtlsException(String message,
             InetSocketAddress peer,
             Throwable cause)

Constructs a new DTLS exception with the specified detail message, peer address and cause.

Note that the detail message associated with cause is not automatically incorporated in this DTLS exception's detail message.

Parameters:

message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).

peer - the IP address and port of the DTLS connection peer

cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

Method Detail

getPeer

public final InetSocketAddress getPeer()

The IP and port of the peer of the DTLS connection.

This exception has occurred in the context of a connection with the peer identified by the returned address.

Before 2.3, behavior about returning null was undefined.
Since 2.3, this method can return null because the attached connection could have lost its peer address (E.g. the peer address is assigned to another connection).

Returns:

the address or null if DTLS connection has no more peer address attached.