Struct Disconnect

pub struct Disconnect {
    pub reason_code: ReasonCode,
    pub session_expiry_interval: Option<u32>,
    pub reason_string: Option<String>,
    pub user_properties: Vec<(String, String)>,
    pub reference: Option<String>,
}

A Disconnect packet can be sent by the client or the server to gracefully disconnect.

Fields

reason_code: ReasonCode

The reason code code the Disconnect notice.can be any of:

• Client or Server
  • AdministrativeAction
  • ImplementationSpecificError
  • MalformedPacket
  • MessageRateTooHigh
  • NormalDisconnection
  • PacketTooLarge
  • PayloadFormatInvalid
  • ProtocolError
  • QuotaExceeded
  • ReceiveMaximumExceeded
  • TopicAliasInvalid
  • TopicNameInvalid
  • UnspecifiedError
• Server Only
  • ConnectionRateExceeded
  • KeepAliveTimeout
  • MaximumConnectTime
  • NotAuthorized
  • QoSNotSupported
  • RetainNotSupported
  • ServerBusy
  • ServerMoved
  • ServerShuttingDown
  • SessionTakenOver
  • SharedSubscriptionsNotSupported
  • SubscriptionIdentifiersNotSupported
  • TopicFilterInvalid
  • UseAnotherServer
  • WildcardSubscriptionsNotSupported
• Client Only
  • DisconnectWithWillMessage

session_expiry_interval: Option<u32>

session_expiry_interval can be used to override the session expiry period formerly set upon connection. If not present, the session expiry interval value set using Connect or Connack is still in use.

reason_string: Option<String>

An optional descriptin of the reason for deconnecting.

user_properties: Vec<(String, String)>

General purpose user properties.

reference: Option<String>

If the reason code is ServerMoved or UserAnotherServer, the reference field is used to inform the client about why new server to connect to instead.

Trait Implementations

impl Clone for Disconnect

fn clone(&self) -> Disconnect

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Disconnect

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Disconnect

fn default() -> Self

Returns the “default value” for a type.

impl From<Disconnect> for Packet

fn from(control: Disconnect) -> Self

Converts to this type from the input type.

impl PartialEq for Disconnect

fn eq(&self, other: &Disconnect) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Disconnect