Struct dendrite::axon_server::event::GetEventsRequest

pub struct GetEventsRequest {
    pub tracking_token: i64,
    pub number_of_permits: i64,
    pub client_id: String,
    pub component_name: String,
    pub processor: String,
    pub blacklist: Vec<PayloadDescription>,
    pub force_read_from_leader: bool,
}

Request message to open an Event Stream from the Event Store.

Fields

tracking_token: i64

The token to start streaming from

number_of_permits: i64

The number of messages the server may send before it needs to wait for more permits

client_id: String

The unique identifier of this client instance. Used for monitoring.

component_name: String

The component name of this client instance. Used for monitoring.

processor: String

The name of the processor requesting this stream. Used for monitoring.

blacklist: Vec<PayloadDescription>

An enumeration of payload types that need to be blacklisted. The Server will stop sending messages of these types in order to reduce I/O. Note that the Server may occasionally send a blacklisted message to prevent time-outs and stale tokens on clients.

force_read_from_leader: bool

Indicates whether to force reading events from the leader node of an Axon Server. Forcing reads from leader reduces the staleness of the data read, but also puts extra burden on the leader, reducing overall scalability.

This property has no effect on connections to AxonServer SE.

Trait Implementations

impl Clone for GetEventsRequest

fn clone(&self) -> GetEventsRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetEventsRequest

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

Formats the value using the given formatter.

impl Default for GetEventsRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for GetEventsRequest

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.

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

Encodes the message to a buffer.

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

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

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

Decodes an instance of the message from a buffer.

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

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

pub 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.

pub 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<GetEventsRequest> for GetEventsRequest

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

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

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

This method tests for !=.

impl StructuralPartialEq for GetEventsRequest