Struct Aeron

Source

pub struct Aeron { /* private fields */ }

Implementations§

Source §

impl Aeron

Source

pub fn new(context: &AeronContext) -> Result<Self, AeronCError>

Create a Aeron client struct and initialize from the AeronContext struct.

The given AeronContext struct will be used exclusively by the client. Do not reuse between clients.

§Parameters

context to use for initialization.

§Return

0 for success and -1 for error.

Source

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

Start an Aeron. This may spawn a thread for the Client Conductor.

§Return

0 for success and -1 for error.

Source

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

Call the Conductor main do_work duty cycle once.

Client must have been created with use conductor invoker set to true.

§Return

0 for success and -1 for error.

Source

pub fn main_idle_strategy(&self, work_count: c_int)

Call the Conductor Idle Strategy.

§Parameters

work_count to pass to idle strategy.

Source

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

Close and delete Aeron struct.

§Return

0 for success and -1 for error.

Source

pub fn is_closed(&self) -> bool

Determines if the client has been closed, e.g. via a driver timeout. Don’t call this method after calling aeron_close as that will have already freed the associated memory.

§Return

true if it has been closed, false otherwise.

Source

pub fn print_counters( &self, stream_out: Option<unsafe extern "C" fn(arg1: *const c_char)>, )

Call stream_out to print the counter labels and values.

§Parameters

stream_out to call for each label and value.

Source

pub fn context(&self) -> AeronContext

Return the AeronContext that is in use by the given client.

§Return

the AeronContext for the given client or NULL for an error.

Source

pub fn client_id(&self) -> i64

Return the client id in use by the client.

§Return

id value or -1 for an error.

Source

pub fn next_correlation_id(&self) -> i64

Return a unique correlation id from the driver.

§Return

unique correlation id or -1 for an error.

Source

pub fn async_add_publication_cancel( &self, async_: &AeronAsyncAddPublication, ) -> Result<i32, AeronCError>

Cancel an in-progress aeron_async_add_publication operation.

Will eventually free the given AeronAsyncAddPublication instance. If a publication gets created by the time cancellation happens, it will get removed.

Note: The above guarantees only apply when a call to this method succeeds, i.e. return value is zero. If a return value is non-zero the operation won’t be canceled and the AeronAsyncAddPublication instance won’t be freed.

§Return

0 for success or -1 for error.

Source

pub fn async_remove_publication<AeronNotificationHandlerImpl: AeronNotificationCallback>( &self, registration_id: i64, on_complete: Option<&Handler<AeronNotificationHandlerImpl>>, ) -> Result<i32, AeronCError>

Asynchronously remove a publication. If there is an AeronPublication object for that publication, it will get closed and freed.

§Parameters

registration_id of the publication to be removed.
on_complete optional callback to execute once the publication has been removed. This may happen on a separate thread, so the caller should ensure that clientd has the appropriate lifetime. Use NULL if not needed.
on_complete_clientd parameter to pass to the on_complete callback.

§Return

0 for success or -1 for error.

Source

pub fn async_remove_publication_once<AeronNotificationHandlerImpl: FnMut()>( &self, registration_id: i64, on_complete: AeronNotificationHandlerImpl, ) -> Result<i32, AeronCError>

Asynchronously remove a publication. If there is an AeronPublication object for that publication, it will get closed and freed.

§Parameters

registration_id of the publication to be removed.
on_complete optional callback to execute once the publication has been removed. This may happen on a separate thread, so the caller should ensure that clientd has the appropriate lifetime. Use NULL if not needed.
on_complete_clientd parameter to pass to the on_complete callback.

§Return

0 for success or -1 for error.

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

Source

pub fn async_add_exclusive_publication_cancel( &self, async_: &AeronAsyncAddExclusivePublication, ) -> Result<i32, AeronCError>

Cancel an in-progress aeron_async_add_exclusive_publication operation.

Will eventually free the given AeronAsyncAddExclusivePublication instance. If a publication gets created by the time cancellation happens, it will get removed.

Note: The above guarantees only apply when a call to this method succeeds, i.e. return value is zero. If a return value is non-zero the operation won’t be canceled and the AeronAsyncAddExclusivePublication instance won’t be freed.

§Return

0 for success or -1 for error.

Source

pub fn async_remove_exclusive_publication<AeronNotificationHandlerImpl: AeronNotificationCallback>( &self, registration_id: i64, on_complete: Option<&Handler<AeronNotificationHandlerImpl>>, ) -> Result<i32, AeronCError>

Asynchronously remove an exclusive publication. If there is an AeronExclusivePublication object for that publication, it will get closed and freed.

§Parameters

registration_id of the exclusive publication to be removed.
on_complete optional callback to execute once the exclusive publication has been removed. This may happen on a separate thread, so the caller should ensure that clientd has the appropriate lifetime. Use NULL if not needed.
on_complete_clientd parameter to pass to the on_complete callback.

§Return

0 for success or -1 for error.

Source

pub fn async_remove_exclusive_publication_once<AeronNotificationHandlerImpl: FnMut()>( &self, registration_id: i64, on_complete: AeronNotificationHandlerImpl, ) -> Result<i32, AeronCError>

