Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/features/baselibs/docs/architecture/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Static Architecture
:safety: ASIL_B
:status: valid
:fulfils: feat_req__baselibs__core_utilities
:includes: logic_arc_int__baselibs__json, logic_arc_int__baselibs__memory_shared, logic_arc_int__baselibs__message_passing, logic_arc_int__baselibs__result, logic_arc_int__baselibs__bit_manipulation, logic_arc_int__baselibs__bit_mask_operator, logic_arc_int__baselibs__dynamic_array, logic_arc_int__baselibs__intrusive_list, logic_arc_int__baselibs__filesystem, logic_arc_int__baselibs__utils_base64, logic_arc_int__baselibs__utils_scoped_op
:includes: logic_arc_int__baselibs__json, logic_arc_int__baselibs__memory_shared, logic_arc_int__baselibs__message_passing, logic_arc_int__baselibs__result, logic_arc_int__baselibs__bit_manipulation, logic_arc_int__baselibs__bit_mask_operator, logic_arc_int__baselibs__dynamic_array, logic_arc_int__baselibs__intrusive_list, logic_arc_int__baselibs__filesystem, logic_arc_int__baselibs__utils_base64, logic_arc_int__baselibs__utils_scoped_op, logic_arc_int__baselibs__promise, logic_arc_int__baselibs__future, logic_arc_int__baselibs__shared_future, logic_arc_int__baselibs__executor, logic_arc_int__baselibs__task, logic_arc_int__baselibs__task_result, logic_arc_int__baselibs__synchronized_queue, logic_arc_int__baselibs__condition_variable

.. needarch::
:scale: 50
Expand All @@ -107,4 +107,4 @@ The Baselibs feature exposes the following logical interfaces:
:style: table
:columns: title;id;status
:sort: title
:filter: id in ['logic_arc_int__baselibs__json', 'logic_arc_int__baselibs__memory_shared', 'logic_arc_int__baselibs__message_passing' ,'logic_arc_int__baselibs__result', 'logic_arc_int__baselibs__bit_manipulation', 'logic_arc_int__baselibs__bit_mask_operator', 'logic_arc_int__baselibs__dynamic_array', 'logic_arc_int__baselibs__intrusive_list', 'logic_arc_int__baselibs__filesystem', 'logic_arc_int__baselibs__utils_base64', 'logic_arc_int__baselibs__utils_scoped_op']
:filter: id in ['logic_arc_int__baselibs__json', 'logic_arc_int__baselibs__memory_shared', 'logic_arc_int__baselibs__message_passing' ,'logic_arc_int__baselibs__result', 'logic_arc_int__baselibs__bit_manipulation', 'logic_arc_int__baselibs__bit_mask_operator', 'logic_arc_int__baselibs__dynamic_array', 'logic_arc_int__baselibs__intrusive_list', 'logic_arc_int__baselibs__filesystem', 'logic_arc_int__baselibs__utils_base64', 'logic_arc_int__baselibs__utils_scoped_op', 'logic_arc_int__baselibs__promise', 'logic_arc_int__baselibs__future', 'logic_arc_int__baselibs__shared_future', 'logic_arc_int__baselibs__executor', 'logic_arc_int__baselibs__task', 'logic_arc_int__baselibs__task_result', 'logic_arc_int__baselibs__synchronized_queue', 'logic_arc_int__baselibs__condition_variable']
313 changes: 313 additions & 0 deletions docs/modules/baselibs/concurrency/docs/architecture/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,313 @@
..
# *******************************************************************************
# Copyright (c) 2026 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
#
# This program and the accompanying materials are made available under the
# terms of the Apache License Version 2.0 which is available at
# https://www.apache.org/licenses/LICENSE-2.0
#
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

Concurrency Component Architecture
***********************************

.. document:: Concurrency Architecture
:id: doc__concurrency_architecture
:status: valid
:safety: ASIL_B
:security: YES
:realizes: wp__component_arch

Overview/Description
--------------------

see :need:`doc__concurrency`

Static Architecture
-------------------

.. comp_arc_sta:: Concurrency
:id: comp_arc_sta__baselibs__concurrency
:security: YES
:safety: ASIL_B
:status: valid
:tags: baselibs_concurrency
:implements: logic_arc_int__baselibs__promise, logic_arc_int__baselibs__future, logic_arc_int__baselibs__shared_future, logic_arc_int__baselibs__executor, logic_arc_int__baselibs__task, logic_arc_int__baselibs__task_result, logic_arc_int__baselibs__synchronized_queue, logic_arc_int__baselibs__condition_variable

.. needarch::
:scale: 50
:align: center

{{ draw_component(need(), needs) }}

Interfaces
----------

.. logic_arc_int:: Promise
:id: logic_arc_int__baselibs__promise
:security: YES
:safety: ASIL_B
:status: valid

.. logic_arc_int_op:: Set Value
:id: logic_arc_int_op__conc__promise_setval
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__promise

.. logic_arc_int_op:: Set Error
:id: logic_arc_int_op__conc__promise_set_error
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__promise

.. logic_arc_int_op:: Get Future
:id: logic_arc_int_op__conc__promise_get_future
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__promise

.. logic_arc_int_op:: On Abort
:id: logic_arc_int_op__conc__promise_on_abort
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__promise

.. logic_arc_int:: Future
:id: logic_arc_int__baselibs__future
:security: YES
:safety: ASIL_B
:status: valid

.. logic_arc_int_op:: Get
:id: logic_arc_int_op__conc__future_get
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__future

.. logic_arc_int_op:: Wait
:id: logic_arc_int_op__conc__future_wait
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__future

