Module bindings Copy item path
Summary Source pub use self::aeron_controlled_fragment_handler_action_en as aeron_controlled_fragment_handler_action_t;pub use self::aeron_uri_type_enum as aeron_uri_type_t;pub use self::aeron_uri_ats_status_en as aeron_uri_ats_status_t;pub use self::aeron_cnc_load_result_stct as aeron_cnc_load_result_t;aeron_buffer_claim_stct Structure used to hold information for a try_claim function call. aeron_client_registering_resource_stct aeron_cnc_constants_stct aeron_cnc_metadata_stct aeron_cnc_stct aeron_context_stct aeron_controlled_fragment_assembler_stct aeron_counter_constants_stct Configuration for a counter that does not change during it’s lifetime. aeron_counter_metadata_descriptor_stct aeron_counter_stct aeron_counter_value_descriptor_stct aeron_counters_reader_buffers_stct aeron_counters_reader_stct aeron_data_header_as_longs_stct aeron_data_header_stct aeron_error_stct aeron_exclusive_publication_stct aeron_fragment_assembler_stct aeron_frame_header_stct aeron_header_stct aeron_header_values_frame_stct aeron_header_values_stct aeron_image_constants_stct Configuration for an image that does not change during it’s lifetime. aeron_image_controlled_fragment_assembler_stct aeron_image_fragment_assembler_stct aeron_image_stct aeron_iovec_stct aeron_ipc_channel_params_stct aeron_log_buffer_stct aeron_logbuffer_metadata_stct aeron_loss_reporter_entry_stct aeron_loss_reporter_stct aeron_mapped_buffer_stct aeron_mapped_file_stct aeron_mapped_raw_log_stct aeron_nak_header_stct aeron_on_available_counter_pair_stct aeron_on_close_client_pair_stct aeron_on_unavailable_counter_pair_stct aeron_option_header_stct aeron_per_thread_error_stct aeron_publication_constants_stct Configuration for a publication that does not change during it’s lifetime. aeron_publication_error_values_stct aeron_publication_stct aeron_resolution_header_ipv4_stct aeron_resolution_header_ipv6_stct aeron_resolution_header_stct aeron_response_setup_header_stct aeron_rttm_header_stct aeron_setup_header_stct aeron_status_message_header_stct aeron_status_message_optional_header_stct aeron_stct aeron_str_to_ptr_hash_map_key_stct aeron_str_to_ptr_hash_map_stct aeron_subscription_constants_stct aeron_subscription_stct aeron_udp_channel_params_stct aeron_uri_param_stct aeron_uri_params_stct aeron_uri_stct aeron_uri_string_builder_stct aeron_cnc_load_result_stct aeron_controlled_fragment_handler_action_en aeron_uri_ats_status_en aeron_uri_type_enum AERON_AGENT_ON_START_FUNCTION_ENV_VAR AERON_CACHE_LINE_LENGTH AERON_CLIENT_ERROR_BUFFER_FULL AERON_CLIENT_ERROR_CLIENT_TIMEOUT AERON_CLIENT_ERROR_CONDUCTOR_SERVICE_TIMEOUT AERON_CLIENT_ERROR_DRIVER_TIMEOUT AERON_CLIENT_IDLE_SLEEP_DURATION_ENV_VAR AERON_CLIENT_MAX_LOCAL_ADDRESS_STR_LEN AERON_CLIENT_NAME_ENV_VAR AERON_CLIENT_PRE_TOUCH_MAPPED_MEMORY_ENV_VAR AERON_CLIENT_RESOURCE_LINGER_DURATION_ENV_VAR AERON_CNC_FILE AERON_COMPILER_GCC AERON_COMPILER_LLVM AERON_COUNTER_CACHE_LINE_LENGTH AERON_COUNTER_MAX_CLIENT_NAME_LENGTH AERON_COUNTER_RECORD_ALLOCATED AERON_COUNTER_RECORD_RECLAIMED AERON_COUNTER_RECORD_UNUSED AERON_CPU_X64 AERON_DIR_ENV_VAR AERON_DRIVER_TIMEOUT_ENV_VAR AERON_ERROR_HAS_GROUP_TAG_FLAG AERON_ERROR_MAX_TEXT_LENGTH AERON_ERROR_MAX_TOTAL_LENGTH AERON_FILEUTIL_ERROR_ENOSPC AERON_FORMAT_DATE_MAX_LENGTH AERON_FORMAT_NUMBER_TO_LOCALE_STR_LEN AERON_FRAME_HEADER_VERSION AERON_FRAME_MAX_MESSAGE_LENGTH AERON_IMAGES_DIR AERON_IPC_CHANNEL AERON_LOGBUFFER_DEFAULT_FRAME_HEADER_MAX_LENGTH AERON_LOGBUFFER_FRAME_ALIGNMENT AERON_LOGBUFFER_META_DATA_LENGTH AERON_LOGBUFFER_PADDING_SIZE AERON_LOGBUFFER_PARTITION_COUNT AERON_LOGBUFFER_TERM_MAX_LENGTH AERON_LOGBUFFER_TERM_MIN_LENGTH AERON_LOSS_REPORTER_ENTRY_ALIGNMENT AERON_LOSS_REPORT_FILE AERON_MAP_DEFAULT_LOAD_FACTOR AERON_MAX_PATH AERON_MAX_UDP_PAYLOAD_LENGTH AERON_NULL_COUNTER_ID AERON_NULL_VALUE AERON_OPT_HDR_ALIGNMENT AERON_PAGE_MAX_SIZE AERON_PAGE_MIN_SIZE AERON_PUBLICATIONS_DIR AERON_PUBLICATION_ADMIN_ACTION AERON_PUBLICATION_BACK_PRESSURED AERON_PUBLICATION_CLOSED AERON_PUBLICATION_ERROR AERON_PUBLICATION_MAX_POSITION_EXCEEDED AERON_PUBLICATION_NOT_CONNECTED AERON_RESPONSE_ADDRESS_TYPE_IPV4 AERON_RESPONSE_ADDRESS_TYPE_IPV6 AERON_RES_HEADER_ADDRESS_LENGTH_IP4 AERON_RES_HEADER_ADDRESS_LENGTH_IP6 AERON_RES_HEADER_TYPE_NAME_TO_IP4_MD AERON_RES_HEADER_TYPE_NAME_TO_IP6_MD AERON_SPY_PREFIX AERON_UDP_CHANNEL_CONTROL_KEY AERON_UDP_CHANNEL_CONTROL_MODE_DYNAMIC_VALUE AERON_UDP_CHANNEL_CONTROL_MODE_KEY AERON_UDP_CHANNEL_CONTROL_MODE_MANUAL_VALUE AERON_UDP_CHANNEL_CONTROL_MODE_RESPONSE_VALUE AERON_UDP_CHANNEL_ENDPOINT_KEY AERON_UDP_CHANNEL_INTERFACE_KEY AERON_UDP_CHANNEL_RELIABLE_KEY AERON_UDP_CHANNEL_TTL_KEY AERON_URI_ALIAS_KEY AERON_URI_ATS_KEY AERON_URI_CC_KEY AERON_URI_CHANNEL_RCV_TIMESTAMP_OFFSET_KEY AERON_URI_CHANNEL_SND_TIMESTAMP_OFFSET_KEY AERON_URI_EOS_KEY AERON_URI_FC_KEY AERON_URI_GROUP_KEY AERON_URI_GTAG_KEY AERON_URI_INITIAL_TERM_ID_KEY AERON_URI_INVALID_TAG AERON_URI_LINGER_TIMEOUT_KEY AERON_URI_MAX_LENGTH AERON_URI_MAX_RESEND_KEY AERON_URI_MEDIA_RCV_TIMESTAMP_OFFSET_KEY AERON_URI_MTU_LENGTH_KEY AERON_URI_NAK_DELAY_KEY AERON_URI_PUBLICATION_WINDOW_KEY AERON_URI_RECEIVER_WINDOW_KEY AERON_URI_REJOIN_KEY AERON_URI_RESPONSE_CORRELATION_ID_KEY AERON_URI_SESSION_ID_KEY AERON_URI_SOCKET_RCVBUF_KEY AERON_URI_SOCKET_SNDBUF_KEY AERON_URI_SPARSE_TERM_KEY AERON_URI_SPIES_SIMULATE_CONNECTION_KEY AERON_URI_STREAM_ID_KEY AERON_URI_STRING_BUILDER_MEDIA_KEY AERON_URI_STRING_BUILDER_PREFIX_KEY AERON_URI_TAGS_KEY AERON_URI_TERM_ID_KEY AERON_URI_TERM_LENGTH_KEY AERON_URI_TERM_OFFSET_KEY AERON_URI_TETHER_KEY AERON_URI_TIMESTAMP_OFFSET_RESERVED AERON_URI_UNTETHERED_LINGER_TIMEOUT_KEY AERON_URI_UNTETHERED_RESTING_TIMEOUT_KEY AERON_URI_UNTETHERED_WINDOW_LIMIT_TIMEOUT_KEY aeron_add_available_counter_handler ⚠ Add a handler to be called when a new counter becomes available. aeron_add_close_handler ⚠ Add a handler to be called when client is closed. aeron_add_unavailable_counter_handler ⚠ Add a handler to be called when a new counter becomes unavailable or goes away. aeron_alloc ⚠ aeron_alloc_aligned ⚠ aeron_alloc_no_err ⚠ aeron_async_add_counter ⚠ Asynchronously add a counter using the given client and return an object to use to determine when the
counter is available. aeron_async_add_counter_get_registration_id ⚠ Gets the registration id for addition of the counter. Note that using this after a call to poll the succeeds or
errors is undefined behaviour. As the async_add_counter_t may have been freed. aeron_async_add_counter_poll ⚠ Poll the completion of the aeron_async_add_counter or aeron_async_add_static_counter calls. aeron_async_add_exclusive_exclusive_publication_get_registration_id ⚠ Gets the registration id for addition of the exclusive_publication. Note that using this after a call to poll the
succeeds or errors is undefined behaviour. As the async_add_exclusive_publication_t may have been freed. aeron_async_add_exclusive_publication ⚠ Asynchronously add an exclusive publication using the given client and return an object to use to determine when the
publication is available. aeron_async_add_exclusive_publication_get_registration_id ⚠ Gets the registration id for addition of the exclusive_publication. Note that using this after a call to poll the
succeeds or errors is undefined behaviour. As the async_add_exclusive_publication_t may have been freed. aeron_async_add_exclusive_publication_poll ⚠ Poll the completion of the aeron_async_add_exclusive_publication call. aeron_async_add_publication ⚠ Asynchronously add a publication using the given client and return an object to use to determine when the
publication is available. aeron_async_add_publication_get_registration_id ⚠ Gets the registration id for addition of the publication. Note that using this after a call to poll the succeeds or
errors is undefined behaviour. As the async_add_publication_t may have been freed. aeron_async_add_publication_poll ⚠ Poll the completion of the aeron_async_add_publication call. aeron_async_add_static_counter ⚠ Asynchronously allocates or returns an existing static counter instance using specified type_id and
registration_id. Such counter cannot be deleted and its lifecycle is decoupled from the client that created it.
Returns an object to use to determine when the counter is available. aeron_async_add_subscription ⚠ Asynchronously add a subscription using the given client and return an object to use to determine when the
subscription is available. aeron_async_add_subscription_get_registration_id ⚠ Gets the registration id for addition of the subscription. Note that using this after a call to poll the succeeds or
errors is undefined behaviour. As the async_add_subscription_t may have been freed. aeron_async_add_subscription_poll ⚠ Poll the completion of the aeron_async_add_subscription call. aeron_async_destination_get_registration_id ⚠ Gets the registration_id for the destination command supplied. Note that this is the correlation_id used for
the specified destination command, not the registration_id for the original parent resource (publication,
subscription). aeron_buffer_claim_abort ⚠ Abort the given buffer_claim and assign its position as padding. aeron_buffer_claim_commit ⚠ Commit the given buffer_claim as a complete message available for consumption. aeron_client_id ⚠ Return the client id in use by the client. aeron_close ⚠ Close and delete aeron_t struct. aeron_cnc_close ⚠ Closes the instance of the aeron cnc and frees its resources. aeron_cnc_constants ⚠ Fetch the sets of constant values associated with this command and control file. aeron_cnc_counters_reader ⚠ Gets a counters reader for this command and control file. This does not need to be closed manually, resources
are tied to the instance of aeron_cnc. aeron_cnc_error_log_read ⚠ Reads the current error log for this driver. aeron_cnc_filename ⚠ Get the current file name of the cnc file. aeron_cnc_init ⚠ Initialise an aeron_cnc, which gives user level access to the command and control file used to communicate
with the media driver. Will wait until the media driver has loaded and the cnc file is created, up to timeout_ms.
Use a value of 0 for a non-blocking initialisation. aeron_cnc_loss_reporter_read ⚠ Read all of the data loss observations from the report in the same media driver instances as the cnc file. aeron_cnc_map_file_and_load_metadata ⚠ aeron_cnc_resolve_filename ⚠ aeron_cnc_to_driver_heartbeat ⚠ Gets the timestamp of the last heartbeat sent to the media driver from any client. aeron_cnc_version_volatile ⚠ aeron_context ⚠ Return the aeron_context_t that is in use by the given client. aeron_context_close ⚠ Close and delete aeron_context_t struct. aeron_context_get_agent_on_start_function ⚠ aeron_context_get_agent_on_start_state ⚠ aeron_context_get_client_name ⚠ aeron_context_get_dir ⚠ aeron_context_get_driver_timeout_ms ⚠ aeron_context_get_error_handler ⚠ aeron_context_get_error_handler_clientd ⚠ aeron_context_get_idle_sleep_duration_ns ⚠ aeron_context_get_keepalive_interval_ns ⚠ aeron_context_get_on_available_counter ⚠ aeron_context_get_on_available_counter_clientd ⚠ aeron_context_get_on_close_client ⚠ aeron_context_get_on_close_client_clientd ⚠ aeron_context_get_on_new_exclusive_publication ⚠ aeron_context_get_on_new_exclusive_publication_clientd ⚠ aeron_context_get_on_new_publication ⚠ aeron_context_get_on_new_publication_clientd ⚠ aeron_context_get_on_new_subscription ⚠ aeron_context_get_on_new_subscription_clientd ⚠ aeron_context_get_on_unavailable_counter ⚠ aeron_context_get_on_unavailable_counter_clientd ⚠ aeron_context_get_pre_touch_mapped_memory ⚠ aeron_context_get_publication_error_frame_handler ⚠ aeron_context_get_publication_error_frame_handler_clientd ⚠ aeron_context_get_resource_linger_duration_ns ⚠ aeron_context_get_use_conductor_agent_invoker ⚠ aeron_context_init ⚠ Create a aeron_context_t struct and initialize with default values. aeron_context_request_driver_termination ⚠ Request the media driver terminates operation and closes all resources. aeron_context_set_agent_on_start_function ⚠ aeron_context_set_client_name ⚠ aeron_context_set_dir ⚠ aeron_context_set_driver_timeout_ms ⚠ aeron_context_set_error_handler ⚠ aeron_context_set_idle_sleep_duration_ns ⚠ aeron_context_set_keepalive_interval_ns ⚠ aeron_context_set_on_available_counter ⚠ aeron_context_set_on_close_client ⚠ aeron_context_set_on_new_exclusive_publication ⚠ aeron_context_set_on_new_publication ⚠ aeron_context_set_on_new_subscription ⚠ aeron_context_set_on_unavailable_counter ⚠ aeron_context_set_pre_touch_mapped_memory ⚠ aeron_context_set_publication_error_frame_handler ⚠ aeron_context_set_resource_linger_duration_ns ⚠ aeron_context_set_use_conductor_agent_invoker ⚠ Whether to use an invoker to control the conductor agent or spawn a thread. aeron_controlled_fragment_assembler_create ⚠ Create a controlled fragment assembler for use with a subscription. aeron_controlled_fragment_assembler_delete ⚠ Delete a controlled fragment assembler. aeron_controlled_fragment_assembler_handler ⚠ Handler function to be passed for handling fragment assembly. aeron_counter_addr ⚠ Return a pointer to the counter value. aeron_counter_close ⚠ Asynchronously close the counter. aeron_counter_constants ⚠ Fill in a structure with the constants in use by a counter. aeron_counter_is_closed ⚠ Check if the counter is closed
@param counter to check
@return true if closed, false otherwise. aeron_counters_reader ⚠ Return a reference to the counters reader of the given client. aeron_counters_reader_addr ⚠ Get the address for a counter. aeron_counters_reader_counter_label ⚠ Get the label for a counter. aeron_counters_reader_counter_owner_id ⚠ Get the owner id assigned to a counter which will typically be the client id. aeron_counters_reader_counter_reference_id ⚠ Get the reference id assigned to a counter which will typically be the registration id of an associated Image,
Subscription, Publication, etc. aeron_counters_reader_counter_registration_id ⚠ Get the registration id assigned to a counter. aeron_counters_reader_counter_state ⚠ Get the state for a counter. aeron_counters_reader_counter_type_id ⚠ Get the type id for a counter. aeron_counters_reader_find_by_type_id_and_registration_id ⚠ Iterate over allocated counters and find the first matching a given type id and registration id. aeron_counters_reader_foreach_counter ⚠ Iterate over the counters in the counters_reader and call the given function for each counter. aeron_counters_reader_free_for_reuse_deadline_ms ⚠ Get the free for reuse deadline (ms) for a counter. aeron_counters_reader_get_buffers ⚠ Get buffer pointers and lengths for the counters reader. aeron_counters_reader_max_counter_id ⚠ Get the current max counter id. aeron_counters_reader_metadata_key ⚠ Get a pointer to the key of a counter’s metadata aeron_default_path ⚠ Get the default path used by the Aeron media driver. aeron_delete_directory ⚠ aeron_delete_file ⚠ aeron_epoch_clock ⚠ Return time in milliseconds since epoch. Is wall clock time. aeron_err_append ⚠ aeron_err_clear ⚠ aeron_err_set ⚠ aeron_errcode ⚠ Return current aeron error code (errno) for calling thread. aeron_errmsg ⚠ Return the current aeron error message for calling thread. aeron_error_code_str ⚠ aeron_exclusive_publication_append_padding ⚠ Append a padding record log of a given length to make up the log to a position. aeron_exclusive_publication_async_add_destination ⚠ Add a destination manually to a multi-destination-cast exclusive publication. aeron_exclusive_publication_async_destination_poll ⚠ Poll the completion of the add/remove of a destination to/from an exclusive publication. aeron_exclusive_publication_async_remove_destination ⚠ Remove a destination manually from a multi-destination-cast exclusive publication. aeron_exclusive_publication_async_remove_destination_by_id ⚠ Remove a destination manually from a multi-destination-cast publication. aeron_exclusive_publication_channel_status ⚠ Get the status of the media channel for this publication. aeron_exclusive_publication_close ⚠ Asynchronously close the publication. aeron_exclusive_publication_constants ⚠ Fill in a structure with the constants in use by a publication. aeron_exclusive_publication_is_closed ⚠ Has the exclusive publication closed? aeron_exclusive_publication_is_connected ⚠ Has the exclusive publication seen an active Subscriber recently? aeron_exclusive_publication_local_sockaddrs ⚠ Get all of the local socket addresses for this exclusive publication. Typically only one representing the control
address. aeron_exclusive_publication_offer ⚠ Non-blocking publish of a buffer containing a message. aeron_exclusive_publication_offer_block ⚠ Offer a block of pre-formatted message fragments directly into the current term. aeron_exclusive_publication_offerv ⚠ Non-blocking publish by gathering buffer vectors into a message. aeron_exclusive_publication_position ⚠ Get the current position to which the publication has advanced for this stream. aeron_exclusive_publication_position_limit ⚠ Get the position limit beyond which this publication will be back pressured. aeron_exclusive_publication_revoke ⚠ Asynchronously revoke and close the publication. Will callback on the on_complete notification when the publicaiton is closed.
The callback is optional, use NULL for the on_complete callback if not required. aeron_exclusive_publication_revoke_on_close ⚠ Revoke this publication when it’s closed. aeron_exclusive_publication_try_claim ⚠ 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. aeron_file_length ⚠ aeron_file_resolve ⚠ aeron_format_date ⚠ aeron_format_number_to_locale ⚠ aeron_format_to_hex ⚠ aeron_fragment_assembler_create ⚠ Create a fragment assembler for use with a subscription. aeron_fragment_assembler_delete ⚠ Delete a fragment assembler. aeron_fragment_assembler_handler ⚠ Handler function to be passed for handling fragment assembly. aeron_free ⚠ aeron_header_context ⚠ Get a pointer to the context associated with this message. Only valid during poll handling. Is normally a
pointer to an Image instance. aeron_header_next_term_offset ⚠ Calculates the offset of the frame immediately after this one. aeron_header_position ⚠ Get the current position to which the Image has advanced on reading this message. aeron_header_position_bits_to_shift ⚠ Get the number of times to left shift the term count to multiply by term length. aeron_header_values ⚠ Get all of the field values from the header. This will do a memcpy into the supplied header_values_t pointer. aeron_image_active_transport_count ⚠ Count of observed active transports within the image liveness timeout. aeron_image_block_poll ⚠ Poll for new messages in a stream. If new messages are found beyond the last consumed position then they
will be delivered to the handler up to a limited number of bytes. aeron_image_bounded_controlled_poll ⚠ Poll for new messages in a stream. If new messages are found beyond the last consumed position then they
will be delivered to the handler up to a limited number of fragments as specified or the maximum position specified. aeron_image_bounded_poll ⚠ Poll for new messages in a stream. If new messages are found beyond the last consumed position then they
will be delivered to the handler up to a limited number of fragments as specified or the maximum position specified. aeron_image_constants ⚠ Fill in a structure with the constants in use by a image. aeron_image_controlled_fragment_assembler_create ⚠ Create an image controlled fragment assembler for use with a single image. aeron_image_controlled_fragment_assembler_delete ⚠ Delete an image controlled fragment assembler. aeron_image_controlled_fragment_assembler_handler ⚠ Handler function to be passed for handling fragment assembly. aeron_image_controlled_peek ⚠ Peek for new messages in a stream by scanning forward from an initial position. If new messages are found then
they will be delivered to the handler up to a limited position. aeron_image_controlled_poll ⚠ Poll for new messages in a stream. If new messages are found beyond the last consumed position then they
will be delivered to the handler up to a limited number of fragments as specified. aeron_image_end_of_stream_position ⚠ The position the stream reached when EOS was received from the publisher. The position will be
INT64_MAX until the stream ends and EOS is set. aeron_image_fragment_assembler_create ⚠ Create an image fragment assembler for use with a single image. aeron_image_fragment_assembler_delete ⚠ Delete an image fragment assembler. aeron_image_fragment_assembler_handler ⚠ Handler function to be passed for handling fragment assembly. aeron_image_is_closed ⚠ aeron_image_is_end_of_stream ⚠ Is the current consumed position at the end of the stream? aeron_image_is_publication_revoked ⚠ Was the associated publication revoked? aeron_image_poll ⚠ Poll for new messages in a stream. If new messages are found beyond the last consumed position then they
will be delivered to the handler up to a limited number of fragments as specified. aeron_image_position ⚠ The position this image has been consumed to by the subscriber. aeron_image_reject ⚠ aeron_image_set_position ⚠ Set the subscriber position for this image to indicate where it has been consumed to. aeron_init ⚠ Create a aeron_t client struct and initialize from the aeron_context_t struct. aeron_ipc_publication_location ⚠ aeron_is_closed ⚠ Determines if the client has been closed, e.g. via a driver timeout. Don’t call this method after calling
aeron_close as that will have already freed the associated memory. aeron_is_directory ⚠ aeron_is_driver_active ⚠ Determine if an aeron driver is using a given aeron directory. aeron_logbuffer_check_page_size ⚠ aeron_logbuffer_check_term_length ⚠ aeron_loss_reporter_create_entry ⚠ aeron_loss_reporter_init ⚠ aeron_loss_reporter_read ⚠ aeron_loss_reporter_record_observation ⚠ aeron_loss_reporter_resolve_filename ⚠ aeron_main_do_work ⚠ Call the Conductor main do_work duty cycle once. aeron_main_idle_strategy ⚠ Call the Conductor Idle Strategy. aeron_map_existing_file ⚠ aeron_map_new_file ⚠ aeron_mkdir_recursive ⚠ aeron_msync ⚠ aeron_nano_clock ⚠ Return time in nanoseconds for machine. Is not wall clock time. aeron_network_publication_location ⚠ aeron_next_correlation_id ⚠ Return a unique correlation id from the driver. aeron_print_counters ⚠ Call stream_out to print the counter labels and values. aeron_properties_buffer_load ⚠ Load properties from a string containing name=value pairs and set appropriate environment variables for the
process so that subsequent calls to aeron_driver_context_init will use those values. aeron_properties_file_load ⚠ Load properties file and set appropriate environment variables for the process so that subsequent
calls to aeron_driver_context_init will use those values. aeron_properties_http_load ⚠ Load properties from HTTP URL and set environment variables for the process so that subsequent
calls to aeron_driver_context_init will use those values. aeron_properties_load ⚠ Load properties based on URL or filename. If string contains file or http URL, it will attempt
to load properties from a file or http as indicated. If not a URL, then it will try to load the string
as a filename. aeron_publication_async_add_destination ⚠ Add a destination manually to a multi-destination-cast publication. aeron_publication_async_destination_poll ⚠ Poll the completion of the add/remove of a destination to/from a publication. aeron_publication_async_remove_destination ⚠ Remove a destination manually from a multi-destination-cast publication. aeron_publication_async_remove_destination_by_id ⚠ Remove a destination manually from a multi-destination-cast publication. aeron_publication_channel ⚠ Get the publication’s channel aeron_publication_channel_status ⚠ Get the status of the media channel for this publication. aeron_publication_close ⚠ Asynchronously close the publication. Will callback on the on_complete notification when the publication is closed.
The callback is optional, use NULL for the on_complete callback if not required. aeron_publication_constants ⚠ Fill in a structure with the constants in use by a publication. aeron_publication_error_values_copy ⚠ Copy an existing aeron_publication_error_values_t to the supplied pointer. The caller is responsible for freeing the
allocated memory using aeron_publication_error_values_delete when the copy is not longer required. aeron_publication_error_values_delete ⚠ Delete a instance of aeron_publication_error_values_t that was created when making a copy
(aeron_publication_error_values_copy). This should not be use on the pointer received via the aeron_frame_handler_t.
@param to_delete to be deleted. aeron_publication_image_location ⚠ aeron_publication_is_closed ⚠ Has the publication closed? aeron_publication_is_connected ⚠ Has the publication seen an active Subscriber recently? aeron_publication_local_sockaddrs ⚠ Get all of the local socket addresses for this publication. Typically only one representing the control address. aeron_publication_offer ⚠ Non-blocking publish of a buffer containing a message. aeron_publication_offerv ⚠ Non-blocking publish by gathering buffer vectors into a message. aeron_publication_position ⚠ Get the current position to which the publication has advanced for this stream. aeron_publication_position_limit ⚠ Get the position limit beyond which this publication will be back pressured. aeron_publication_session_id ⚠ Get the publication’s session id
@param publication this
@return session id aeron_publication_stream_id ⚠ Get the publication’s stream id aeron_publication_try_claim ⚠ 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. aeron_randomised_int32 ⚠ aeron_raw_log_close ⚠ aeron_raw_log_free ⚠ aeron_raw_log_map ⚠ aeron_raw_log_map_existing ⚠ aeron_reallocf ⚠ aeron_remove_available_counter_handler ⚠ Remove a previously added handler to be called when a new counter becomes available. aeron_remove_close_handler ⚠ Remove a previously added handler to be called when client is closed. aeron_remove_unavailable_counter_handler ⚠ Remove a previously added handler to be called when a new counter becomes unavailable or goes away. aeron_res_header_entry_length ⚠ aeron_res_header_entry_length_ipv4 ⚠ aeron_res_header_entry_length_ipv6 ⚠ aeron_semantic_version_compose ⚠ aeron_semantic_version_major ⚠ aeron_semantic_version_minor ⚠ aeron_semantic_version_patch ⚠ aeron_set_errno ⚠ aeron_start ⚠ Start an aeron_t. This may spawn a thread for the Client Conductor. aeron_subscription_async_add_destination ⚠ Add a destination manually to a multi-destination-subscription. aeron_subscription_async_destination_poll ⚠ Poll the completion of add/remove of a destination to/from a subscription. aeron_subscription_async_remove_destination ⚠ Remove a destination manually from a multi-destination-subscription. aeron_subscription_block_poll ⚠ Poll the images under the subscription for available message fragments in blocks. aeron_subscription_channel_status ⚠ Get the status of the media channel for this subscription. aeron_subscription_close ⚠ Asynchronously close the subscription. Will callback on the on_complete notification when the subscription is
closed. The callback is optional, use NULL for the on_complete callback if not required. aeron_subscription_constants ⚠ Fill in a structure with the constants in use by a subscription. aeron_subscription_controlled_poll ⚠ Poll in a controlled manner the images under the subscription for available message fragments.
Control is applied to fragments in the stream. If more fragments can be read on another stream
they will even if BREAK or ABORT is returned from the fragment handler. aeron_subscription_for_each_image ⚠ Iterate over the images for this subscription calling the given function. aeron_subscription_image_at_index ⚠ Return the image at the given index. aeron_subscription_image_by_session_id ⚠ Return the image associated with the given session_id under the given subscription. aeron_subscription_image_count ⚠ Count of images associated to this subscription. aeron_subscription_image_release ⚠ Release the given image and relinquish desire to use the image directly. aeron_subscription_image_retain ⚠ Retain the given image for access in the application. aeron_subscription_is_closed ⚠ Is the subscription closed. aeron_subscription_is_connected ⚠ Is this subscription connected by having at least one open publication image. aeron_subscription_local_sockaddrs ⚠ Get all of the local socket addresses for this subscription. Multiple addresses can occur if this is a
multi-destination subscription. Addresses will a string representation in numeric form. IPv6 addresses will be
surrounded by ‘[’ and ‘]’ so that the ‘:’ that separate the parts are distinguishable from the port delimiter.
E.g. [fe80::7552:c06e:6bf4:4160]:12345. As of writing the maximum length for a formatted address is 54 bytes
including the NULL terminator. AERON_CLIENT_MAX_LOCAL_ADDRESS_STR_LEN is defined to provide enough space to fit the
returned string. Returned strings will be NULL terminated. If the buffer to hold the address can not hold enough
of the message it will be truncated and the last character will be null. aeron_subscription_poll ⚠ Poll the images under the subscription for available message fragments. aeron_subscription_resolved_endpoint ⚠ Retrieves the first local socket address for this subscription. If this is not MDS then it will be the one
representing endpoint for this subscription. aeron_subscription_try_resolve_channel_endpoint_port ⚠ Retrieves the channel URI for this subscription with any wildcard ports filled in. If the channel is not UDP or
does not have a wildcard port (0), then it will return the original URI. aeron_temp_filename ⚠ aeron_tokenise ⚠ aeron_udp_protocol_group_tag ⚠ aeron_unmap ⚠ aeron_uri_close ⚠ aeron_uri_find_param_value ⚠ aeron_uri_get_ats ⚠ aeron_uri_get_bool ⚠ aeron_uri_get_int32 ⚠ aeron_uri_get_int64 ⚠ aeron_uri_get_receiver_window_length ⚠ aeron_uri_get_socket_buf_lengths ⚠ aeron_uri_get_timeout ⚠ aeron_uri_multicast_ttl ⚠ aeron_uri_parse ⚠ aeron_uri_parse_params ⚠ aeron_uri_parse_tag ⚠ aeron_uri_sprint ⚠ aeron_uri_string_builder_close ⚠ aeron_uri_string_builder_get ⚠ aeron_uri_string_builder_init_new ⚠ aeron_uri_string_builder_init_on_string ⚠ aeron_uri_string_builder_put ⚠ aeron_uri_string_builder_put_int32 ⚠ aeron_uri_string_builder_put_int64 ⚠ aeron_uri_string_builder_set_initial_position ⚠ aeron_uri_string_builder_sprint ⚠ aeron_usable_fs_space ⚠ aeron_usable_fs_space_disabled ⚠ aeron_version_full ⚠ Return full version and build string. aeron_version_gitsha ⚠ Return the git sha for the current build. aeron_version_major ⚠ Return major version number. aeron_version_minor ⚠ Return minor version number. aeron_version_patch ⚠ Return patch version number. aeron_version_text ⚠ Return version text. aeron_agent_on_start_func_t aeron_async_add_counter_t aeron_async_add_exclusive_publication_t aeron_async_add_publication_t aeron_async_add_subscription_t aeron_async_destination_by_id_t aeron_async_destination_t aeron_block_handler_t Callback for handling a block of messages being read from a log. aeron_buffer_claim_t Structure used to hold information for a try_claim function call. aeron_clock_func_t Clock function used by aeron. aeron_cnc_constants_t aeron_cnc_metadata_t aeron_cnc_t aeron_context_t aeron_controlled_fragment_assembler_t aeron_controlled_fragment_handler_t Callback for handling fragments of data being read from a log. aeron_counter_constants_t Configuration for a counter that does not change during it’s lifetime. aeron_counter_metadata_descriptor_t aeron_counter_t aeron_counter_value_descriptor_t aeron_counters_reader_buffers_t aeron_counters_reader_foreach_counter_func_t Function called by aeron_counters_reader_foreach_counter for each counter in the aeron_counters_reader_t. aeron_counters_reader_t aeron_data_header_as_longs_t aeron_data_header_t aeron_error_handler_t The error handler to be called when an error occurs. aeron_error_log_reader_func_t aeron_error_t aeron_exclusive_publication_t aeron_fptr_t aeron_fragment_assembler_t aeron_fragment_handler_t Callback for handling fragments of data being read from a log. aeron_frame_header_t aeron_header_t aeron_header_values_frame_t aeron_header_values_t aeron_idle_strategy_func_t aeron_idle_strategy_init_func_t aeron_image_constants_t Configuration for an image that does not change during it’s lifetime. aeron_image_controlled_fragment_assembler_t aeron_image_fragment_assembler_t aeron_image_t aeron_iovec_t aeron_ipc_channel_params_t aeron_log_buffer_t aeron_log_func_t Function to return logging information. aeron_logbuffer_metadata_t aeron_loss_reporter_entry_offset_t aeron_loss_reporter_entry_t aeron_loss_reporter_read_entry_func_t aeron_loss_reporter_t aeron_mapped_buffer_t aeron_mapped_file_t aeron_mapped_raw_log_t aeron_nak_header_t aeron_notification_t Generalised notification callback. aeron_on_available_counter_pair_t aeron_on_available_counter_t Function called by aeron_client_t to deliver notifications that a counter has been added to the driver. aeron_on_available_image_t Function called by aeron_client_t to deliver notifications that an aeron_image_t was added. aeron_on_close_client_pair_t aeron_on_close_client_t Function called by aeron_client_t to deliver notifications that the client is closing. aeron_on_new_publication_t Function called by aeron_client_t to deliver notification that the media driver has added an aeron_publication_t
or aeron_exclusive_publication_t successfully. aeron_on_new_subscription_t Function called by aeron_client_t to deliver notification that the media driver has added an aeron_subscription_t
successfully. aeron_on_unavailable_counter_pair_t aeron_on_unavailable_counter_t Function called by aeron_client_t to deliver notifications that a counter has been removed from the driver. aeron_on_unavailable_image_t Function called by aeron_client_t to deliver notifications that an aeron_image_t has been removed from use and
should not be used any longer. aeron_option_header_t aeron_per_thread_error_t aeron_publication_constants_t Configuration for a publication that does not change during it’s lifetime. aeron_publication_error_frame_handler_t The error frame handler to be called when the driver notifies the client about an error frame being received.
The data passed to this callback will only be valid for the lifetime of the callback. The user should use
aeron_publication_error_values_copy if they require the data to live longer than that. aeron_publication_error_values_t aeron_publication_t aeron_raw_log_close_func_t aeron_raw_log_free_func_t aeron_raw_log_map_func_t aeron_reserved_value_supplier_t Function called when filling in the reserved value field of a message. aeron_resolution_header_ipv4_t aeron_resolution_header_ipv6_t aeron_resolution_header_t aeron_response_setup_header_t aeron_rttm_header_t aeron_setup_header_t aeron_status_message_header_t aeron_status_message_optional_header_t aeron_str_to_ptr_hash_map_for_each_func_t aeron_str_to_ptr_hash_map_key_t aeron_str_to_ptr_hash_map_t aeron_subscription_constants_t aeron_subscription_t aeron_t aeron_udp_channel_params_t aeron_uri_param_t aeron_uri_params_t aeron_uri_parse_callback_t aeron_uri_string_builder_t aeron_uri_t aeron_usable_fs_space_func_t aeron_uri_stct__bindgen_ty_1