org.eclipse.californium.scandium.dtls

Class MultiHandshakeMessage

java.lang.Object

org.eclipse.californium.scandium.dtls.AbstractMessage

org.eclipse.californium.scandium.dtls.HandshakeMessage

org.eclipse.californium.scandium.dtls.MultiHandshakeMessage

All Implemented Interfaces:

DTLSMessage

public class MultiHandshakeMessage
extends HandshakeMessage

Multi handshake messages. Accumulate multi handshake messages to be sent as one dtls record.

Since:

2.4

Field Summary

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

FRAGMENT_LENGTH_BITS, FRAGMENT_OFFSET_BITS, MESSAGE_HEADER_LENGTH_BYTES, MESSAGE_LENGTH_BITS, MESSAGE_SEQ_BITS, MESSAGE_TYPE_BITS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MultiHandshakeMessage(InetSocketAddress peerAddress) Create multi handshake message.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(HandshakeMessage message) Add handshake message.
byte[]	fragmentToByteArray() The serialization of the handshake body (without the handshake header).
int	getMessageLength() Must be implemented by each subclass.
HandshakeType	getMessageType() Returns the type of the handshake message.
int	getNumberOfHandshakeMessages() Get number of added handshake messages.
byte[]	toByteArray() Returns the raw binary representation of the handshake message.

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

fragmentChanged, fromByteArray, fromGenericHandshakeMessage, getContentType, getFragmentLength, getFragmentOffset, getMessageSeq, getNextHandshakeMessage, getRawMessage, setMessageSeq, setNextHandshakeMessage, size, toString, writeTo

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

getPeer

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiHandshakeMessage

protected MultiHandshakeMessage(InetSocketAddress peerAddress)

Create multi handshake message.

Parameters:

peerAddress - address of peer

Method Detail

getNumberOfHandshakeMessages

public int getNumberOfHandshakeMessages()

Get number of added handshake messages.

Returns:

number of added handshake messages

add

public void add(HandshakeMessage message)

Add handshake message.

Parameters:

message - additional handshake message

getMessageType

public HandshakeType getMessageType()

Description copied from class: HandshakeMessage

Returns the type of the handshake message. See HandshakeType.

Specified by:

getMessageType in class HandshakeMessage

Returns:

the HandshakeType.

getMessageLength

public int getMessageLength()

Description copied from class: HandshakeMessage

Must be implemented by each subclass. The length is given in bytes and only includes the length of the subclass' specific fields (not the handshake message header).

Specified by:

getMessageLength in class HandshakeMessage

Returns:

the length of the message in bytes.

fragmentToByteArray

public byte[] fragmentToByteArray()

Description copied from class: HandshakeMessage

The serialization of the handshake body (without the handshake header). Must be implemented by each subclass. Except the ClientHello, the fragments are considered to be not modified. If a modification is required, call HandshakeMessage.fragmentChanged().

Specified by:

fragmentToByteArray in class HandshakeMessage

Returns:

the raw byte representation of the handshake body.

toByteArray

public byte[] toByteArray()

Description copied from class: HandshakeMessage

Returns the raw binary representation of the handshake message. for incoming messages this it the same as HandshakeMessage.getRawMessage(). For outgoing messages the header is generated by this method and the subclasses are responsible for the specific rest of the payload / fragment. The result is only created once at the first call. Following calls will get the same bytes until HandshakeMessage.fragmentChanged() gets called.

Specified by:

toByteArray in interface DTLSMessage

Overrides:

toByteArray in class HandshakeMessage

Returns:

the byte representation of the handshake message.

See Also:

HandshakeMessage.byteArray, HandshakeMessage.fragmentToByteArray(), HandshakeMessage.fragmentChanged()