Struct fleetspeak_proto::common::Message

pub struct Message {
    pub message_id: Vec<u8>,
    pub source: Option<Address>,
    pub source_message_id: Vec<u8>,
    pub destination: Option<Address>,
    pub message_type: String,
    pub creation_time: Option<Timestamp>,
    pub data: Option<Any>,
    pub validation_info: Option<ValidationInfo>,
    pub result: Option<MessageResult>,
    pub priority: i32,
    pub background: bool,
    pub annotations: Option<Annotations>,
}

Fields

message_id: Vec<u8>

A hash based on origin and origin_message_id. It is set by the fleetspeak system on message intake and may be used for deduplication.

source: Option<Address>

The source of the messages. Required.

source_message_id: Vec<u8>

An sequence of bytes set by the source in a way to uniquely identify the message among all messages with the same origin.

destination: Option<Address>

The destination of the message. Required.

message_type: String

The type of message. This field is mostly opaque to the Fleetspeak system, but can be used for some statistics gathering. It is recommended that each service define a static collection of short readable message types and dispatch according to this when processing messages. e.g. "ResourceUsage", "StdOutputData".

creation_time: Option<Timestamp>

Set when the message enters the FS system.

data: Option<Any>

The data associated with this request, accepted types are determined by the service and may depend on message_type. Not typically stored after the message is processed.

validation_info: Option<ValidationInfo>

Additional validation information, set by on the server by the (optional) authorizer component based on WrappedContactData.validators, etc.

result: Option<MessageResult>

The result of processing the message. Set once processing has finished.

priority: i32

background: bool

A background message does not count as activity when deciding how fast to poll the server. This flag should be set on messages which are unlikely to trigger additional activity.

annotations: Option<Annotations>

Optional debugging information provided by the originator of the message. Fleetspeak stores this information along with the message for later retrieval, but doesn't really do anything else with it.

Methods

impl Message

pub fn priority(&self) -> Priority

Returns the enum value of priority, or the default if the field is set to an invalid enum value.

pub fn set_priority(&mut self, value: Priority)

Sets priority to the provided enum value.

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl Default for Message

fn default() -> Message

Returns the "default value" for a type.

impl Message for Message

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<Message> for Message

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

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

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

This method tests for !=.

impl StructuralPartialEq for Message