C++ API

Class Hierarchy

- Struct cpp2c_Publisher
- Struct cpp2c_Subscriber
- Struct iox_chunk_header_t
- Struct iox_client_options_t
- Struct iox_client_storage_t
- Struct iox_listener_storage_t
- Struct iox_pub_options_t
- Struct iox_pub_storage_t
- Struct iox_server_options_t
- Struct iox_server_storage_t
- Struct iox_service_description_t
- Struct iox_service_discovery_storage_t
- Struct iox_sub_options_t
- Struct iox_sub_storage_t
- Struct iox_user_trigger_storage_t
- Struct iox_ws_storage_t
- Class cpp2c_WaitSet
- Enum iox_AllocationResult
- Enum iox_ChunkReceiveResult
- Enum iox_ClientEvent
- Enum iox_ClientSendResult
- Enum iox_ClientState
- Enum iox_ConnectionState
- Enum iox_ConsumerTooSlowPolicy
- Enum iox_ListenerResult
- Enum iox_LogLevel
- Enum iox_MessagingPattern
- Enum iox_QueueFullPolicy
- Enum iox_ServerEvent
- Enum iox_ServerRequestResult
- Enum iox_ServerSendResult
- Enum iox_ServerState
- Enum iox_ServiceDiscoveryEvent
- Enum iox_SubscriberEvent
- Enum iox_SubscriberState
- Enum iox_SubscribeState
- Enum iox_WaitSetResult

File Hierarchy

- Directory include
  - Directory iceoryx_binding_c
    - Directory internal
      - File c2cpp_binding.h
      - File c2cpp_enum_translation.hpp
      - File cpp2c_enum_translation.hpp
      - File cpp2c_publisher.hpp
      - File cpp2c_service_description_translation.hpp
      - File cpp2c_subscriber.hpp
      - File cpp2c_waitset.hpp
    - File api.h
    - File chunk.h
    - File client.h
    - File config.h
    - File enums.h
    - File listener.h
    - File log.h
    - File node.h
    - File notification_info.h
    - File publisher.h
    - File request_header.h
    - File response_header.h
    - File runtime.h
    - File server.h
    - File service_description.h
    - File service_discovery.h
    - File subscriber.h
    - File types.h
    - File user_trigger.h
    - File wait_set.h

Full C++ API

Namespaces

Namespace c2cpp

Namespace cpp2c

Namespace iox

Namespace iox::popo

Classes and Structs

Struct cpp2c_Publisher

Struct cpp2c_Subscriber

Struct iox_chunk_header_t

Struct iox_client_options_t

Struct iox_client_storage_t

Struct iox_listener_storage_t

Struct iox_pub_options_t

Struct iox_pub_storage_t

Struct iox_server_options_t

Struct iox_server_storage_t

Struct iox_service_description_t

Struct iox_service_discovery_storage_t

Struct iox_sub_options_t

Struct iox_sub_storage_t

Struct iox_user_trigger_storage_t

Struct iox_ws_storage_t

Class cpp2c_WaitSet

Functions

Function c2cpp::clientEvent

Function c2cpp::clientState

Function c2cpp::consumerTooSlowPolicy

Function c2cpp::messagingPattern

Function c2cpp::queueFullPolicy

Function c2cpp::serverEvent

Function c2cpp::serverState

Function c2cpp::serviceDiscoveryEvent

Function c2cpp::subscriberEvent

Function c2cpp::subscriberState

Function cpp2c::allocationResult

Function cpp2c::chunkReceiveResult

Function cpp2c::clientEvent

Function cpp2c::clientSendResult

Function cpp2c::clientState

Function cpp2c::connectionState

Function cpp2c::consumerTooSlowPolicy

Function cpp2c::listenerResult

Function cpp2c::queueFullPolicy

Function cpp2c::serverEvent

Function cpp2c::serverRequestResult

Function cpp2c::serverSendResult

Function cpp2c::serverState

Function cpp2c::subscriberTooSlowPolicy

Function cpp2c::subscribeState

Function cpp2c::waitSetResult

Function iox_cfg_chunk_default_user_payload_alignment

Function iox_cfg_max_chunks_allocated_per_publisher_simultaneously

Function iox_cfg_max_chunks_held_per_subscriber_simultaneously

Function iox_cfg_max_findservice_result_size

Function iox_cfg_max_number_of_attachments_per_waitset

