ru.dz.mqtt_udp.util

Class GenericPacket

java.lang.Object

ru.dz.mqtt_udp.util.GenericPacket

All Implemented Interfaces:

IPacket

Direct Known Subclasses:

PingReqPacket, PingRespPacket, TopicPacket

public abstract class GenericPacket
extends Object
implements IPacket

Network IO work horse for MQTT/UDP packets.

Author:

dz

Field Summary

Fields

Modifier and Type	Field and Description
protected byte	flags Packet header flags.
protected IPacketAddress	from Packet source address, if packet is received from net.

Fields inherited from interface ru.dz.mqtt_udp.IPacket

MQTT_CHARSET, pTYpeNames

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GenericPacket() Construct packet to be sent.
protected	GenericPacket(IPacketAddress from) Construct packet from network.

Method Summary

Modifier and Type	Method and Description
IPacket	applyTTRs(Collection<TaggedTailRecord> ttrs) Internal use only.
byte	getFlags() Get packet flags.
IPacketAddress	getFrom() Get packet sender address.
Optional<Integer>	getPacketNumber()
Optional<Integer>	getReplyToPacketNumber()
boolean	isSigned() Packet with valid signature?
static IPacket	recv(DatagramSocket s) Wait for packet to come in.
static DatagramSocket	recvSocket() Create new socket to listen to MQTT/UDP packets.
void	send() Broadcast me using default send socket.
void	send(DatagramSocket sock) Broadcast me using given socket.
void	send(DatagramSocket sock, InetAddress address) Send me to given address.
void	send(InetAddress addr) Send me using default send socket.
void	setPacketNumber(int packetNumber)
void	setReplyToPacketNumber(int replyToPacketNumber)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface ru.dz.mqtt_udp.IPacket

decodeTopicLen, decodeTTRs, encodeTotalLength, encodeTTR, fromBytes, getPacketTypeName, getType, toBytes

Field Detail

flags

protected byte flags

Packet header flags.

from

protected IPacketAddress from

Packet source address, if packet is received from net. Locally created ones have null here.

Constructor Detail

GenericPacket

protected GenericPacket(IPacketAddress from)

Construct packet from network.

Parameters:

from - Sender's address.

GenericPacket

protected GenericPacket()

Construct packet to be sent.

Method Detail

recvSocket

public static DatagramSocket recvSocket()
                                 throws SocketException

Create new socket to listen to MQTT/UDP packets.

Returns:

Created socket.

Throws:

SocketException - If unable.

send

public void send()
          throws IOException

Broadcast me using default send socket.

Throws:

IOException - If unable.

send

public void send(InetAddress addr)
          throws IOException

Send me using default send socket.

Parameters:

addr - Where to send to.

Throws:

IOException - If unable.

send

public void send(DatagramSocket sock)
          throws IOException

Broadcast me using given socket.

Parameters:

sock - Socket must be made with sendSocket() method.

Throws:

IOException - If unable.

send

public void send(DatagramSocket sock,
                 InetAddress address)
          throws IOException

Send me to given address.

Parameters:

sock - Socket must be made with sendSocket() method.

address - Host to send to

Throws:

IOException - If unable.

recv

public static IPacket recv(DatagramSocket s)
                    throws IOException,
                           MqttProtocolException

Wait for packet to come in.

Parameters:

s - Socket to use.

Returns:

Packet received.

Throws:

SocketException - As is.

IOException - As is.

MqttProtocolException - What we got is not a valid MQTT/UDP packet.

getFrom

public IPacketAddress getFrom()

Description copied from interface: IPacket

Get packet sender address.

Specified by:

getFrom in interface IPacket

Returns:

IP address.

getFlags

public byte getFlags()

Get packet flags. QoS, etc.

Returns:

Flags bit field.

toString

public String toString()

Overrides:

toString in class Object

applyTTRs

public IPacket applyTTRs(Collection<TaggedTailRecord> ttrs)

Internal use only.

Apply data from TTRs to constructed packet.

Parameters:

ttrs - Tagged Tail Records to apply

Returns:

Self

getReplyToPacketNumber

public Optional<Integer> getReplyToPacketNumber()

setReplyToPacketNumber

public void setReplyToPacketNumber(int replyToPacketNumber)

getPacketNumber

public Optional<Integer> getPacketNumber()

setPacketNumber

public void setPacketNumber(int packetNumber)

isSigned

public boolean isSigned()

Description copied from interface: IPacket

Packet with valid signature?

Specified by:

isSigned in interface IPacket

Returns:

true if it has valid digital signature.