Module port

The ports or communication endpoints of iceoryx2

Modules

client

Sends requests to a Server and receives responses.

event_id

Defines the event id used to identify the source of an event.

listener

Receiving endpoint (port) for event based communication

notifier

Sending endpoint (port) for event based communication

port_identifiers

Defines port specific unique ids. Used to identify source/destination while communicating.

publisher

Sending endpoint (port) for publish-subscribe based communication

server

Receives requests from a Client port and sends back responses.

subscriber

Receiving endpoint (port) for publish-subscribe based communication

unable_to_deliver_strategy

Defines the strategy a sender shall pursue when the buffer of a receiver is full and the service does not overflow.

update_connections

Interface to perform cyclic updates to the ports. Required to deliver history to new participants or to perform other management tasks.

Structs

DegradationCallback

Defines a custom behavior whenever a port detects a degregation.

Enums

DataSegmentType

Defines the data segment type of a zero copy capable sender port.

DegradationAction

Defines the action a port shall take when an internal failure occurs. Can happen when the system is corrupted and files are modified by non-iceoryx2 instances. Is used as return value of the DegradationCallback to define a custom behavior.

LoanError

Defines a failure that can occur in Publisher::loan() and Publisher::loan_uninit() or is part of SendError emitted in Publisher::send_copy().

ReceiveError

Defines the failure that can occur when receiving data with Subscriber::receive().

SendError

Failure that can be emitted when data is sent.