Function iox_cfg_max_number_of_condition_variables

Function iox_cfg_max_number_of_events_per_listener

Function iox_cfg_max_number_of_memory_blocks_per_memory_provider

Function iox_cfg_max_number_of_memory_provider

Function iox_cfg_max_number_of_mempools

Function iox_cfg_max_number_of_notifiers_per_condition_variable

Function iox_cfg_max_process_number

Function iox_cfg_max_publisher_history

Function iox_cfg_max_publishers

Function iox_cfg_max_runtime_name_length

Function iox_cfg_max_shm_segments

Function iox_cfg_max_subscriber_queue_capacity

Function iox_cfg_max_subscribers

Function iox_cfg_max_subscribers_per_publisher

Function iox_cfg_no_user_header_alignment

Function iox_cfg_no_user_header_size

Function iox_cfg_service_registry_capacity

Function iox_chunk_header_from_user_payload

Function iox_chunk_header_from_user_payload_const

Function iox_chunk_header_to_user_header

Function iox_chunk_header_to_user_header_const

Function iox_chunk_header_to_user_payload

Function iox_chunk_header_to_user_payload_const

Function iox_client_connect

Function iox_client_deinit

Function iox_client_disconnect

Function iox_client_get_connection_state

Function iox_client_get_service_description

Function iox_client_has_missed_responses

Function iox_client_has_responses

Function iox_client_init

Function iox_client_loan_aligned_request

Function iox_client_loan_request

Function iox_client_options_init

Function iox_client_options_is_initialized

Function iox_client_release_queued_responses

Function iox_client_release_request

Function iox_client_release_response

Function iox_client_send

Function iox_client_take_response

Function iox_listener_attach_client_event

Function iox_listener_attach_client_event_with_context_data

Function iox_listener_attach_server_event

Function iox_listener_attach_server_event_with_context_data

Function iox_listener_attach_service_discovery_event

Function iox_listener_attach_service_discovery_event_with_context_data

Function iox_listener_attach_subscriber_event

Function iox_listener_attach_subscriber_event_with_context_data

Function iox_listener_attach_user_trigger_event

Function iox_listener_attach_user_trigger_event_with_context_data

Function iox_listener_capacity

Function iox_listener_deinit

Function iox_listener_detach_client_event

Function iox_listener_detach_server_event

Function iox_listener_detach_service_discovery_event

Function iox_listener_detach_subscriber_event

Function iox_listener_detach_user_trigger_event

Function iox_listener_init

Function iox_listener_size

Function iox_node_create

Function iox_node_destroy

Function iox_node_get_name

Function iox_node_get_runtime_name

Function iox_notification_info_call

Function iox_notification_info_does_originate_from_client

Function iox_notification_info_does_originate_from_server

Function iox_notification_info_does_originate_from_service_discovery

Function iox_notification_info_does_originate_from_subscriber

Function iox_notification_info_does_originate_from_user_trigger

Function iox_notification_info_get_client_origin

Function iox_notification_info_get_notification_id

Function iox_notification_info_get_server_origin

Function iox_notification_info_get_service_discovery_origin

Function iox_notification_info_get_subscriber_origin

Function iox_notification_info_get_user_trigger_origin

Function iox_pub_deinit

Function iox_pub_get_service_description

Function iox_pub_has_subscribers

Function iox_pub_init

Function iox_pub_is_offered

Function iox_pub_loan_aligned_chunk

Function iox_pub_loan_aligned_chunk_with_user_header

Function iox_pub_loan_chunk

Function iox_pub_offer

Function iox_pub_options_init

Function iox_pub_options_is_initialized

Function iox_pub_publish_chunk

Function iox_pub_release_chunk

Function iox_pub_stop_offer

Function iox_request_header_from_payload

Function iox_request_header_from_payload_const

Function iox_request_header_get_chunk_header

Function iox_request_header_get_chunk_header_const

Function iox_request_header_get_rpc_header_version

Function iox_request_header_get_rpc_header_version_const

Function iox_request_header_get_sequence_id

Function iox_request_header_get_sequence_id_const

Function iox_request_header_get_user_payload

Function iox_request_header_get_user_payload_const

Function iox_request_header_set_sequence_id

Function iox_response_header_from_payload

Function iox_response_header_from_payload_const

Function iox_response_header_get_chunk_header

