Enum Protocol

pub enum Protocol {
    V5(Protocol),
    None,
}

Enumerated list of supported message-queue protocol.

Variants

V5(Protocol)

None

Implementations

impl Protocol

pub fn is_listen(&self) -> bool

Whether to launch a listener for this protocol. Broker side configuration.

pub fn to_listen_address(&self) -> SocketAddr

Listen socket-address for this protocol. Broker side configuration.

pub fn to_listen_port(&self) -> u16

Listen port for this protocol. Broker side configuration.

pub fn maximum_qos(&self) -> QoS

Maximum supported QoS by this protocol. Broker side configuration.

pub fn retain_available(&self) -> bool

Whether publish-retain feature is supported by this protocol. Broker side configuration.

pub fn max_packet_size(&self) -> u32

Maximum packet size allowed by this protocol. Broker side configuration.

pub fn keep_alive(&self) -> Option<u16>

Keep alive, in seconds, ticker supported by this protocol. Broker side configuration.

pub fn keep_alive_factor(&self) -> f32

Keep alive factor, configured for this protocol. Broker side configuration.

pub fn topic_alias_max(&self) -> Option<u16>

Whether topic-alias feature is supported and its configuration for this protocol. Broker side configuration.

impl Protocol

pub fn handshake(&self, prefix: &str, conn: TcpStream) -> Result<Socket>

Handshake with remote client and complete the connection process.

impl Protocol

pub fn new_ping_resp(&self, ping_req: QPacket) -> QPacket

Create a new ping-response packet.

pub fn new_pub_ack(&self, packet_id: PacketID) -> QPacket

Create a new publish acknowledge packet.

pub fn new_sub_ack(&self, sub: &QPacket, rcodes: Vec<ReasonCode>) -> QPacket

Create a new subscribe acknowledge packet.

pub fn new_unsub_ack(&self, unsub: &QPacket, rcodes: Vec<ReasonCode>) -> QPacket

Create a new un-subscribe acknowledge packet.

Trait Implementations

impl Clone for Protocol

fn clone(&self) -> Protocol

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Protocol

fn default() -> Protocol

Returns the “default value” for a type.

impl From<Protocol> for Protocol

fn from(proto: Protocol) -> Protocol

Converts to this type from the input type.

impl PartialEq for Protocol

fn eq(&self, other: &Protocol) -> 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 Eq for Protocol

impl StructuralPartialEq for Protocol