Skip to main content

Handler

Struct Handler 

Source
pub struct Handler<T> { /* private fields */ }
Expand description

A reference-counted callback that C stores and calls later.

Clones share one heap allocation. C uses the pointer from Handler::as_raw, so the callback must stay alive until C stops using it. Dropping a Handler does not unregister it, and the callback is freed when its last clone drops.

Owned resources retain handler clones until their last owner drops and C cleanup finishes. The client also retains publication, subscription and counter handlers, because the conductor can call them after close() returns. An archive connection copies handler pointers when it starts, so replacing a handler on the original context neither updates that copy nor frees the old handler. Borrowed wrappers retain nothing, so keep your Handler alive while C can call it.

Earlier manual cleanup often freed handlers while C could still call them, causing crashes or memory corruption. Keeping them through cleanup avoids this mistake, but keeps replaced closures and their captured values in memory too. Earlier release needs to track every C user through connection setup and cleanup. An Arc alone cannot track C’s raw pointer copies.

To replace callbacks often, register an AeronErrorHandlerSlot once. Use set or clear to free old callbacks after their last call.

Use *_fn or *_once for callbacks that run during the call. Their closures stay on the stack, can borrow local variables and need no heap allocation.

Handler<T> is Send when T is Send. It is also Sync when T is Send and the multi-threaded feature is enabled.

use rusteron_code_gen::Handler;
let handler = Handler::new(your_value);
// The callback is freed when its last Handler clone drops.

Implementations§

Source§

impl<T> Handler<T>

Source

pub fn new(handler: T) -> Self

Source

pub fn as_raw(&self) -> *mut c_void

Source

pub unsafe fn get_mut(&self) -> &mut T

Get a mutable reference to the inner value.

§Safety

Caller must ensure that no other references to the inner value are active.

Source§

impl<T: AeronFragmentHandlerCallback + 'static> Handler<T>

Source

pub fn with_fragment_assembler( handler: T, ) -> Result<(Handler<AeronFragmentAssembler>, Handler<T>), AeronCError>

Wrap handler in a fragment assembler; both are reference-counted and freed automatically when the last clones drop (the assembler keeps the delegate alive).

Source

pub fn leak_with_fragment_assembler( handler: T, ) -> Result<(Handler<AeronFragmentAssembler>, Handler<T>), AeronCError>

👎Deprecated:

use Handler::with_fragment_assembler

Source§

impl<T: AeronControlledFragmentHandlerCallback + 'static> Handler<T>

Source

pub fn with_controlled_fragment_assembler( handler: T, ) -> Result<(Handler<AeronControlledFragmentAssembler>, Handler<T>), AeronCError>

Wrap handler in a controlled fragment assembler; both are reference-counted and freed automatically when the last clones drop.

Source

pub fn leak_with_controlled_fragment_assembler( handler: T, ) -> Result<(Handler<AeronControlledFragmentAssembler>, Handler<T>), AeronCError>

👎Deprecated:

use Handler::with_controlled_fragment_assembler

Trait Implementations§

Source§

impl<T: AeronAgentCloseFuncCallback> AeronAgentCloseFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

impl<T: AeronAgentDoWorkFuncCallback> AeronAgentDoWorkFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

impl<T: AeronAgentStartFuncCallback> AeronAgentStartFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

impl<T: AeronAvailableCounterCallback> AeronAvailableCounterCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

fn handle_aeron_on_available_counter( &mut self, counters_reader: &AeronCountersReader, registration_id: i64, counter_id: i32, )

Source§

impl<T: AeronAvailableImageCallback> AeronAvailableImageCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

fn handle_aeron_on_available_image( &mut self, subscription: &AeronSubscription, image: &AeronImage, )

Source§

impl<T: AeronBlockHandlerCallback> AeronBlockHandlerCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

fn handle_aeron_block_handler( &mut self, buffer: &[u8], session_id: i32, term_id: i32, )

Source§

impl<T: AeronCloseClientCallback> AeronCloseClientCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

impl<T: AeronCongestionControlStrategyInitialWindowLengthFuncCallback> AeronCongestionControlStrategyInitialWindowLengthFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

impl<T: AeronCongestionControlStrategyMaxWindowLengthFuncCallback> AeronCongestionControlStrategyMaxWindowLengthFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

impl<T: AeronCongestionControlStrategyRttmFuncCallback> AeronCongestionControlStrategyRttmFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

fn handle_aeron_congestion_control_strategy_on_rttm_func( &mut self, now_ns: i64, rtt_ns: i64, source_address: &SockaddrStorage, )

Source§

impl<T: AeronCongestionControlStrategyRttmSentFuncCallback> AeronCongestionControlStrategyRttmSentFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

impl<T: AeronCongestionControlStrategyShouldMeasureRttFuncCallback> AeronCongestionControlStrategyShouldMeasureRttFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

