ru.dz.mqtt_udp

Interface IPacket

All Known Implementing Classes:

GenericPacket, PingReqPacket, PingRespPacket, PublishPacket, SubscribePacket, TopicPacket

public interface IPacket

Interface of general MQTT/UDP packet.

Author:

dz

Field Summary

Fields

Modifier and Type	Field and Description
static String	MQTT_CHARSET MQTT/UDP character set
static String[]	pTYpeNames

Method Summary

Modifier and Type	Method and Description
static int	decodeTopicLen(byte[] pkt) Decode 2-byte string length.
static Collection<TaggedTailRecord>	decodeTTRs(byte[] raw, int total_len, int headerEnd, int recvLen)
static byte[]	encodeTotalLength(byte[] pkt, int packetType, byte flags, AbstractCollection<TaggedTailRecord> ttr) Rename to encodePacketHeader?
static byte[]	encodeTTR(AbstractCollection<TaggedTailRecord> ttrs, byte[] packetBeginning) Have 'classic' MQTT packet at input, extend it with Tagged Tail Records.
static IPacket	fromBytes(byte[] raw, IPacketAddress from) Construct packet object from binary data (recvd from net).
IPacketAddress	getFrom() Get packet sender address.
static String	getPacketTypeName(int packetType) Get packet type name.
int	getType() Get packet type byte, as sent over the net (& 0xF0).
byte[]	toBytes() Generate network representation of packet to be sent.

Field Detail

MQTT_CHARSET

static final String MQTT_CHARSET

MQTT/UDP character set

See Also:

Constant Field Values

pTYpeNames

static final String[] pTYpeNames

Method Detail

toBytes

byte[] toBytes()

Generate network representation of packet to be sent.

Returns:

UDP packet contents.

getFrom

IPacketAddress getFrom()

Get packet sender address.

Returns:

IP address.

getType

int getType()

Get packet type byte, as sent over the net (& 0xF0).

Returns:

Packet type byte.

fromBytes

static IPacket fromBytes(byte[] raw,
                         IPacketAddress from)
                  throws MqttProtocolException

Construct packet object from binary data (recvd from net).

Parameters:

raw - binary data from UDP packet

from - source address

Returns:

Packet object

Throws:

MqttProtocolException - on incorrect binary packet data

decodeTTRs

static Collection<TaggedTailRecord> decodeTTRs(byte[] raw,
                                               int total_len,
                                               int headerEnd,
                                               int recvLen)
                                        throws MqttProtocolException

Throws:

MqttProtocolException

decodeTopicLen

static int decodeTopicLen(byte[] pkt)

Decode 2-byte string length.

Parameters:

pkt - Binary packet data.

Returns:

Decoded length.

encodeTotalLength

static byte[] encodeTotalLength(byte[] pkt,
                                int packetType,
                                byte flags,
                                AbstractCollection<TaggedTailRecord> ttr)

Rename to encodePacketHeader? Encode total packet length. Encoded as variable length byte sequence, 7 bits per byte.

Parameters:

pkt - packet payload bytes

packetType - type ( & 0xF0 )

flags - flags

ttr - TTRs to encode to packet

Returns:

encoded packet to send to UDP

encodeTTR

static byte[] encodeTTR(AbstractCollection<TaggedTailRecord> ttrs,
                        byte[] packetBeginning)

Have 'classic' MQTT packet at input, extend it with Tagged Tail Records.

Add packet number if one is missing. Add signature.

Parameters:

ttrs - Collection of TTRs to add.

packetBeginning - Classic packet.

Returns:

Extended packet.

getPacketTypeName

static String getPacketTypeName(int packetType)

Get packet type name.

Parameters:

packetType - as in incoming byte (& 0xF0).

Returns:

Type string.