Struct AeronDriver 

pub struct AeronDriver { /* private fields */ }

Implementations

impl AeronDriver

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

Create a AeronDriver struct and initialize from the AeronDriverContext struct.

The given AeronDriverContext struct will be used exclusively by the driver. Do not reuse between drivers.

Parameters

• context to use for initialization.

Return

0 for success and -1 for error.

pub fn context(&self) -> AeronDriverContext

pub fn conductor(&self) -> AeronDriverConductor

pub fn native_resource_agent(&self) -> AeronDriverNativeResourceAgent

pub fn sender(&self) -> AeronDriverSender

pub fn receiver(&self) -> AeronDriverReceiver

pub fn runners(&self) -> [aeron_agent_runner_t; 4]

pub fn subscribable_is_active_state( state: aeron_subscription_tether_state_t, ) -> bool

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

Start an AeronDriver given the threading mode. This may spawn threads for the Sender, Receiver, and Conductor depending on threading mode used.

Parameters

• manual_main_loop to be called by the caller for the Conductor do_work cycle.

Return

0 for success and -1 for error.

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

Call the Conductor (or Shared) main do_work duty cycle once.

Driver must have been created with manual_main_loop set to true.

Return

0 for success and -1 for error.

pub fn main_idle_strategy(&self, work_count: c_int)

Call the Conductor (or Shared) Idle Strategy.

Parameters

• work_count to pass to idle strategy.

pub fn uri_get_offset_info(offset: i32) -> &'static str

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

pub fn threading_mode_to_string(mode: aeron_threading_mode_t) -> &'static str

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

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

pub unsafe fn get_inner_mut(&self) -> &mut aeron_driver_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_driver_t

impl AeronDriver

pub fn launch_embedded( aeron_context: AeronDriverContext, register_sigint: bool, ) -> (Arc<AtomicBool>, JoinHandle<Result<(), AeronCError>>)

pub fn launch_embedded_guard( aeron_context: AeronDriverContext, register_sigint: bool, ) -> EmbeddedMediaDriver

Launch an embedded media driver, returning a RAII guard that stops the driver on drop (so a panic or early return can’t leak a driver process).

Prefer this over Self::launch_embedded, which returns a raw (Arc<AtomicBool>, JoinHandle) tuple the caller must remember to drive. register_sigint is true to mirror the standalone binary.

pub fn wait_for_previous_media_driver_to_timeout( aeron_context: &AeronDriverContext, )

if you have existing shm files and its before the driver timeout it will try to reuse it and fail this makes sure that if that is the case it will wait else it proceeds

Trait Implementations

impl Clone for AeronDriver

fn clone(&self) -> AeronDriver

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AeronDriver

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

Formats the value using the given formatter.

impl Deref for AeronDriver

type Target = aeron_driver_stct

The resulting type after dereferencing.

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

Dereferences the value.

impl From<&AeronDriver> for *mut aeron_driver_t

fn from(value: &AeronDriver) -> Self

Converts to this type from the input type.

impl From<*const aeron_driver_stct> for AeronDriver

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

Converts to this type from the input type.

impl From<*mut aeron_driver_stct> for AeronDriver

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

Converts to this type from the input type.

impl From<AeronDriver> for *mut aeron_driver_t

fn from(value: AeronDriver) -> Self

Converts to this type from the input type.

impl From<AeronDriver> for aeron_driver_t

fn from(value: AeronDriver) -> Self

Converts to this type from the input type.

impl From<aeron_driver_stct> for AeronDriver

fn from(value: aeron_driver_t) -> Self

Converts to this type from the input type.

impl Send for AeronDriver

impl Sync for AeronDriver