ConnectFlags

The Connect Flags byte contains a number of parameters specifying the behavior of the MQTT connection. It also indicates the presence or absence of fields in the payload.

@safe

struct ConnectFlags {

bool userName [@property getter];

bool userName [@property setter];

bool password [@property getter];

bool password [@property setter];

bool willRetain [@property getter];

bool willRetain [@property setter];

QoSLevel willQoS [@property getter];

QoSLevel willQoS [@property setter];

bool will [@property getter];

bool will [@property setter];

bool cleanSession [@property getter];

bool cleanSession [@property setter];

ubyte flags [@property getter];

ubyte flags [@property setter];

this(bool userName, bool password, bool willRetain, QoSLevel willQoS, bool will, bool cleanSession);

this(T value);

}

Constructors

this this(bool userName, bool password, bool willRetain, QoSLevel willQoS, bool will, bool cleanSession): Undocumented in source.
this this(T value): Undocumented in source.

Alias This

flags

Members

Properties

cleanSession bool cleanSession [@property setter]: This bit specifies the handling of the Session state. The Client and Server can store Session state to enable reliable messaging to continue across a sequence of Network Connections. This bit is used to control the lifetime of the Session state.
cleanSession bool cleanSession [@property getter]: This bit specifies the handling of the Session state. The Client and Server can store Session state to enable reliable messaging to continue across a sequence of Network Connections. This bit is used to control the lifetime of the Session state.
flags ubyte flags [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
flags ubyte flags [@property setter]: Undocumented in source. Be warned that the author may not have intended to support it.
password bool password [@property getter]
bool password [@property setter]: If the Password Flag is set to 0, a password MUST NOT be present in the payload. If the Password Flag is set to 1, a password MUST be present in the payload. If the User Name Flag is set to 0, the Password Flag MUST be set to 0.
userName bool userName [@property getter]
bool userName [@property setter]: If the User Name Flag is set to 0, a user name MUST NOT be present in the payload. If the User Name Flag is set to 1, a user name MUST be present in the payload.
will bool will [@property getter]
bool will [@property setter]: If the Will Flag is set to 1 this indicates that, if the Connect request is accepted, a Will Message MUST be stored on the Server and associated with the Network Connection. The Will Message MUST be published when the Network Connection is subsequently closed unless the Will Message has been deleted by the Server on receipt of a DISCONNECT Packet.
willQoS QoSLevel willQoS [@property getter]
QoSLevel willQoS [@property setter]: Specify the QoS level to be used when publishing the Will Message.
willRetain bool willRetain [@property getter]
bool willRetain [@property setter]: This bit specifies if the Will Message is to be Retained when it is published.

ConnectFlags

Constructors

Alias This

Members

Properties

Meta

Source