Struct AeronArchiveContext 

pub struct AeronArchiveContext { /* private fields */ }

Implementations

impl AeronArchiveContext

pub fn aeron_archive_async_connect( &self, ) -> Result<AeronArchiveAsyncConnect, AeronCError>

impl AeronArchiveContext

pub fn aeron_archive_connect( &self, timeout: Duration, ) -> Result<AeronArchive, AeronCError>

Blocking convenience wrapper around the async add operation.

Convenience for examples and tests only. It blocks the calling thread in a busy-poll loop until the resource is available or timeout elapses. In production, prefer the async_add_* variant and drive its poll() from your own event loop rather than blocking on a single operation.

Production pattern (pseudo code)

// Don't block — drive the async poller from your loop
let poller = client.async_add_*(...)?;
loop {
    if let Some(resource) = poller.poll()? {
        break; // ready
    }
    do_other_work(); // service other subscriptions, timers, etc.
}

See poll_blocking on the async poller for the same caveat.

impl AeronArchiveContext

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

Create an AeronArchiveContext struct.

pub fn set_aeron(&self, aeron: &Aeron) -> Result<i32, AeronCError>

Specify the client used for communicating with the local Media Driver.

This client will be closed with the AeronArchive is closed if aeron_archive_context_set_owns_aeron_client is true.

pub fn get_aeron(&self) -> Aeron

pub fn set_owns_aeron_client( &self, owns_aeron_client: bool, ) -> Result<i32, AeronCError>

Specify whether or not this context owns the client and, therefore, takes responsibility for closing it.

pub fn get_owns_aeron_client(&self) -> bool

pub fn set_aeron_directory_name( &self, aeron_directory_name: &CStr, ) -> Result<i32, AeronCError>

Specify the top level Aeron directory used for communication between the Aeron client and the Media Driver.

pub fn get_aeron_directory_name(&self) -> &str

pub fn set_control_request_channel( &self, control_request_channel: &CStr, ) -> Result<i32, AeronCError>

Specify the channel used for sending requests to the Aeron Archive.

pub fn get_control_request_channel(&self) -> &str

pub fn set_control_request_stream_id( &self, control_request_stream_id: i32, ) -> Result<i32, AeronCError>

Specify the stream used for sending requests to the Aeron Archive.

pub fn get_control_request_stream_id(&self) -> i32

pub fn set_control_response_channel( &self, control_response_channel: &CStr, ) -> Result<i32, AeronCError>

Specify the channel used for receiving responses from the Aeron Archive.

pub fn get_control_response_channel(&self) -> &str

pub fn set_control_response_stream_id( &self, control_response_stream_id: i32, ) -> Result<i32, AeronCError>

Specify the stream used for receiving responses from the Aeron Archive.

pub fn get_control_response_stream_id(&self) -> i32

pub fn set_recording_events_channel( &self, recording_events_channel: &CStr, ) -> Result<i32, AeronCError>

Specify the channel used for receiving recording events from the Aeron Archive.

pub fn get_recording_events_channel(&self) -> &str

pub fn set_recording_events_stream_id( &self, recording_events_stream_id: i32, ) -> Result<i32, AeronCError>

Specify the stream id used for recording events channel.

pub fn get_recording_events_stream_id(&self) -> i32

pub fn set_message_timeout_ns( &self, message_timeout_ns: u64, ) -> Result<i32, AeronCError>

Specify the message timeout, in nanoseconds, to wait for sending or receiving a message.

pub fn get_message_timeout_ns(&self) -> u64

pub fn set_message_retry_attempts( &self, message_retry_attempts: u32, ) -> Result<i32, AeronCError>

Specify the number of retry attempts when offering messages to the archive.

pub fn get_message_retry_attempts(&self) -> u32

pub fn set_control_term_buffer_length( &self, control_term_buffer_length: usize, ) -> Result<i32, AeronCError>

Specify the default term buffer length for the control request/response channels.

pub fn get_control_term_buffer_length(&self) -> usize

pub fn set_control_mtu_length( &self, control_mtu_length: usize, ) -> Result<i32, AeronCError>

Specify the default MTU length for the control request/response channels.

pub fn get_control_mtu_length(&self) -> usize

pub fn set_control_term_buffer_sparse( &self, control_term_buffer_sparse: bool, ) -> Result<i32, AeronCError>

Specify the default MTU length for the control request/response channels.

pub fn get_control_term_buffer_sparse(&self) -> bool

pub fn set_client_name(&self, value: &CStr) -> Result<i32, AeronCError>

Specify client name to identify this client on the archive side.

pub fn get_client_name(&self) -> &str