Asynchronously remove an exclusive publication. If there is an AeronExclusivePublication object for that publication, it will get closed and freed.

§Parameters

registration_id of the exclusive publication to be removed.
on_complete optional callback to execute once the exclusive publication has been removed. This may happen on a separate thread, so the caller should ensure that clientd has the appropriate lifetime. Use NULL if not needed.
on_complete_clientd parameter to pass to the on_complete callback.

§Return

0 for success or -1 for error.

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

Source

pub fn async_add_subscription_cancel( &self, async_: &AeronAsyncAddSubscription, ) -> Result<i32, AeronCError>

Cancel an in-progress aeron_async_add_subscription operation.

Will eventually free the given AeronAsyncAddSubscription instance. If a subscription gets created by the time cancellation happens, it will get removed.

Note: The above guarantees only apply when a call to this method succeeds, i.e. return value is zero. If a return value is non-zero the operation won’t be canceled and the AeronAsyncAddSubscription instance won’t be freed.

§Return

0 for success or -1 for error.

Source

pub fn async_remove_subscription<AeronNotificationHandlerImpl: AeronNotificationCallback>( &self, registration_id: i64, on_complete: Option<&Handler<AeronNotificationHandlerImpl>>, ) -> Result<i32, AeronCError>

Asynchronously remove a subscription. If there is an AeronSubscription object for that subscription, it will get closed and freed.

§Parameters

registration_id of the subscription to be removed.
on_complete optional callback to execute once the subscription has been removed. This may happen on a separate thread, so the caller should ensure that clientd has the appropriate lifetime. Use NULL if not needed.
on_complete_clientd parameter to pass to the on_complete callback.

§Return

0 for success or -1 for error.

Source

pub fn async_remove_subscription_once<AeronNotificationHandlerImpl: FnMut()>( &self, registration_id: i64, on_complete: AeronNotificationHandlerImpl, ) -> Result<i32, AeronCError>

Asynchronously remove a subscription. If there is an AeronSubscription object for that subscription, it will get closed and freed.

§Parameters

registration_id of the subscription to be removed.
on_complete optional callback to execute once the subscription has been removed. This may happen on a separate thread, so the caller should ensure that clientd has the appropriate lifetime. Use NULL if not needed.
on_complete_clientd parameter to pass to the on_complete callback.

§Return

0 for success or -1 for error.

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

Source

pub fn counters_reader(&self) -> AeronCountersReader

Return a reference to the counters reader of the given client.

The AeronCountersReader is maintained by the client. And should not be freed.

§Return

AeronCountersReader or NULL for error.

Source

pub fn async_add_counter_cancel( &self, async_: &AeronAsyncAddCounter, ) -> Result<i32, AeronCError>

Cancel an in-progress aeron_async_add_counter operation. Not applicable to aeron_async_add_static_counter, i.e. attempt to cancel static counter will fail with an error.

Will eventually free the given AeronAsyncAddCounter instance. If a counter gets created by the time cancellation happens, it will get removed.

Note: The above guarantees only apply when a call to this method succeeds, i.e. return value is zero. If a return value is non-zero the operation won’t be canceled and the AeronAsyncAddCounter instance won’t be freed.

§Return

0 for success or -1 for error.

Source

pub fn async_remove_counter<AeronNotificationHandlerImpl: AeronNotificationCallback>( &self, registration_id: i64, on_complete: Option<&Handler<AeronNotificationHandlerImpl>>, ) -> Result<i32, AeronCError>

Asynchronously remove a counter. Not applicable to static counters. If there is an AeronCounter object for that counter, it will get closed and freed.

§Parameters

registration_id of the counter to be removed.
on_complete optional callback to execute once the counter has been removed. This may happen on a separate thread, so the caller should ensure that clientd has the appropriate lifetime. Use NULL if not needed.
on_complete_clientd parameter to pass to the on_complete callback.

§Return

0 for success or -1 for error.

Source

pub fn async_remove_counter_once<AeronNotificationHandlerImpl: FnMut()>( &self, registration_id: i64, on_complete: AeronNotificationHandlerImpl, ) -> Result<i32, AeronCError>

Asynchronously remove a counter. Not applicable to static counters. If there is an AeronCounter object for that counter, it will get closed and freed.

§Parameters

registration_id of the counter to be removed.
on_complete optional callback to execute once the counter has been removed. This may happen on a separate thread, so the caller should ensure that clientd has the appropriate lifetime. Use NULL if not needed.
on_complete_clientd parameter to pass to the on_complete callback.

§Return

0 for success or -1 for error.

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

Source

pub fn add_available_counter_handler( &self, pair: &AeronAvailableCounterPair, ) -> Result<i32, AeronCError>

Add a handler to be called when a new counter becomes available.

NOTE: This function blocks until the handler is added by the client conductor thread.

§Parameters

pair holding the handler to call and a clientd to pass when called.

§Return

0 for success and -1 for error

Source

pub fn remove_available_counter_handler( &self, pair: &AeronAvailableCounterPair, ) -> Result<i32, AeronCError>

