Package org.apache.activemq.transport.mqtt

Class MQTTWireFormat

java.lang.Object

org.apache.activemq.transport.mqtt.MQTTWireFormat

All Implemented Interfaces:

WireFormat

public class MQTTWireFormat
extends Object
implements WireFormat

Implements marshalling and unmarsalling the MQTT protocol.

Constructor Summary

Constructors

Constructor	Description
MQTTWireFormat()

Method Summary

Modifier and Type	Method	Description
long	getConnectAttemptTimeout()
int	getMaxFrameSize()
int	getVersion()
ByteSequence	marshal(Object command)	Packet based marshaling
void	marshal(Object command, DataOutput dataOut)	Stream based marshaling
void	setConnectAttemptTimeout(long connectTimeout)	Sets the timeout value used to fail a connection if no CONNECT frame is read in the given interval.
void	setMaxFrameSize(int maxFrameSize)	Sets the maximum frame size for an incoming MQTT frame.
void	setVersion(int version)
Object	unmarshal(DataInput dataIn)	Packet based un-marshaling
Object	unmarshal(ByteSequence packet)	Packet based un-marshaling

Methods inherited from class java.lang.Object

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

Constructor Detail

MQTTWireFormat

public MQTTWireFormat()

Method Detail

marshal

public ByteSequence marshal(Object command)
                     throws IOException

Description copied from interface: WireFormat

Packet based marshaling

Specified by:

marshal in interface WireFormat

Throws:

IOException

unmarshal

public Object unmarshal(ByteSequence packet)
                 throws IOException

Description copied from interface: WireFormat

Packet based un-marshaling

Specified by:

unmarshal in interface WireFormat

Throws:

IOException

marshal

public void marshal(Object command,
                    DataOutput dataOut)
             throws IOException

Description copied from interface: WireFormat

Stream based marshaling

Specified by:

marshal in interface WireFormat

Throws:

IOException

unmarshal

public Object unmarshal(DataInput dataIn)
                 throws IOException

Description copied from interface: WireFormat

Packet based un-marshaling

Specified by:

unmarshal in interface WireFormat

Throws:

IOException

setVersion

public void setVersion(int version)

Specified by:

setVersion in interface WireFormat

Parameters:

version - the version of the wire format

getVersion

public int getVersion()

Specified by:

getVersion in interface WireFormat

Returns:

the version of the wire format

getMaxFrameSize

public int getMaxFrameSize()

Returns:

the maximum number of bytes a single MQTT message frame is allowed to be.

setMaxFrameSize

public void setMaxFrameSize(int maxFrameSize)

Sets the maximum frame size for an incoming MQTT frame. The protocl limit is 256 megabytes and this value cannot be set higher.

Parameters:

maxFrameSize - the maximum allowed frame size for a single MQTT frame.

getConnectAttemptTimeout

public long getConnectAttemptTimeout()

Returns:

the timeout value used to fail a connection if no CONNECT frame read.

setConnectAttemptTimeout

public void setConnectAttemptTimeout(long connectTimeout)

Sets the timeout value used to fail a connection if no CONNECT frame is read in the given interval.

Parameters:

connectTimeout - the connection frame received timeout value.