pub fn set_idle_strategy<AeronIdleStrategyFuncHandlerImpl: AeronIdleStrategyFuncCallback + 'static>( &self, idle_strategy_func: Option<AeronIdleStrategyFuncHandlerImpl>, ) -> Result<Option<Handler<AeronIdleStrategyFuncHandlerImpl>>, AeronCError>

Specify the idle strategy function and associated state used by the client between polling calls.

The callback is retained by the C client; this resource keeps it alive automatically. Returns the created Handler for optional state access — safe to ignore. Closures with a matching signature are accepted directly.

pub fn set_credentials_supplier<AeronArchiveCredentialsFreeFuncHandlerImpl: AeronArchiveCredentialsFreeFuncCallback + 'static>( &self, encoded_credentials: aeron_archive_credentials_encoded_credentials_supplier_func_t, on_challenge: aeron_archive_credentials_challenge_supplier_func_t, on_free: Option<AeronArchiveCredentialsFreeFuncHandlerImpl>, ) -> Result<Option<Handler<AeronArchiveCredentialsFreeFuncHandlerImpl>>, AeronCError>

Specify the various credentials callbacks to use when connecting to the Aeron Archive.

The callback is retained by the C client; this resource keeps it alive automatically. Returns the created Handler for optional state access — safe to ignore. Closures with a matching signature are accepted directly.

pub fn set_recording_signal_consumer<AeronArchiveRecordingSignalConsumerFuncHandlerImpl: AeronArchiveRecordingSignalConsumerFuncCallback + 'static>( &self, on_recording_signal: Option<AeronArchiveRecordingSignalConsumerFuncHandlerImpl>, ) -> Result<Option<Handler<AeronArchiveRecordingSignalConsumerFuncHandlerImpl>>, AeronCError>

Specify the callback to which recording signals are dispatched while polling for control responses.

The callback is retained by the C client; this resource keeps it alive automatically. Returns the created Handler for optional state access — safe to ignore. Closures with a matching signature are accepted directly.

pub fn set_error_handler<AeronErrorHandlerHandlerImpl: AeronErrorHandlerCallback + 'static>( &self, error_handler: Option<AeronErrorHandlerHandlerImpl>, ) -> Result<Option<Handler<AeronErrorHandlerHandlerImpl>>, AeronCError>

Specify the callback to which errors are dispatched while executing archive client commands.

The callback is retained by the C client; this resource keeps it alive automatically. Returns the created Handler for optional state access — safe to ignore. Closures with a matching signature are accepted directly.

pub fn set_delegating_invoker<AeronArchiveDelegatingInvokerFuncHandlerImpl: AeronArchiveDelegatingInvokerFuncCallback + 'static>( &self, delegating_invoker_func: Option<AeronArchiveDelegatingInvokerFuncHandlerImpl>, ) -> Result<Option<Handler<AeronArchiveDelegatingInvokerFuncHandlerImpl>>, AeronCError>

Specify the callback to be invoked in addition to any invoker used by the Aeron instance.

Useful when running in a low thread count environment.

The callback is retained by the C client; this resource keeps it alive automatically. Returns the created Handler for optional state access — safe to ignore. Closures with a matching signature are accepted directly.

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

pub unsafe fn get_inner_mut(&self) -> &mut aeron_archive_context_t

Mutable access to the underlying C struct, minted from &self: nothing prevents two live &mut at once, so the caller must ensure exclusive access for the lifetime of the returned reference.

Safety

No other reference (& or &mut) to the underlying struct may be alive while the returned &mut is in use.

pub fn get_inner_ref(&self) -> &aeron_archive_context_t

Trait Implementations

impl Clone for AeronArchiveContext

fn clone(&self) -> AeronArchiveContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AeronArchiveContext

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

Formats the value using the given formatter.

impl Deref for AeronArchiveContext

type Target = aeron_archive_context_stct

The resulting type after dereferencing.

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

Dereferences the value.

impl From<&AeronArchiveContext> for *mut aeron_archive_context_t

fn from(value: &AeronArchiveContext) -> Self

Converts to this type from the input type.

impl From<*const aeron_archive_context_stct> for AeronArchiveContext

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

Converts to this type from the input type.

impl From<*mut aeron_archive_context_stct> for AeronArchiveContext

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

Converts to this type from the input type.

impl From<AeronArchiveContext> for *mut aeron_archive_context_t

fn from(value: AeronArchiveContext) -> Self

Converts to this type from the input type.

impl From<AeronArchiveContext> for aeron_archive_context_t

fn from(value: AeronArchiveContext) -> Self

Converts to this type from the input type.

impl From<aeron_archive_context_stct> for AeronArchiveContext

fn from(value: aeron_archive_context_t) -> Self

Converts to this type from the input type.