Remove a previously added handler to be called when a new counter becomes available.

NOTE: This function blocks until the handler is removed by the client conductor thread.

§Parameters

pair holding the handler to call and a clientd to pass when called.

§Return

0 for success and -1 for error

Source

pub fn add_unavailable_counter_handler( &self, pair: &AeronUnavailableCounterPair, ) -> Result<i32, AeronCError>

Add a handler to be called when a new counter becomes unavailable or goes away.

NOTE: This function blocks until the handler is added by the client conductor thread.

§Parameters

pair holding the handler to call and a clientd to pass when called.

§Return

0 for success and -1 for error

Source

pub fn remove_unavailable_counter_handler( &self, pair: &AeronUnavailableCounterPair, ) -> Result<i32, AeronCError>

Remove a previously added handler to be called when a new counter becomes unavailable or goes away.

NOTE: This function blocks until the handler is removed by the client conductor thread.

§Parameters

pair holding the handler to call and a clientd to pass when called.

§Return

0 for success and -1 for error

Source

pub fn add_close_handler( &self, pair: &AeronCloseClientPair, ) -> Result<i32, AeronCError>

Add a handler to be called when client is closed.

NOTE: This function blocks until the handler is added by the client conductor thread.

§Parameters

pair holding the handler to call and a clientd to pass when called.

§Return

0 for success and -1 for error

Source

pub fn remove_close_handler( &self, pair: &AeronCloseClientPair, ) -> Result<i32, AeronCError>

Remove a previously added handler to be called when client is closed.

NOTE: This function blocks until the handler is removed by the client conductor thread.

§Parameters

pair holding the handler to call and a clientd to pass when called.

§Return

0 for success and -1 for error

Source

pub fn version_full() -> &'static str

Return full version and build string.

§Return

full version and build string. SAFETY: this is static for performance reasons, so you should not store this without copying it!!

Source

pub fn version_text() -> &'static str

Return version text.

§Return

version text. SAFETY: this is static for performance reasons, so you should not store this without copying it!!

Source

pub fn version_major() -> Result<i32, AeronCError>

Return major version number.

§Return

major version number.

Source

pub fn version_minor() -> Result<i32, AeronCError>

Return minor version number.

§Return

minor version number.

Source

pub fn version_patch() -> Result<i32, AeronCError>

Return patch version number.

§Return

patch version number.

Source

pub fn version_gitsha() -> &'static str

Return the git sha for the current build.

§Return

git version SAFETY: this is static for performance reasons, so you should not store this without copying it!!

Source

pub fn nano_clock() -> i64

Return time in nanoseconds for machine. Is not wall clock time.

§Return

nanoseconds since epoch for machine.

Source

pub fn epoch_clock() -> i64

Return time in milliseconds since epoch. Is wall clock time.

§Return

milliseconds since epoch.

Source

pub fn is_driver_active( dirname: &CStr, timeout_ms: i64, log_func: aeron_log_func_t, ) -> bool

Determine if an aeron driver is using a given aeron directory.

§Parameters

dirname for aeron directory
timeout_ms to use to determine activity for aeron directory
log_func to call during activity check to log diagnostic information.

§Return

true for active driver or false for no active driver.

Source

pub fn properties_buffer_load(buffer: &CStr) -> Result<i32, AeronCError>

Load properties from a string containing name=value pairs and set appropriate environment variables for the process so that subsequent calls to aeron_driver_context_init will use those values.

§Parameters

buffer containing properties and values.

§Return

0 for success and -1 for error.

Source

pub fn properties_file_load(filename: &CStr) -> Result<i32, AeronCError>

Load properties file and set appropriate environment variables for the process so that subsequent calls to aeron_driver_context_init will use those values.

§Parameters

filename to load.

§Return

0 for success and -1 for error.

Source

pub fn properties_http_load(url: &CStr) -> Result<i32, AeronCError>

Load properties from HTTP URL and set environment variables for the process so that subsequent calls to aeron_driver_context_init will use those values.

§Parameters

url to attempt to retrieve and load.

§Return

0 for success and -1 for error.

Source

pub fn properties_load(url_or_filename: &CStr) -> Result<i32, AeronCError>

Load properties based on URL or filename. If string contains file or http URL, it will attempt to load properties from a file or http as indicated. If not a URL, then it will try to load the string as a filename.

§Parameters

url_or_filename to load properties from.

§Return

0 for success and -1 for error.

Source

pub fn errcode() -> Result<i32, AeronCError>

Return current aeron error code (errno) for calling thread.

§Return

aeron error code for calling thread.

Source

pub fn errmsg() -> &'static str

Return the current aeron error message for calling thread.

§Return

aeron error message for calling thread. SAFETY: this is static for performance reasons, so you should not store this without copying it!!

Source

pub fn default_path( path: *mut c_char, path_length: usize, ) -> Result<i32, AeronCError>

Get the default path used by the Aeron media driver.

§Parameters

path buffer to store the path.
path_length space available in the buffer

§Return

-1 if there is an issue or the number of bytes written to path excluding the terminator \0. If this is equal to or greater than the path_length then the path has been truncated.

Source