.. logic_arc_int_op:: Wait For
:id: logic_arc_int_op__conc__future_wait_for
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__future

.. logic_arc_int_op:: Wait Until
:id: logic_arc_int_op__conc__future_wait_until
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__future

.. logic_arc_int_op:: Valid
:id: logic_arc_int_op__conc__future_valid
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__future

.. logic_arc_int_op:: Share
:id: logic_arc_int_op__conc__future_share
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__future

.. logic_arc_int_op:: Then
:id: logic_arc_int_op__conc__future_then
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__future

.. logic_arc_int:: Shared Future
:id: logic_arc_int__baselibs__shared_future
:security: YES
:safety: ASIL_B
:status: valid

.. logic_arc_int_op:: Get Shared
:id: logic_arc_int_op__conc__shared_future_get
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__shared_future

.. logic_arc_int_op:: Copy
:id: logic_arc_int_op__conc__shared_future_copy
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__shared_future

.. logic_arc_int:: Executor
:id: logic_arc_int__baselibs__executor
:security: YES
:safety: ASIL_B
:status: valid

.. logic_arc_int_op:: Enqueue
:id: logic_arc_int_op__conc__executor_enqueue
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__executor

.. logic_arc_int_op:: Post
:id: logic_arc_int_op__conc__executor_post
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__executor

.. logic_arc_int_op:: Submit
:id: logic_arc_int_op__conc__executor_submit
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__executor

.. logic_arc_int_op:: Shutdown
:id: logic_arc_int_op__conc__executor_shutdown
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__executor

.. logic_arc_int_op:: Max Concurrency Level
:id: logic_arc_int_op__conc__executor_max_conc
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__executor

.. logic_arc_int:: Task
:id: logic_arc_int__baselibs__task
:security: YES
:safety: ASIL_B
:status: valid

.. logic_arc_int_op:: Execute
:id: logic_arc_int_op__conc__task_execute
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__task

.. logic_arc_int_op:: Get Stop Source
:id: logic_arc_int_op__conc__task_get_stop_source
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__task

.. logic_arc_int:: Task Result
:id: logic_arc_int__baselibs__task_result
:security: YES
:safety: ASIL_B
:status: valid

.. logic_arc_int_op:: Abort
:id: logic_arc_int_op__conc__task_result_abort
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__task_result

.. logic_arc_int_op:: Aborted
:id: logic_arc_int_op__conc__task_result_aborted
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__task_result

.. logic_arc_int_op:: Get Result
:id: logic_arc_int_op__conc__task_result_get
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__task_result

.. logic_arc_int:: Synchronized Queue
:id: logic_arc_int__baselibs__synchronized_queue
:security: YES
:safety: ASIL_B
:status: valid

.. logic_arc_int_op:: Push
:id: logic_arc_int_op__conc__sync_queue_push
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__synchronized_queue

.. logic_arc_int_op:: Pop
:id: logic_arc_int_op__conc__sync_queue_pop
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__synchronized_queue

.. logic_arc_int_op:: Try Push
:id: logic_arc_int_op__conc__sync_queue_try_push
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__synchronized_queue

.. logic_arc_int_op:: Try Pop
:id: logic_arc_int_op__conc__sync_queue_try_pop
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__synchronized_queue

.. logic_arc_int:: Condition Variable
:id: logic_arc_int__baselibs__condition_variable
:security: YES
:safety: ASIL_B
:status: valid

.. logic_arc_int_op:: Wait
:id: logic_arc_int_op__conc__cv_wait
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__condition_variable

.. logic_arc_int_op:: Wait For
:id: logic_arc_int_op__conc__cv_wait_for
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__condition_variable

.. logic_arc_int_op:: Notify One
:id: logic_arc_int_op__conc__cv_notify_one
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__condition_variable

.. logic_arc_int_op:: Notify All
:id: logic_arc_int_op__conc__cv_notify_all
:security: YES
:safety: ASIL_B
:status: valid
:included_by: logic_arc_int__baselibs__condition_variable
4 changes: 3 additions & 1 deletion docs/modules/baselibs/concurrency/docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
..
# *******************************************************************************
# Copyright (c) 2025 Contributors to the Eclipse Foundation
# Copyright (c) 2026 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
Expand All @@ -26,6 +26,8 @@ concurrency
.. toctree::
:hidden:

architecture/index.rst

Abstract
========

Expand Down
4 changes: 2 additions & 2 deletions docs/modules/baselibs/docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
..
# *******************************************************************************
# Copyright (c) 2025 Contributors to the Eclipse Foundation
# Copyright (c) 2026 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
Expand All @@ -14,7 +14,7 @@

.. mod_view_sta:: Baselibs
:id: mod_view_sta__baselibs__baselibs
:includes: comp_arc_sta__baselibs__json, comp_arc_sta__baselibs__message_passing, comp_arc_sta__baselibs__memory_shared, comp_arc_sta__baselibs__result, comp_arc_sta__baselibs__bit_manipulation, comp_arc_sta__baselibs__containers, comp_arc_sta__baselibs__filesystem, comp_arc_sta__baselibs__utils
:includes: comp_arc_sta__baselibs__json, comp_arc_sta__baselibs__message_passing, comp_arc_sta__baselibs__memory_shared, comp_arc_sta__baselibs__result, comp_arc_sta__baselibs__bit_manipulation, comp_arc_sta__baselibs__containers, comp_arc_sta__baselibs__filesystem, comp_arc_sta__baselibs__utils, comp_arc_sta__baselibs__concurrency

.. needarch::
:scale: 50
Expand Down