Struct svc_agent::mqtt::Agent

pub struct Agent { /* fields omitted */ }

Methods

impl Agent

pub fn address(&self) -> &Address

pub fn id(&self) -> &AgentId

pub fn publish(
    &mut self,
    message: Box<dyn IntoPublishableDump>
) -> Result<(), Error>

Publish a message.

This method is a shorthand to dump and publish the message with a single call. If you want to print out the dump before or after publishing or assert it in tests consider using IntoPublishableDump::into_dump and publish_dump.

Arguments

• message – a boxed message of any type implementing Publishable trait.

Example

let props = OutgoingRequestProperties::new(
    "system.ping",
    Subscription::unicast_responses_from(to).subscription_topic(agent.id(), "v1")?,
    "random-string-123",
    OutgoingShortTermTimingProperties::new(Utc::now()),
);

let message = OutgoingMessage::new(
    json!({ "ping": "hello" }),
    props,
    Destination::Unicast(agent.id().clone(), "v1"),
);

agent.publish(Box::new(message))?;

pub fn publish_dump(&mut self, dump: PublishableDump) -> Result<(), Error>

Publish a dumped message.

Arguments

• dump – message dump.

Example

let props = OutgoingRequestProperties::new(
    "system.ping",
    Subscription::unicast_responses_from(to).subscription_topic(agent.id(), "v1")?,
    "random-string-123",
    OutgoingShortTermTimingProperties::new(Utc::now()),
);

let message = OutgoingMessage::new(
    json!({ "ping": "hello" }),
    props,
    Destination::Unicast(agent.id().clone(), "v1"),
);

let dump = Box::new(message).into_dump();
agent.publish_dump(dump.clone())?;
println!("Message published: {}", dump);

pub fn subscribe<S>(
    &mut self,
    subscription: &S,
    qos: QoS,
    maybe_group: Option<&SharedGroup>
) -> Result<(), Error> where
    S: SubscriptionTopic, 

Subscribe to a topic.

Arguments

• subscription – the Subscription.
• qos – quality of service. See QoS for available values.
• maybe_group – SharedGroup in case of multicast subscription.

Example

agent.subscribe(
    &Subscription::multicast_requests(Some("v1")),
    QoS::AtMostOnce,
    Some(&group),
)?;

Trait Implementations

impl Clone for Agent

fn clone(&self) -> Agent

Returns a copy of the value.

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

Performs copy-assignment from source.