impl<T: AeronControlledFragmentHandlerCallback> AeronControlledFragmentHandlerCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

impl<T: AeronCountersReaderForeachCounterFuncCallback> AeronCountersReaderForeachCounterFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

fn handle_aeron_counters_reader_foreach_counter_func( &mut self, value: i64, id: i32, type_id: i32, key: &[u8], label: &str, )

Source§

impl<T: AeronCountersReaderForeachMetadataFuncCallback> AeronCountersReaderForeachMetadataFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

fn handle_aeron_counters_reader_foreach_metadata_func( &mut self, id: i32, type_id: i32, key: &[u8], label: &[u8], )

Source§

impl<T: AeronDriverTerminationHookFuncCallback> AeronDriverTerminationHookFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

impl<T: AeronDriverTerminationValidatorFuncCallback> AeronDriverTerminationValidatorFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

impl<T: AeronDutyCycleTrackerMeasureAndUpdateFuncCallback> AeronDutyCycleTrackerMeasureAndUpdateFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

impl<T: AeronDutyCycleTrackerUpdateFuncCallback> AeronDutyCycleTrackerUpdateFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

impl<T: AeronEndOfLifeResourceFreeCallback> AeronEndOfLifeResourceFreeCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

impl<T: AeronErrorHandlerCallback> AeronErrorHandlerCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

fn handle_aeron_error_handler(&mut self, errcode: c_int, message: &str)

Source§

impl<T: AeronErrorLogReaderFuncCallback> AeronErrorLogReaderFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

fn handle_aeron_error_log_reader_func( &mut self, observation_count: i32, first_observation_timestamp: i64, last_observation_timestamp: i64, error: &str, )

Source§

impl<T: AeronFlowControlStrategyErrorFuncCallback> AeronFlowControlStrategyErrorFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

fn handle_aeron_flow_control_strategy_on_error_func( &mut self, error: &[u8], recv_addr: &SockaddrStorage, now_ns: i64, )

Source§

impl<T: AeronFlowControlStrategyIdleFuncCallback> AeronFlowControlStrategyIdleFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

fn handle_aeron_flow_control_strategy_on_idle_func( &mut self, now_ns: i64, snd_lmt: i64, snd_pos: i64, is_end_of_stream: bool, ) -> i64

Source§

impl<T: AeronFlowControlStrategyMaxRetransmissionLengthFuncCallback> AeronFlowControlStrategyMaxRetransmissionLengthFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

fn handle_aeron_flow_control_strategy_max_retransmission_length_func( &mut self, term_offset: usize, resend_length: usize, term_buffer_length: usize, mtu_length: usize, ) -> usize

Source§

impl<T: AeronFlowControlStrategySetupFuncCallback> AeronFlowControlStrategySetupFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

fn handle_aeron_flow_control_strategy_on_setup_func( &mut self, setup: &[u8], now_ns: i64, snd_lmt: i64, position_bits_to_shift: usize, snd_pos: i64, ) -> i64

Source§

impl<T: AeronFlowControlStrategySmFuncCallback> AeronFlowControlStrategySmFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

fn handle_aeron_flow_control_strategy_on_sm_func( &mut self, sm: &[u8], recv_addr: &SockaddrStorage, snd_lmt: i64, initial_term_id: i32, position_bits_to_shift: usize, now_ns: i64, ) -> i64

Source§

impl<T: AeronFlowControlStrategyTriggerSendSetupFuncCallback> AeronFlowControlStrategyTriggerSendSetupFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

impl<T: AeronFprintfHandlerCallback> AeronFprintfHandlerCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

fn handle_aeron_fprintf_handler( &mut self, arg1: &str, arg2: u64, arg4: &str, arg5: *mut c_char, ) -> c_int

Source§

impl<T: AeronFragmentHandlerCallback> AeronFragmentHandlerCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

fn handle_aeron_fragment_handler(&mut self, buffer: &[u8], header: &AeronHeader)

Source§

impl<T: AeronIdleStrategyFuncCallback> AeronIdleStrategyFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

impl<T: AeronIfaddrFuncCallback> AeronIfaddrFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

fn handle_aeron_ifaddr_func( &mut self, name: &str, addr: &Sockaddr, netmask: &Sockaddr, flags: c_uint, ) -> c_int

Source§

impl<T: AeronInt64CounterMapForEachFuncCallback> AeronInt64CounterMapForEachFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

impl<T: AeronInt64CounterMapPredicateFuncCallback> AeronInt64CounterMapPredicateFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

impl<T: AeronInt64ToPtrHashMapForEachFuncCallback> AeronInt64ToPtrHashMapForEachFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

impl<T: AeronInt64ToPtrHashMapPredicateFuncCallback> AeronInt64ToPtrHashMapPredicateFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

