Type Alias aeron_publication_constants_t

pub type aeron_publication_constants_t = aeron_publication_constants_stct;

Configuration for a publication that does not change during it’s lifetime.

Aliased Type

struct aeron_publication_constants_t {

    pub channel: *const i8,
    pub original_registration_id: i64,
    pub registration_id: i64,
    pub max_possible_position: i64,
    pub position_bits_to_shift: usize,
    pub term_buffer_length: usize,
    pub max_message_length: usize,
    pub max_payload_length: usize,
    pub stream_id: i32,
    pub session_id: i32,
    pub initial_term_id: i32,
    pub publication_limit_counter_id: i32,
    pub channel_status_indicator_id: i32,
}

Fields

channel: *const i8

Media address for delivery to the channel.

This returns a pointer only valid for the lifetime of the publication.

original_registration_id: i64

The registration used to register this Publication with the media driver by the first publisher.

registration_id: i64

Get the registration id used to register this Publication with the media driver.

If this value is different from the original_registration_id then a previous active registration exists.

max_possible_position: i64

The maximum possible position this stream can reach due to its term buffer length.

Maximum possible position is term-length times 2^31 in bytes.

position_bits_to_shift: usize

Number of bits to right shift a position to get a term count for how far the stream has progressed.

term_buffer_length: usize

Get the length in bytes for each term partition in the log buffer.

max_message_length: usize

Maximum message length supported in bytes. Messages may be made of multiple fragments if greater than MTU length.

max_payload_length: usize

Maximum length of a message payload that fits within a message fragment.

This is the MTU length minus the message fragment header length.

stream_id: i32

Stream id of the publication.

session_id: i32

Session id of the publication.

initial_term_id: i32

The initial term id assigned when this publication was created. This can be used to determine how many terms have passed since creation.

publication_limit_counter_id: i32

Counter id for the publication limit.

channel_status_indicator_id: i32

Counter id for the channel status indicator

Trait Implementations

impl From<AeronPublicationConstants> for aeron_publication_constants_t

fn from(value: AeronPublicationConstants) -> Self

Converts to this type from the input type.

impl Clone for aeron_publication_constants_stct

fn clone(&self) -> aeron_publication_constants_stct

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for aeron_publication_constants_stct

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

Formats the value using the given formatter.

impl Default for aeron_publication_constants_stct

fn default() -> Self

Returns the “default value” for a type.

impl Hash for aeron_publication_constants_stct

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for aeron_publication_constants_stct

fn eq(&self, other: &aeron_publication_constants_stct) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for aeron_publication_constants_stct

impl Eq for aeron_publication_constants_stct

impl StructuralPartialEq for aeron_publication_constants_stct