Struct tikv::server::raft_client::Queue

[+] Show declaration

struct Queue {
    buf: ArrayQueue<RaftMessage>,
    connected: AtomicBool,
    waker: Mutex<Option<Waker>>,
}

[−] Expand description

A quick queue for sending raft messages.

Fields

buf: ArrayQueue<RaftMessage>

connected: AtomicBool

[−] Expand description

A flag indicates whether the queue can still accept messages.

waker: Mutex<Option<Waker>>

Implementations

impl Queue[−]

fn with_capacity(cap: usize) -> Queue[−]

Creates a Queue that can store at lease cap messages.

fn push(&self, msg: RaftMessage) -> Result<(), DiscardReason>[−]

Pushes message into the tail of the Queue.

You are supposed to call notify to make sure the message will be sent finally.

True when the message is pushed into queue otherwise false.

fn disconnect(&self)

fn notify(&self)[−]

Wakes up consumer to retrive message.

fn len(&self) -> usize[−]

Gets the buffer len.

fn try_pop(&self) -> Option<RaftMessage>[−]

Gets message from the head of the queue.

fn pop(&self, ctx: &Context<'_>) -> Option<RaftMessage>[−]

Same as try_pop but register interest on readiness when None is returned.

The method should be called in polling context. If the queue is empty, it will register current polling task for notifications.