org.eclipse.californium.scandium.dtls

Class RecordSizeLimitExtension

java.lang.Object

org.eclipse.californium.scandium.dtls.HelloExtension

org.eclipse.californium.scandium.dtls.RecordSizeLimitExtension

public final class RecordSizeLimitExtension
extends HelloExtension

Record size limit extension.

See RFC 8449 for additional details.

Since:

2.4

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.californium.scandium.dtls.HelloExtension

HelloExtension.ExtensionType

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_RECORD_SIZE_LIMIT Maximum value for record size limit.
static int	MIN_RECORD_SIZE_LIMIT Minimum value for record size limit.

Fields inherited from class org.eclipse.californium.scandium.dtls.HelloExtension

LENGTH_BITS, TYPE_BITS

Constructor Summary

Constructors

Constructor and Description
RecordSizeLimitExtension(int recordSizeLimit) Create record size limit extension.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addExtensionData(org.eclipse.californium.elements.util.DatagramWriter writer) Adds binary encoding of this extension's data.
static int	ensureInRange(int recordSizeLimit) Ensure, that provided record limit is between MIN_RECORD_SIZE_LIMIT and MAX_RECORD_SIZE_LIMIT.
static RecordSizeLimitExtension	fromExtensionDataReader(org.eclipse.californium.elements.util.DatagramReader extensionDataReader, InetSocketAddress peerAddress) Create record size limit extension from extensions data bytes.
int	getLength() Gets the overall length of this extension's corresponding Extension struct.
int	getRecordSizeLimit() Get record size limit.

Methods inherited from class org.eclipse.californium.scandium.dtls.HelloExtension

fromExtensionDataReader, toByteArray, toString

Methods inherited from class java.lang.Object

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

Field Detail

MIN_RECORD_SIZE_LIMIT

public static final int MIN_RECORD_SIZE_LIMIT

Minimum value for record size limit.

See Also:

Constant Field Values

MAX_RECORD_SIZE_LIMIT

public static final int MAX_RECORD_SIZE_LIMIT

Maximum value for record size limit.

See Also:

Constant Field Values

Constructor Detail

RecordSizeLimitExtension

public RecordSizeLimitExtension(int recordSizeLimit)

Create record size limit extension.

Parameters:

recordSizeLimit - record size limit

Method Detail

getRecordSizeLimit

public int getRecordSizeLimit()

Get record size limit.

Returns:

record size limit

getLength

public int getLength()

Description copied from class: HelloExtension

Gets the overall length of this extension's corresponding Extension struct.

Note that this includes the 2 bytes indicating the extension type.

Specified by:

getLength in class HelloExtension

Returns:

the length in bytes

addExtensionData

protected void addExtensionData(org.eclipse.californium.elements.util.DatagramWriter writer)

Description copied from class: HelloExtension

Adds binary encoding of this extension's data.

This implementation does not do anything. Sub-classes should override this method and use the passed-in writer to add their extension_data bytes to the Extension data structure.

NB: Subclasses MUST NOT write the extension's type code to the writer as this will already have been done by the HelloExtension.toByteArray() method.

Specified by:

addExtensionData in class HelloExtension

Parameters:

writer - the writer to use for serialization

fromExtensionDataReader

public static RecordSizeLimitExtension fromExtensionDataReader(org.eclipse.californium.elements.util.DatagramReader extensionDataReader,
                                               InetSocketAddress peerAddress)
                                                        throws HandshakeException

Create record size limit extension from extensions data bytes.

Parameters:

extensionDataReader - extension data bytes

peerAddress - peer address

Returns:

created record size limit extension

Throws:

NullPointerException - if extensionData is null

HandshakeException - if the extension data could not be decoded

ensureInRange

public static int ensureInRange(int recordSizeLimit)

Ensure, that provided record limit is between MIN_RECORD_SIZE_LIMIT and MAX_RECORD_SIZE_LIMIT.

Parameters:

recordSizeLimit - record size limit to ensure, that the value is in range.

Returns:

RecordSizeLimitExtension the provided value, if in range

Throws:

IllegalArgumentException - if value is not in range