Function iox_response_header_get_chunk_header_const

Function iox_response_header_get_rpc_header_version

Function iox_response_header_get_rpc_header_version_const

Function iox_response_header_get_sequence_id

Function iox_response_header_get_sequence_id_const

Function iox_response_header_get_user_payload

Function iox_response_header_get_user_payload_const

Function iox_response_header_has_server_error

Function iox_response_header_has_server_error_const

Function iox_response_header_set_server_error

Function iox_runtime_get_instance_name

Function iox_runtime_init

Function iox_runtime_shutdown

Function iox_server_deinit

Function iox_server_get_service_description

Function iox_server_has_clients

Function iox_server_has_missed_requests

Function iox_server_has_requests

Function iox_server_init

Function iox_server_is_offered

Function iox_server_loan_aligned_response

Function iox_server_loan_response

Function iox_server_offer

Function iox_server_options_init

Function iox_server_options_is_initialized

Function iox_server_release_queued_requests

Function iox_server_release_request

Function iox_server_release_response

Function iox_server_send

Function iox_server_stop_offer

Function iox_server_take_request

Function iox_service_discovery_deinit

Function iox_service_discovery_find_service

Function iox_service_discovery_find_service_apply_callable

Function iox_service_discovery_find_service_apply_callable_with_context_data

Function iox_service_discovery_init

Function iox_set_loglevel

Function iox_sub_deinit

Function iox_sub_get_service_description

Function iox_sub_get_subscription_state

Function iox_sub_has_chunks

Function iox_sub_has_lost_chunks

Function iox_sub_init

Function iox_sub_options_init

Function iox_sub_options_is_initialized

Function iox_sub_release_chunk

Function iox_sub_release_queued_chunks

Function iox_sub_subscribe

Function iox_sub_take_chunk

Function iox_sub_unsubscribe

Function iox_user_trigger_deinit

Function iox_user_trigger_has_triggered

Function iox_user_trigger_init

Function iox_user_trigger_trigger

Function iox_ws_attach_client_event

Function iox_ws_attach_client_event_with_context_data

Function iox_ws_attach_client_state

Function iox_ws_attach_client_state_with_context_data

Function iox_ws_attach_server_event

Function iox_ws_attach_server_event_with_context_data

Function iox_ws_attach_server_state

Function iox_ws_attach_server_state_with_context_data

Function iox_ws_attach_service_discovery_event

Function iox_ws_attach_service_discovery_event_with_context_data

Function iox_ws_attach_subscriber_event

Function iox_ws_attach_subscriber_event_with_context_data

Function iox_ws_attach_subscriber_state

Function iox_ws_attach_subscriber_state_with_context_data

Function iox_ws_attach_user_trigger_event

Function iox_ws_attach_user_trigger_event_with_context_data

Function iox_ws_capacity

Function iox_ws_deinit

Function iox_ws_detach_client_event

Function iox_ws_detach_client_state

Function iox_ws_detach_server_event

Function iox_ws_detach_server_state

Function iox_ws_detach_service_discovery_event

Function iox_ws_detach_subscriber_event

Function iox_ws_detach_subscriber_state

Function iox_ws_detach_user_trigger_event

Function iox_ws_init

Function iox_ws_mark_for_destruction

Function iox_ws_size

Function iox_ws_timed_wait

Function iox_ws_wait

Function TranslateServiceDescription

Defines

Define CLASS

Define ENUM

Define IOX_C_CHUNK_DEFAULT_USER_PAYLOAD_ALIGNMENT

Define IOX_C_CHUNK_NO_USER_HEADER_ALIGNMENT

Define IOX_C_CHUNK_NO_USER_HEADER_SIZE

Define IOX_CONFIG_NODE_NAME_SIZE

Define IOX_CONFIG_SERVICE_STRING_SIZE

Typedefs

Typedef iox_client_t

Typedef iox_const_request_header_t

Typedef iox_const_response_header_t

Typedef iox_listener_t

Typedef iox_node_t

Typedef iox_notification_info_t

Typedef iox_pub_t

Typedef iox_request_header_t

Typedef iox_response_header_t

Typedef iox_server_t

Typedef iox_service_discovery_t

Typedef iox_sub_t

Typedef iox_user_trigger_t

Typedef iox_ws_t

Directories

Directory include

Directory iceoryx_binding_c

Directory internal