Struct svc_agent::mqtt::IncomingRequestProperties

pub struct IncomingRequestProperties { /* fields omitted */ }

Properties of an incoming request.

Methods

impl IncomingRequestProperties

pub fn method(&self) -> &str

pub fn correlation_data(&self) -> &str

pub fn response_topic(&self) -> &str

pub fn broker_agent_id(&self) -> &AgentId

pub fn long_term_timing(&self) -> &LongTermTimingProperties

pub fn short_term_timing(&self) -> &IncomingShortTermTimingProperties

pub fn tracking(&self) -> &TrackingProperties

pub fn to_connection(&self) -> Connection

pub fn to_event(
    &self,
    label: &'static str,
    short_term_timing: OutgoingShortTermTimingProperties
) -> OutgoingEventProperties

Builds OutgoingEventProperties based on the IncomingRequestProperties.

Use it to publish an event when something worth notifying subscribers happens during the request processing.

Arguments

• label – outgoing event label.
• short_term_timing – outgoing event's short term timing properties.

Example

let short_term_timing = OutgoingShortTermTimingProperties::until_now(start_timestamp);
let out_props = in_props.to_event("agent.enter", short_term_timing);

pub fn to_request(
    &self,
    method: &str,
    response_topic: &str,
    correlation_data: &str,
    short_term_timing: OutgoingShortTermTimingProperties
) -> OutgoingRequestProperties

Builds OutgoingRequestProperties based on the IncomingRequestProperties.

Use it to send a request to another service while handling a request.

Arguments

• method – request method.
• response_topic – topic for response.
• correlation_data – any string to correlate request with response.
• short_term_timing – outgoing request's short term timing properties.

Example

let out_props = in_props.to_request(
    "room.enter",
    &Subscription::unicast_responses(),
    OutgoingShortTermTimingProperties::until_now(start_timestamp),
);

pub fn to_response(
    &self,
    status: ResponseStatus,
    short_term_timing: OutgoingShortTermTimingProperties
) -> OutgoingResponseProperties

Builds OutgoingResponseProperties based on the IncomingRequestProperties.

Use it to response on a request.

Arguments

• status – response status.
• short_term_timing – outgoing response's short term timings properties.

Example

let short_term_timing = OutgoingShortTermTimingProperties::until_now(start_timestamp);
let out_props = in_props.to_response(ResponseStatus::OK, short_term_timing);

Trait Implementations

impl Addressable for IncomingRequestProperties

fn as_agent_id(&self) -> &AgentId

Returns the AgentId reference of the addressable object.

impl Authenticable for IncomingRequestProperties

fn as_account_id(&self) -> &AccountId

impl Clone for IncomingRequestProperties

fn clone(&self) -> IncomingRequestProperties

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IncomingRequestProperties

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IncomingRequestProperties

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for IncomingRequestProperties

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.