Package de.uplanet.lucy.server.mqtt.workflow

Class QOS

java.lang.Object

de.uplanet.lucy.server.mqtt.workflow.QOS

@ConstantClass
public final class QOS
extends Object

Quality of service as defined in the MQTT specification.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	AT_LEAST_ONCE_DELIVERY	QoS 1: At least once delivery.
static final int	AT_MOST_ONCE_DELIVERY	QoS 0: At most once delivery.
static final int	EXACTLY_ONCE_DELIVERY	QoS 2: Exactly once delivery.

Method Summary

Modifier and Type	Method	Description
static int	checkValidQoS(int p_iQoS)	Check if the given value is valid according to the specification.
static boolean	isValidQoS(int p_iQoS)	Test if the given value is valid according to the specification.

Methods inherited from class java.lang.Object

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

Field Details

AT_MOST_ONCE_DELIVERY

public static final int AT_MOST_ONCE_DELIVERY

QoS 0: At most once delivery.

See Also:

• Constant Field Values

AT_LEAST_ONCE_DELIVERY

public static final int AT_LEAST_ONCE_DELIVERY

QoS 1: At least once delivery.

See Also:

• Constant Field Values

EXACTLY_ONCE_DELIVERY

public static final int EXACTLY_ONCE_DELIVERY

QoS 2: Exactly once delivery.

See Also:

• Constant Field Values

Method Details

checkValidQoS

public static int checkValidQoS(int p_iQoS)
                         throws WorkflowConfigurationException

Check if the given value is valid according to the specification.

Parameters:

p_iQoS - The value to be tested.

Returns:

The given value.

Throws:

WorkflowConfigurationException - If the given value is not a valid QoS.

isValidQoS

public static boolean isValidQoS(int p_iQoS)

Test if the given value is valid according to the specification.

Parameters:

p_iQoS - The value to be tested.

Returns:

true if the given value is a valid QoS value, or false otherwise.