pub struct AeronArchiveRecordingDescriptorPoller { /* private fields */ }Implementations§
Source§impl AeronArchiveRecordingDescriptorPoller
impl AeronArchiveRecordingDescriptorPoller
Sourcepub fn new_zeroed_on_heap() -> Self
pub fn new_zeroed_on_heap() -> Self
creates zeroed struct where the underlying c struct is on the heap
Sourcepub fn new_zeroed_on_stack() -> Self
pub fn new_zeroed_on_stack() -> Self
creates zeroed struct where the underlying c struct is on the stack (Use with care)
pub fn ctx(&self) -> Ref<'_, AeronArchiveContext>
pub fn subscription(&self) -> Ref<'_, AeronSubscription>
pub fn control_session_id(&self) -> i64
pub fn fragment_limit(&self) -> c_int
pub fn fragment_assembler(&self) -> Ref<'_, AeronControlledFragmentAssembler>
pub fn error_on_fragment(&self) -> bool
pub fn correlation_id(&self) -> i64
pub fn remaining_record_count(&self) -> i32
pub fn recording_descriptor_consumer( &self, ) -> aeron_archive_recording_descriptor_consumer_func_t
pub fn recording_descriptor_consumer_clientd(&self) -> *mut c_void
pub fn is_dispatch_complete(&self) -> bool
pub fn get_inner(&self) -> *mut aeron_archive_recording_descriptor_poller_t
Sourcepub unsafe fn get_inner_mut(
&self,
) -> &mut aeron_archive_recording_descriptor_poller_t
pub unsafe fn get_inner_mut( &self, ) -> &mut aeron_archive_recording_descriptor_poller_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_recording_descriptor_poller_t
Source§impl AeronArchiveRecordingDescriptorPoller
impl AeronArchiveRecordingDescriptorPoller
Sourcepub fn close(self) -> Result<(), AeronCError>
pub fn close(self) -> Result<(), AeronCError>
Closes this resource in the C client immediately; all clones of this handle become closed (their pointer is nulled) and must not be used.
Source§impl AeronArchiveRecordingDescriptorPoller
impl AeronArchiveRecordingDescriptorPoller
Sourcepub fn new(
archive: &AeronArchive,
fragment_limit: i32,
) -> Result<Self, AeronCError>
pub fn new( archive: &AeronArchive, fragment_limit: i32, ) -> Result<Self, AeronCError>
A poller you own, for listing recordings without blocking. Send the request with
AeronArchive::archive_proxy, call Self::reset with the same correlation id, then
call Self::poll until Self::is_dispatch_complete.
It reads the archive’s control responses, so don’t poll it while a blocking archive call is running.
Source§impl AeronArchiveRecordingDescriptorPoller
impl AeronArchiveRecordingDescriptorPoller
Sourcepub fn reset<H: AeronArchiveRecordingDescriptorConsumerFuncCallback + 'static>(
&self,
correlation_id: i64,
record_count: i32,
recording_descriptor_consumer: Option<&Handler<H>>,
) -> Result<(), AeronCError>
pub fn reset<H: AeronArchiveRecordingDescriptorConsumerFuncCallback + 'static>( &self, correlation_id: i64, record_count: i32, recording_descriptor_consumer: Option<&Handler<H>>, ) -> Result<(), AeronCError>
Sets up the poller for the next poll, which calls recording_descriptor_consumer for
each descriptor received. The poller keeps the handler alive, so a borrowed poller (as
returned by AeronArchive) returns an error and C is not changed
Sourcepub fn poll(&self) -> Result<i32, AeronCError>
pub fn poll(&self) -> Result<i32, AeronCError>
Polls for descriptors, calling the consumer given to reset. A panic in the consumer is
raised here once C returns
Trait Implementations§
Source§impl Clone for AeronArchiveRecordingDescriptorPoller
impl Clone for AeronArchiveRecordingDescriptorPoller
Source§fn clone(&self) -> AeronArchiveRecordingDescriptorPoller
fn clone(&self) -> AeronArchiveRecordingDescriptorPoller
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more