Struct rings_core::message::MessageRelay

pub struct MessageRelay {
    pub path: Vec<Did>,
    pub next_hop: Did,
    pub destination: Did,
}

MessageRelay guide message passing on rings network by relay.

All messages should be sent with MessageRelay. By calling relay method in correct place, MessageRelay help to do things:

• Record the whole transport path for inspection.
• Get the sender of a message.

Fields

path: Vec<Did>

A push only stack. Record routes when handling messages.

next_hop: Did

The next node to handle the message. A message handler will pick transport by this field.

destination: Did

The destination of the message. It may help the handler to find out next_hop in some situations.

Implementations

impl MessageRelay

pub fn new(path: Vec<Did>, next_hop: Did, destination: Did) -> Self

Create a new MessageRelay.

pub fn forward(&self, current: Did, next_hop: Did) -> Result<Self>

Validate relay, then create a new MessageRelay that have current did in the end of path. The new relay will use next_hop as next_hop and self.destination as destination.

pub fn report(&self, current: Did) -> Result<Self>

Validate relay, then create a new MessageRelay that used to report the message. The new relay will use self.path[self.path.len() - 1] as next_hop and self.sender() as destination. In the new relay, the path will be cleared and only have current did.

pub fn reset_destination(&self, destination: Did) -> Self

Sometime the sender may not know the destination of the message. They just use next_hop as destination. The next node can find a new next_hop, and may use this function to set that next_hop as destination again.

pub fn validate(&self, current: Did) -> Result<()>

Check if path and destination is valid.

pub fn sender(&self) -> Did

👎Deprecated: please use origin_sender instead

Get the origin sender of current message. Should be the first element of path.

pub fn origin_sender(&self) -> Did

Get the origin sender of current message. Should be the first element of path.

Trait Implementations

impl Clone for MessageRelay

fn clone(&self) -> MessageRelay

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MessageRelay

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MessageRelay

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for MessageRelay

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for MessageRelay

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for MessageRelay

impl StructuralPartialEq for MessageRelay