class ara::rds::IEEE1722RawDataStreamConsumer

The template class ara::rds::IEEE1722RawDataStreamConsumer is used for the typed reception of IEEE 1722 streaming datagrams in the AUTOSAR Adaptive Platform. Instances are created via the static method Create() with an InstanceSpecifier [SWS_RDS_90312] and subsequently connected to the data stream via Connect(). Incoming datagrams can be read out up to a specified maximum number via the method ReadData() [SWS_RDS_90321]. Copy operations are excluded, meaning the connection can be transferred exclusively by move operations, the execution of which is not thread-safe.

more ›

Context

The template class ara::rds::IEEE1722RawDataStreamConsumer acts as a typed receiver for IEEE 1722 streaming datagrams within the Raw Data Stream module (rds) of the AUTOSAR Adaptive Platform. The template parameter T specifies the concrete payload data type of the datagrams. The class encapsulates access to the data stream and binds the communication endpoints to the configured communication infrastructure via an identifier of type ara::core::InstanceSpecifier [SWS_RDS_90312]. Applications use this consumer to receive structured AVTP or IEEE 1722 payload streams directly and in a resource-efficient manner.

Lifecycle

Instantiation of a consumer is performed exclusively via the static factory method Create() [SWS_RDS_90312] by specifying the target instance. Direct constructor invocation is not intended for users. The class implements strict move-only semantics: Copying instances is explicitly prohibited, as both the copy constructor [SWS_RDS_90316] and the copy assignment operator [SWS_RDS_90317] are deleted. This ensures that the underlying connection and buffer resources always remain in unambiguous ownership.

To enable ownership transfers between contexts, the class provides a move constructor [SWS_RDS_90314] and a move assignment operator [SWS_RDS_90315]. Both move operations are declared as not thread-safe, which is why concurrent accesses to the same instance must be synchronized. When destroying the instance, the destructor ~IEEE1722RawDataStreamConsumer() automatically closes any connection that may still exist [SWS_RDS_90318]; the destructor is also specified as not thread-safe.

Usage Path

The typical sequence when using a IEEE1722RawDataStreamConsumer comprises four consecutive phases:

1. Creation: The application creates the consumer instance via the factory method Create() with the desired ara::core::InstanceSpecifier [SWS_RDS_90312].
2. Connection establishment: Before receiving payload data, the application connects the consumer to the configured data stream by calling Connect() [SWS_RDS_90319].
3. Data reception: The application calls ReadData() repeatedly or cyclically [SWS_RDS_90321]. Here, the parameter maxNumberOfDatagrams specifies the maximum number of datagrams to be queried in the call. The result is returned as a vector of the template type T.
4. Connection teardown: After data transmission is completed, the application terminates the connection explicitly via Shutdown() [SWS_RDS_90320] or leaves the cleanup to the destructor [SWS_RDS_90318].

Sequence diagram: Typical usage path for creation, connection, cyclic datagram polling, and termination of the consumer. Sources: [SWS_RDS_90312], [SWS_RDS_90319], [SWS_RDS_90321], [SWS_RDS_90320], [SWS_RDS_90318].

Error Scenarios

All regular interface functions of the class—Create() [SWS_RDS_90312], Connect() [SWS_RDS_90319], ReadData() [SWS_RDS_90321], and Shutdown() [SWS_RDS_90320]—are qualified with noexcept and signal error states not via C++ exceptions, but via the return type ara::core::Result. Applications must therefore check whether the respective result contains a value or an error before accessing data values or before subsequent operations.

Possible error constellations include failure of instance creation if the configuration of the InstanceSpecifier is faulty, as well as connection drops or network access errors during Connect() or ReadData(). Interpretation: A call to ReadData() presumably requires that a successful connection establishment via Connect() has been completed beforehand. Question Q-ea5241fe8b3e95a8 (open) Concrete causes of error are presumably conveyed idiomatically as error codes in the returned ara::core::Result.