Struct AeronCountersReader

pub struct AeronCountersReader { /* private fields */ }

Implementations

impl AeronCountersReader

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

creates zeroed struct where the underlying c struct is on the heap

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 foreach_counter_once<AeronCountersReaderForeachCounterFuncHandlerImpl: FnMut(i64, i32, i32, &[u8], &str)>( &self, func: 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.

NOTE: aeron must not store this closure and instead use it immediately. If not you will get undefined behaviour, use with care

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 aeron_archive_recording_pos_find_counter_id_by_recording_id( &self, recording_id: i64, ) -> i32

Find the active counter id for a stream based on the recording id.

Parameters

• recording_id the recording id of an active recording

Return

the counter id if found, otherwise AERON_NULL_COUNTER_ID

pub fn aeron_archive_recording_pos_find_counter_id_by_session_id( &self, session_id: i32, ) -> i32

Find the active counter id for a stream based on the session id.

Parameters

• session_id the session id of an active recording

Return

the counter id if found, otherwise AERON_NULL_COUNTER_ID

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

Get the recording id for a given counter id.

Parameters

• counter_id the counter id of an active recording

Return

the recording id if found, otherwise AERON_NULL_COUNTER_ID

pub fn aeron_archive_recording_pos_get_source_identity( &self, counter_id: i32, dst: &str, ) -> Result<usize, AeronCError>

Get the source identity for the recording.

See source_identity in AeronImageConstants.

Parameters

• counter_id the counter id of an active recording

• dst a destination buffer into which the source identity will be written

• len_p a pointer to a size_t that initially indicates the length of the dst buffer. After the function return successfully, len_p will be set to the length of the source identity string in dst

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

Is the recording counter still active?

Return

is_active out param set to true if the counter is still active

Parameters

• counter_id the counter id to search for

• recording_id the recording id to match against

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.

pub fn get_counter_label_into( &self, counter_id: i32, dst: &mut String, ) -> Result<(), AeronCError>

Get the label for a counter.

pub fn get_counter_key(&self, counter_id: i32) -> Result<Vec<u8>, AeronCError>

Get the key for a counter.

pub fn get_counter_key_into( &self, counter_id: i32, dst: &mut Vec<u8>, ) -> Result<(), AeronCError>

Get the key for a counter.

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

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.

impl Send for AeronCountersReader