Struct AeronExclusivePublication

pub struct AeronExclusivePublication { /* private fields */ }

Implementations

impl AeronExclusivePublication

pub fn new_zeroed() -> Result<Self, AeronCError>

creates zeroed struct where the underlying c struct is on the heap

pub fn offer<AeronReservedValueSupplierHandlerImpl: AeronReservedValueSupplierCallback>( &self, buffer: &[u8], reserved_value_supplier: Option<&Handler<AeronReservedValueSupplierHandlerImpl>>, ) -> i64

Non-blocking publish of a buffer containing a message.

Parameters

• buffer to publish.

• length of the buffer.

• reserved_value_supplier to use for setting the reserved value field or NULL.

• clientd to pass to the reserved_value_supplier.

Return

the new stream position otherwise a negative error value.

pub fn offer_once<AeronReservedValueSupplierHandlerImpl: FnMut(*mut u8, usize) -> i64>( &self, buffer: &[u8], reserved_value_supplier: AeronReservedValueSupplierHandlerImpl, ) -> i64

Non-blocking publish of a buffer containing a message.

Parameters

• buffer to publish.

• length of the buffer.

• reserved_value_supplier to use for setting the reserved value field or NULL.

• clientd to pass to the reserved_value_supplier.

Return

the new stream position otherwise a negative error value.

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

pub fn offerv<AeronReservedValueSupplierHandlerImpl: AeronReservedValueSupplierCallback>( &self, iov: &AeronIovec, iovcnt: usize, reserved_value_supplier: Option<&Handler<AeronReservedValueSupplierHandlerImpl>>, ) -> i64

Non-blocking publish by gathering buffer vectors into a message.

Parameters

• iov array for the vectors

• iovcnt of the number of vectors

• reserved_value_supplier to use for setting the reserved value field or NULL.

• clientd to pass to the reserved_value_supplier.

Return

the new stream position otherwise a negative error value.

pub fn offerv_once<AeronReservedValueSupplierHandlerImpl: FnMut(*mut u8, usize) -> i64>( &self, iov: &AeronIovec, iovcnt: usize, reserved_value_supplier: AeronReservedValueSupplierHandlerImpl, ) -> i64

Non-blocking publish by gathering buffer vectors into a message.

Parameters

• iov array for the vectors

• iovcnt of the number of vectors

• reserved_value_supplier to use for setting the reserved value field or NULL.

• clientd to pass to the reserved_value_supplier.

Return

the new stream position otherwise a negative error value.

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

pub fn try_claim(&self, length: usize, buffer_claim: &AeronBufferClaim) -> i64

Try to claim a range in the publication log into which a message can be written with zero copy semantics. Once the message has been written then aeron_buffer_claim_commit should be called thus making it available. A claim length cannot be greater than max payload length.

Note: This method can only be used for message lengths less than MTU length minus header.

@code AeronBufferClaim buffer_claim;

if (AeronExclusivePublicationry_claim(publication, length, &buffer_claim) > 0L) { // work with buffer_claim->data directly. aeron_buffer_claim_commit(&buffer_claim); } @endcode

Parameters

• length of the message.

• buffer_claim to be populated if the claim succeeds.

Return

the new stream position otherwise a negative error value.

pub fn append_padding(&self, length: usize) -> i64

Append a padding record log of a given length to make up the log to a position.

Parameters

• length of the range to claim, in bytes.

Return

the new stream position otherwise a negative error value.

pub fn offer_block(&self, buffer: &[u8]) -> i64

Offer a block of pre-formatted message fragments directly into the current term.

Parameters

• buffer containing the pre-formatted block of message fragments.

• offset offset in the buffer at which the first fragment begins.

Return

the new stream position otherwise a negative error value.

pub fn channel_status(&self) -> i64

Get the status of the media channel for this publication.

The status will be ERRORED (-1) if a socket exception occurs on setup and ACTIVE (1) if all is well.

Return

1 for ACTIVE, -1 for ERRORED

pub fn constants( &self, constants: &AeronPublicationConstants, ) -> Result<i32, AeronCError>

Fill in a structure with the constants in use by a publication.

Parameters

• publication to get the constants for.

• constants structure to fill in with the constants

Return

0 for success and -1 for error.

pub fn get_constants(&self) -> Result<AeronPublicationConstants, AeronCError>

Fill in a structure with the constants in use by a publication.

pub fn position(&self) -> i64

Get the current position to which the publication has advanced for this stream.

Return

the current position to which the publication has advanced for this stream or a negative error value.

pub fn position_limit(&self) -> i64

Get the position limit beyond which this publication will be back pressured.

This should only be used as a guide to determine when back pressure is likely to be applied.

Return

the position limit beyond which this publication will be back pressured or a negative error value.

pub fn close<AeronNotificationHandlerImpl: AeronNotificationCallback>( &self, on_close_complete: Option<&Handler<AeronNotificationHandlerImpl>>, ) -> Result<i32, AeronCError>

Asynchronously close the publication.

Return

0 for success or -1 for error.

pub fn close_once<AeronNotificationHandlerImpl: FnMut()>( &self, on_close_complete: AeronNotificationHandlerImpl, ) -> Result<i32, AeronCError>

Asynchronously close the publication.

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

pub fn is_closed(&self) -> bool

Has the exclusive publication closed?

Return

true if this publication is closed.

pub fn is_connected(&self) -> bool

Has the exclusive publication seen an active Subscriber recently?

Return

true if this publication has recently seen an active subscriber otherwise false.

pub fn local_sockaddrs( &self, address_vec: &AeronIovec, address_vec_len: usize, ) -> Result<i32, AeronCError>

Get all of the local socket addresses for this exclusive publication. Typically only one representing the control address.

@see aeron_subscription_local_Sockaddrs

Parameters

• address_vec to hold the received addresses

• address_vec_len available length of the vector to hold the addresses

Return

number of addresses found or -1 if there is an error.

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

impl AeronExclusivePublication

pub fn new( async_: &AeronAsyncAddExclusivePublication, ) -> Result<Self, AeronCError>

impl AeronExclusivePublication

pub fn async_add_destination( &mut self, client: &Aeron, destination: &str, ) -> Result<AeronAsyncDestination, AeronCError>

pub fn add_destination( &mut self, client: &Aeron, destination: &str, timeout: Duration, ) -> Result<(), AeronCError>

Trait Implementations

impl Clone for AeronExclusivePublication

fn clone(&self) -> AeronExclusivePublication

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AeronExclusivePublication

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

Formats the value using the given formatter.

impl Deref for AeronExclusivePublication

type Target = aeron_exclusive_publication_stct

The resulting type after dereferencing.

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

Dereferences the value.

impl From<&AeronExclusivePublication> for *mut aeron_exclusive_publication_t

fn from(value: &AeronExclusivePublication) -> Self

Converts to this type from the input type.

impl From<*const aeron_exclusive_publication_stct> for AeronExclusivePublication

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

Converts to this type from the input type.

impl From<*mut aeron_exclusive_publication_stct> for AeronExclusivePublication

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

Converts to this type from the input type.

impl From<AeronExclusivePublication> for *mut aeron_exclusive_publication_t

fn from(value: AeronExclusivePublication) -> Self

Converts to this type from the input type.

impl From<AeronExclusivePublication> for aeron_exclusive_publication_t

fn from(value: AeronExclusivePublication) -> Self

Converts to this type from the input type.

impl From<aeron_exclusive_publication_stct> for AeronExclusivePublication

fn from(value: aeron_exclusive_publication_t) -> Self

Converts to this type from the input type.

impl Send for AeronExclusivePublication

impl Sync for AeronExclusivePublication