Struct rusteron_client::AeronCountersReader

pub struct AeronCountersReader { /* private fields */ }

Implementations

impl AeronCountersReader

pub fn new_zeroed() -> Result<Self, AeronCError>

pub fn get_buffers( &self, buffers: &AeronCountersReaderBuffers, ) -> Result<i32, AeronCError>

Get buffer pointers and lengths for the counters reader.

Parameters

• reader reader containing the buffers.

• buffers output structure to return the buffers.

Return

-1 on failure, 0 on success.

pub fn foreach_counter<AeronCountersReaderForeachCounterFuncHandlerImpl: AeronCountersReaderForeachCounterFuncCallback>( &self, func: Option<&Handler<AeronCountersReaderForeachCounterFuncHandlerImpl>>, )

Iterate over the counters in the counters_reader and call the given function for each counter.

Parameters

• func to call for each counter.

• clientd to pass for each call to func.

pub fn find_by_type_id_and_registration_id( &self, type_id: i32, registration_id: i64, ) -> i32

Iterate over allocated counters and find the first matching a given type id and registration id.

Parameters

• type_id to find.

• registration_id to find.

Return

the counter id if found otherwise AERON_NULL_COUNTER_ID.

pub fn max_counter_id(&self) -> i32

Get the current max counter id.

Return

-1 on failure, max counter id on success.

pub fn addr(&self, counter_id: i32) -> &mut i64

Get the address for a counter.

Parameters

• counter_id to find

Return

address of the counter value

pub fn counter_registration_id( &self, counter_id: i32, ) -> Result<i64, AeronCError>

Get the registration id assigned to a counter.

Parameters

• counter_id for which the registration id is requested.

• registration_id pointer for value to be set on success.

pub fn counter_owner_id(&self, counter_id: i32) -> Result<i64, AeronCError>

Get the owner id assigned to a counter which will typically be the client id.

Parameters

• counter_id for which the owner id is requested.

• owner_id pointer for value to be set on success.

pub fn counter_reference_id(&self, counter_id: i32) -> Result<i64, AeronCError>

Get the reference id assigned to a counter which will typically be the registration id of an associated Image, Subscription, Publication, etc.

Parameters

• counter_id for which the reference id is requested.

• reference_id pointer for value to be set on success.

pub fn counter_state(&self, counter_id: i32) -> Result<i32, AeronCError>

Get the state for a counter.

Parameters

• counter_id to find

• state out pointer for the current state to be stored in.

pub fn counter_type_id(&self, counter_id: i32) -> Result<i32, AeronCError>

Get the type id for a counter.

Parameters

• counter_id to find

pub fn counter_label( &self, counter_id: i32, buffer: *mut c_char, buffer_length: usize, ) -> Result<i32, AeronCError>

Get the label for a counter.

Parameters

• counter_id to find

• buffer to store the counter in.

• buffer_length length of the output buffer

Return

-1 on failure, number of characters copied to buffer on success.

pub fn free_for_reuse_deadline_ms( &self, counter_id: i32, ) -> Result<i64, AeronCError>

Get the free for reuse deadline (ms) for a counter.

Parameters

• counter_id to find.

• deadline_ms output value to store the deadline.

pub fn get_inner(&self) -> *mut aeron_counters_reader_t

impl AeronCountersReader

pub fn get_counter_label( &self, counter_id: i32, max_length: usize, ) -> Result<String, AeronCError>

Get the label for a counter.

param counters_reader that contains the counter

param counter_id to find

param buffer to store the counter in.

param buffer_length length of the output buffer

return -1 on failure, number of characters copied to buffer on success.

Trait Implementations

impl Clone for AeronCountersReader

fn clone(&self) -> AeronCountersReader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AeronCountersReader

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

Formats the value using the given formatter.

impl Deref for AeronCountersReader

type Target = aeron_counters_reader_stct

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<&AeronCountersReader> for *mut aeron_counters_reader_t

fn from(value: &AeronCountersReader) -> Self

Converts to this type from the input type.

impl From<*const aeron_counters_reader_stct> for AeronCountersReader

fn from(value: *const aeron_counters_reader_t) -> Self

Converts to this type from the input type.

impl From<*mut aeron_counters_reader_stct> for AeronCountersReader

fn from(value: *mut aeron_counters_reader_t) -> Self

Converts to this type from the input type.

impl From<AeronCountersReader> for *mut aeron_counters_reader_t

fn from(value: AeronCountersReader) -> Self

Converts to this type from the input type.

impl From<AeronCountersReader> for aeron_counters_reader_t

fn from(value: AeronCountersReader) -> Self

Converts to this type from the input type.

impl From<aeron_counters_reader_stct> for AeronCountersReader

fn from(value: aeron_counters_reader_t) -> Self

Converts to this type from the input type.