Struct tempest_source_mock::MockSource

pub struct MockSource {
    pub queue: VecDeque<SourceMsg>,
    // some fields omitted
}

A mock source which should be used for testing purposes. This source mocks pushing & polling messages from a queue.

Fields

queue: VecDeque<SourceMsg>

Trait Implementations

impl Default for MockSource

fn default() -> Self

Returns the "default value" for a type.

impl Source for MockSource

fn name(&self) -> &'static str

return the name of this source

fn setup(&mut self) -> SourceResult<()>

Source setup logic should go here

fn ack(&mut self, _msg_id: MsgId) -> SourceResult<(i32, i32)>

Ack a single method with the upstream source

fn batch_ack(&mut self, msgs: Vec<MsgId>) -> SourceResult<(i32, i32)>

Batch ack a vector of messages with an upstream source

fn max_backoff(&self) -> SourceResult<&u64>

The configured maximum amount of time in milliseconds a source should backoff. This value is read by the TopologyActor when scheduling the next source.poll call

fn ack_policy(&self) -> SourceResult<&SourceAckPolicy>

Ack policy configuration

fn ack_interval(&self) -> SourceResult<&SourceInterval>

Configures how often the source should check for new messages to ack

fn poll_interval(&self) -> SourceResult<&SourceInterval>

Poll interval controls how often a Topology should ask for new messages

fn poll(&mut self) -> SourcePollResult

Poll for new message from the source

fn validate(&mut self) -> Result<(), SourceError>

Validation logic for determining if a source is properly configured at runtime.

fn shutdown(&mut self) -> Result<(), SourceError>

Source shutdown logic for closing connections, performing cleanup logic, etc.

fn connect(&mut self) -> Result<(), SourceError>

Source connection logic for creating client connections

fn healthy(&mut self) -> bool

Source health check. Should be used to determine if clients are still able to reach upstream brokers

fn monitor(&mut self) -> Result<(), SourceError>

Monitor is a special method which is the callback for the monitor interval It's intended to ack as a special hook for keeping track of your source structure or performing other actions.

fn monitor_interval(&self) -> Result<&SourceInterval, SourceError>

Monitor interval controls how often the source monitor is called

fn flush_metrics(&mut self)

Sources can implement Metrics. This method is called by TopologyActor to internal source flush metrics to configured backend targets.