Struct AeronArchiveReplayMerge

pub struct AeronArchiveReplayMerge { /* private fields */ }

Implementations

impl AeronArchiveReplayMerge

pub fn new( subscription: &AeronSubscription, aeron_archive: &AeronArchive, replay_channel: &str, replay_destination: &str, live_destination: &str, recording_id: i64, start_position: i64, epoch_clock: c_longlong, merge_progress_timeout_ms: i64, ) -> Result<Self, AeronCError>

Create an AeronArchiveReplayMerge to manage the merging of a replayed stream into a live stream.

Parameters

• replay_merge the AeronArchiveReplayMerge to create and initialize

• subscription the subscription to use for the replay and live stream. Must be a multi-destination subscription

• aeron_archive the archive client

• replay_channel the channel to use for the replay

• replay_destination the replay channel to use for the destination added by the subscription

• live_destination the live stream channel to use for the destination added by the subscription

• recording_id the recording id of the archive to replay

• start_position the start position of the replay

• epoch_clock the clock to use for progress checks

• merge_progress_timeout_ms the timeout to use for progress checks

Return

0 for success, -1 for failure

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

Close and delete the AeronArchiveReplayMerge struct.

Return

0 for success, -1 for failure

pub fn do_work(&self, work_count_p: *mut c_int) -> Result<i32, AeronCError>

Process the operation of the merge. Do not call the processing of fragments on the subscription.

Parameters

• work_count_p an indicator of work done

Return

0 for success, -1 for failure

pub fn poll<AeronFragmentHandlerHandlerImpl: AeronFragmentHandlerCallback>( &self, handler: Option<&Handler<AeronFragmentHandlerHandlerImpl>>, fragment_limit: c_int, ) -> Result<i32, AeronCError>

Poll the image used for the merging replay and live stream. The aeron_archive_replay_merge_do_work will be called before the poll so that processing of the merge can be done.

Parameters

• handler the handler to call for incoming fragments

• clientd the clientd to provide to the handler

• fragment_limit the max number of fragments to process before returning

Return

= 0 indicates the number of fragments processed, -1 for failure

pub fn poll_once<AeronFragmentHandlerHandlerImpl: FnMut(&[u8], AeronHeader)>( &self, handler: AeronFragmentHandlerHandlerImpl, fragment_limit: c_int, ) -> Result<i32, AeronCError>

Poll the image used for the merging replay and live stream. The aeron_archive_replay_merge_do_work will be called before the poll so that processing of the merge can be done.

Parameters

• handler the handler to call for incoming fragments

• clientd the clientd to provide to the handler

• fragment_limit the max number of fragments to process before returning

Return

= 0 indicates the number of fragments processed, -1 for failure

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

pub fn image(&self) -> AeronImage

The image used for the replay and live stream.

Return

the AeronImage

pub fn is_merged(&self) -> bool

Is the live stream merged and the replay stopped?

Return

true if merged, false otherwise

pub fn has_failed(&self) -> bool

Has the replay_merge failed due to an error?

Return

true if an error occurred

pub fn is_live_added(&self) -> bool

Is the live destination added to the subscription?

Return

true if the live destination is added to the subscription

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

Trait Implementations

impl Clone for AeronArchiveReplayMerge

fn clone(&self) -> AeronArchiveReplayMerge

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AeronArchiveReplayMerge

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

Formats the value using the given formatter.

impl Deref for AeronArchiveReplayMerge

type Target = aeron_archive_replay_merge_stct

The resulting type after dereferencing.

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

Dereferences the value.

impl From<&AeronArchiveReplayMerge> for *mut aeron_archive_replay_merge_t

fn from(value: &AeronArchiveReplayMerge) -> Self

Converts to this type from the input type.

impl From<*const aeron_archive_replay_merge_stct> for AeronArchiveReplayMerge

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

Converts to this type from the input type.

impl From<*mut aeron_archive_replay_merge_stct> for AeronArchiveReplayMerge

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

Converts to this type from the input type.

impl From<AeronArchiveReplayMerge> for *mut aeron_archive_replay_merge_t

fn from(value: AeronArchiveReplayMerge) -> Self

Converts to this type from the input type.

impl From<AeronArchiveReplayMerge> for aeron_archive_replay_merge_t

fn from(value: AeronArchiveReplayMerge) -> Self

Converts to this type from the input type.

impl From<aeron_archive_replay_merge_stct> for AeronArchiveReplayMerge

fn from(value: aeron_archive_replay_merge_t) -> Self

Converts to this type from the input type.