Struct AeronCnc

pub struct AeronCnc { /* private fields */ }

Implementations

impl AeronCnc

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

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

pub fn constants( &self, constants: &AeronCncConstants, ) -> Result<i32, AeronCError>

Fetch the sets of constant values associated with this command and control file.

Parameters

• constants user supplied structure to hold return values.

Return

0 on success, -1 on failure.

pub fn get_constants(&self) -> Result<AeronCncConstants, AeronCError>

Fetch the sets of constant values associated with this command and control file.

pub fn filename(&self) -> &str

Get the current file name of the cnc file.

Return

name of the cnc file

pub fn to_driver_heartbeat(&self) -> i64

Gets the timestamp of the last heartbeat sent to the media driver from any client.

Return

last heartbeat timestamp in ms.

pub fn error_log_read<AeronErrorLogReaderFuncHandlerImpl: AeronErrorLogReaderFuncCallback>( &self, callback: Option<&Handler<AeronErrorLogReaderFuncHandlerImpl>>, since_timestamp: i64, ) -> usize

Reads the current error log for this driver.

Parameters

• callback called for every distinct error observation

• clientd client data to be passed to the callback

• since_timestamp only return errors after this timestamp (0 returns all)

Return

the number of distinct errors seen

pub fn error_log_read_once<AeronErrorLogReaderFuncHandlerImpl: FnMut(i32, i64, i64, &str)>( &self, callback: AeronErrorLogReaderFuncHandlerImpl, since_timestamp: i64, ) -> usize

Reads the current error log for this driver.

Parameters

• callback called for every distinct error observation

• clientd client data to be passed to the callback

• since_timestamp only return errors after this timestamp (0 returns all)

Return

the number of distinct errors seen

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

pub fn counters_reader(&self) -> AeronCountersReader

Gets a counters reader for this command and control file. This does not need to be closed manually, resources are tied to the instance of aeron_cnc.

Return

pointer to a counters reader.

pub fn loss_reporter_read<AeronLossReporterReadEntryFuncHandlerImpl: AeronLossReporterReadEntryFuncCallback>( &self, entry_func: Option<&Handler<AeronLossReporterReadEntryFuncHandlerImpl>>, ) -> Result<i32, AeronCError>

Read all of the data loss observations from the report in the same media driver instances as the cnc file.

Parameters

• entry_func callback for each observation found

Return

-1 on failure, number of observations on success (could be 0).

pub fn loss_reporter_read_once<AeronLossReporterReadEntryFuncHandlerImpl: FnMut(i64, i64, i64, i64, i32, i32, &str, &str)>( &self, entry_func: AeronLossReporterReadEntryFuncHandlerImpl, ) -> Result<i32, AeronCError>

Read all of the data loss observations from the report in the same media driver instances as the cnc file.

Parameters

• entry_func callback for each observation found

Return

-1 on failure, number of observations on success (could be 0).

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

pub fn close(&self)

Closes the instance of the aeron cnc and frees its resources.

pub fn resolve_filename( directory: &str, filename_buffer: *mut c_char, filename_buffer_length: usize, ) -> Result<i32, AeronCError>

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

Trait Implementations

impl Clone for AeronCnc

fn clone(&self) -> AeronCnc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AeronCnc

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

Formats the value using the given formatter.

impl Deref for AeronCnc

type Target = aeron_cnc_stct

The resulting type after dereferencing.

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

Dereferences the value.

impl From<&AeronCnc> for *mut aeron_cnc_t

fn from(value: &AeronCnc) -> Self

Converts to this type from the input type.

impl From<*const aeron_cnc_stct> for AeronCnc

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

Converts to this type from the input type.

impl From<*mut aeron_cnc_stct> for AeronCnc

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

Converts to this type from the input type.

impl From<AeronCnc> for *mut aeron_cnc_t

fn from(value: AeronCnc) -> Self

Converts to this type from the input type.

impl From<AeronCnc> for aeron_cnc_t

fn from(value: AeronCnc) -> Self

Converts to this type from the input type.

impl From<aeron_cnc_stct> for AeronCnc

fn from(value: aeron_cnc_t) -> Self

Converts to this type from the input type.