1. Structural View#

1.1. Overview#

The bundle service oriented communication (SOCom) implements components for client/server pattern based communication for the following communication paradigms:

  • remote procedure call

  • publish/subscribe (event communication)

SOCom provides intra-process client/server communication only.

1.2. Rationale Behind Architecture Decomposition#

SOCom separates connection setup and service matching from steady-state message transport:

  • Central matching vs direct data path (Runtime vs connectors): Runtime handles service registration and interface and version compatibility checks (Service_interface_definition) during setup; once connected, Client_connector and Enabled_server_connector invoke each other’s endpoints directly without central broker contention on data-path calls.

  • Compile-time provider state (Disabled_server_connector / Enabled_server_connector): Encoding disabled and enabled server states as distinct move-only C++ types prevents a provider from allocating or publishing events while its service is not offered.

  • Zero-copy buffer ownership (Payload / Writable_payload): Separating the buffer lifetime (including the release callback and optional inline user data) from connector routing allows bridges such as gateway_ipc_binding to pass LoLa shared-memory samples across connectors without copying.

1.3. Static Architecture#

SOCom Static Architecture
status: valid
security: NO
safety: ASIL_B

Fig. 1.1 Component diagram of SOCom#

Software elements

1.4. Interfaces#

1.4.1. Runtime#

The Runtime creates and connects Client_connectors and Server_connectors. It must outlive all created Client_connectors and Server_connectors.

SOCom Runtime Interface
status: valid
security: NO
safety: ASIL_B

In-process service registry and factory interface (score::socom::Runtime) for creating client and server connectors.

make_client_connector
status: valid
security: NO
safety: ASIL_B

Creates and registers a Client_connector for a target service interface and instance.

make_server_connector
status: valid
security: NO
safety: ASIL_B

Creates and registers a Disabled_server_connector for a provided service interface and instance.

1.4.2. Client connector#

A client application owns and uses this component to join client/server pattern based service oriented communication (SOCom). The client connector interacts with the server connector in order perform the supported communication primitives. The client connector API provides the following features:

  • service instance state change indications

  • asynchronous remote procedure call:

    • with method reply

    • without method reply (fire and forget)

  • event subscription:

    • with optional initial value request (required for fields)

  • event payload allocation indication

  • event update indication

  • requested event update indication

SOCom Client Connector Interface
status: valid
security: NO
safety: ASIL_B

Consumer-side connector interface (score::socom::Client_connector) for receiving service state updates, subscribing to events, and invoking methods.

subscribe_event and unsubscribe_event
status: valid
security: NO
safety: ASIL_B

Subscribes to or unsubscribes from service events (with optional initial-value request for fields) and requests on-demand event updates.

call_method and allocate_method_call_payload
status: valid
security: NO
safety: ASIL_B
version: 1

Allocates method-call request buffers and invokes asynchronous RPC methods (with optional reply handling or fire-and-forget).

1.4.3. Server connector#

The Server_connector represents a service, which is used by a Client_connector. It can send event updates and respond to method calls.

SOCom Server Connector Interface
status: valid
security: NO
safety: ASIL_B

Provider-side connector interfaces (score::socom::Disabled_server_connector and score::socom::Enabled_server_connector) for controlling service availability, publishing events, and handling method calls.

enable and disable
status: valid
security: NO
safety: ASIL_B

Transitions a server connector between disabled and enabled states and notifies matching clients of service availability changes.

allocate_event_payload
status: valid
security: NO
safety: ASIL_B

Allocates a writable event buffer from the subscribed client endpoint for zero-copy event transmission.

update_event and update_requested_event
status: valid
security: NO
safety: ASIL_B

Publishes an event payload to the subscribed client or responds to a pending on-demand event update request.

SOCom Payload Interface
status: valid
security: NO
safety: ASIL_B

Move-only message buffer interfaces (score::socom::Payload and score::socom::Writable_payload) providing contiguous byte-span access, RAII memory release, and optional inline user data.

data, wdata, shrink, and get_user_data
status: valid
security: NO
safety: ASIL_B

Provides read-only and writable byte-span access to the contiguous message buffer and payload size adjustment after writing.