impl<T: AeronInt64ToTaggedPtrHashMapForEachFuncCallback> AeronInt64ToTaggedPtrHashMapForEachFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

impl<T: AeronInt64ToTaggedPtrHashMapPredicateFuncCallback> AeronInt64ToTaggedPtrHashMapPredicateFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

impl<T: AeronLossGeneratorShouldDropFrameDetailedFuncCallback> AeronLossGeneratorShouldDropFrameDetailedFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

fn handle_aeron_loss_generator_should_drop_frame_detailed_func( &mut self, address: *const sockaddr_storage, buffer: *const u8, stream_id: i32, session_id: i32, term_id: i32, term_offset: i32, length: i32, ) -> bool

Source§

impl<T: AeronLossGeneratorShouldDropFrameSimpleFuncCallback> AeronLossGeneratorShouldDropFrameSimpleFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

impl<T: AeronLossReporterReadEntryFuncCallback> AeronLossReporterReadEntryFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

fn handle_aeron_loss_reporter_read_entry_func( &mut self, observation_count: i64, total_bytes_lost: i64, first_observation_timestamp: i64, last_observation_timestamp: i64, session_id: i32, stream_id: i32, channel: &str, source: &str, )

Source§

impl<T: AeronNewPublicationCallback> AeronNewPublicationCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

fn handle_aeron_on_new_publication( &mut self, channel: &str, stream_id: i32, session_id: i32, correlation_id: i64, )

Source§

impl<T: AeronNewSubscriptionCallback> AeronNewSubscriptionCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

fn handle_aeron_on_new_subscription( &mut self, channel: &str, stream_id: i32, correlation_id: i64, )

Source§

impl<T: AeronNotificationCallback> AeronNotificationCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

impl<T: AeronPortManagerFreeManagedPortFuncCallback> AeronPortManagerFreeManagedPortFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

impl<T: AeronPortManagerGetManagedPortFuncCallback> AeronPortManagerGetManagedPortFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

impl<T: AeronPublicationErrorFrameHandlerCallback> AeronPublicationErrorFrameHandlerCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

impl<T: AeronQueueDrainFuncCallback> AeronQueueDrainFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

impl<T: AeronRbControlledHandlerCallback> AeronRbControlledHandlerCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

impl<T: AeronRbHandlerCallback> AeronRbHandlerCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

fn handle_aeron_rb_handler( &mut self, arg1: i32, arg2: *const c_void, arg3: usize, )

Source§

impl<T: AeronReceiveChannelLossSupplierFuncCallback> AeronReceiveChannelLossSupplierFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

impl<T: AeronReservedValueSupplierCallback> AeronReservedValueSupplierCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

fn handle_aeron_reserved_value_supplier(&mut self, buffer: &mut [u8]) -> i64

Source§

impl<T: AeronRetransmitHandlerResendFuncCallback> AeronRetransmitHandlerResendFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

fn handle_aeron_retransmit_handler_resend_func( &mut self, term_id: i32, term_offset: i32, length: usize, ) -> c_int

Source§

impl<T: AeronSendChannelLossSupplierFuncCallback> AeronSendChannelLossSupplierFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

impl<T: AeronStrToPtrHashMapForEachFuncCallback> AeronStrToPtrHashMapForEachFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

impl<T: AeronTermGapScannerGapDetectedFuncCallback> AeronTermGapScannerGapDetectedFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

fn handle_aeron_term_gap_scanner_on_gap_detected_func( &mut self, term_id: i32, term_offset: i32, length: usize, )

Source§

impl<T: AeronUnavailableCounterCallback> AeronUnavailableCounterCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

fn handle_aeron_on_unavailable_counter( &mut self, counters_reader: &AeronCountersReader, registration_id: i64, counter_id: i32, )

Source§

impl<T: AeronUnavailableImageCallback> AeronUnavailableImageCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

impl<T: AeronUriHostnameResolverFuncCallback> AeronUriHostnameResolverFuncCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

impl<T: AeronUriParseCallbackCallback> AeronUriParseCallbackCallback for Handler<T>

Pass an existing Handler clone anywhere a callback value is expected, e.g. to share one callback instance across several registrations.

Source§

fn handle_aeron_uri_parse_callback(&mut self, key: &str, value: &str) -> c_int

Source§

impl<T> Clone for Handler<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T> Deref for Handler<T>

Source§

type Target = T

The resulting type after dereferencing.
Source§

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

Dereferences the value.
Source§

impl<T: Send> Send for Handler<T>

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for Handler<T>

§

impl<T> !Sync for Handler<T>

§

impl<T> !UnwindSafe for Handler<T>

§

impl<T> Freeze for Handler<T>

§

impl<T> Unpin for Handler<T>

§

impl<T> UnsafeUnpin for Handler<T>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.