Struct AeronArchiveContext

pub struct AeronArchiveContext { /* private fields */ }

Implementations

impl AeronArchiveContext

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

Create an AeronArchiveContext struct.

pub fn close(&self) -> Result<i32, AeronCError>

Close and delete the 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: &str, ) -> 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: &str, ) -> 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: &str, ) -> 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: &str, ) -> 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_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_idle_strategy<AeronIdleStrategyFuncHandlerImpl: AeronIdleStrategyFuncCallback>( &self, idle_strategy_func: Option<&Handler<AeronIdleStrategyFuncHandlerImpl>>, ) -> Result<i32, AeronCError>

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

pub fn set_idle_strategy_once<AeronIdleStrategyFuncHandlerImpl: FnMut(c_int)>( &self, idle_strategy_func: AeronIdleStrategyFuncHandlerImpl, ) -> Result<i32, AeronCError>

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

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

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

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

pub fn set_credentials_supplier_once<AeronArchiveCredentialsFreeFuncHandlerImpl: FnMut(AeronArchiveEncodedCredentials)>( &self, encoded_credentials: aeron_archive_credentials_encoded_credentials_supplier_func_t, on_challenge: aeron_archive_credentials_challenge_supplier_func_t, on_free: AeronArchiveCredentialsFreeFuncHandlerImpl, ) -> Result<i32, AeronCError>

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

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

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

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

pub fn set_recording_signal_consumer_once<AeronArchiveRecordingSignalConsumerFuncHandlerImpl: FnMut(AeronArchiveRecordingSignal)>( &self, on_recording_signal: AeronArchiveRecordingSignalConsumerFuncHandlerImpl, ) -> Result<i32, AeronCError>

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

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

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

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

pub fn set_error_handler_once<AeronErrorHandlerHandlerImpl: FnMut(c_int, &str)>( &self, error_handler: AeronErrorHandlerHandlerImpl, ) -> Result<i32, AeronCError>

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

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

pub fn set_delegating_invoker<AeronArchiveDelegatingInvokerFuncHandlerImpl: AeronArchiveDelegatingInvokerFuncCallback>( &self, delegating_invoker_func: Option<&Handler<AeronArchiveDelegatingInvokerFuncHandlerImpl>>, ) -> Result<i32, 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.

pub fn set_delegating_invoker_once<AeronArchiveDelegatingInvokerFuncHandlerImpl: FnMut()>( &self, delegating_invoker_func: AeronArchiveDelegatingInvokerFuncHandlerImpl, ) -> Result<i32, 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.

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

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

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>

impl AeronArchiveContext

pub fn set_no_credentials_supplier(&self) -> Result<i32, AeronCError>

pub fn new_with_no_credentials_supplier( aeron: &Aeron, request_control_channel: &str, response_control_channel: &str, recording_events_channel: &str, ) -> Result<AeronArchiveContext, AeronCError>

This method creates a new AeronArchiveContext with a no-op credentials supplier. If you do not set a credentials supplier, it will segfault. This method ensures that a non-functional credentials supplier is set to avoid the segfault.

Trait Implementations

impl Clone for AeronArchiveContext

fn clone(&self) -> AeronArchiveContext

Returns a copy 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.