класс <SI-Namespace>::skeleton::fields::<Field>

Использование

Метод RegisterGetHandler вызывается на стороне сервера для объекта поля скелетона ([SWS_CM_00114]). Он существует в сгенерированном коде исключительно в том случае, если в описании интерфейса для соответствующего поля был сконфигурирован геттер (Field.hasGetter == TRUE) (EXP ARAComAPI §5.4.8.1 «Registering Getters»). Передаётся обратный вызов handler типа std::function<ara::core::Future<FieldType>()>, который вызывается реализацией связывания при входящем запросе Get() от прокси.

Регистрация такого обработчика полностью опциональна (EXP ARAComAPI §5.4.8.1 «Registering Getters»). Обычно сервисной реализации не требуется обработчик геттера, так как Communication Management кэширует значение, заданное последним через Update(), и самостоятельно отвечает на запросы прокси. Обработчик имеет смысл прежде всего тогда, когда вычисление значения поля требует много времени или вычислительных ресурсов и поэтому должно производиться асинхронно через паттерн Promise/Future только при фактической необходимости.

Обработка ошибок и граничные условия

Функция не имеет возвращаемого значения, объявлена как noexcept и является исключение-безопасной (exception safe) ([SWS_CM_00114]). Если переданный вызываемый объект не существует или равен null, возникает ошибка InvalidHandlerViolation ([SWS_CM_00114]).

Взаимодействие

В отличие от RegisterSetHandler, вызов которого обязателен при наличии сеттера (EXP ARAComAPI §5.4.8.2 «Registering Setters»), RegisterGetHandler остаётся сугубо опциональным. Если обработчик должен обрабатываться асинхронно в определённом контексте выполнения, дополнительно доступна перегруженная шаблонная функция с ExecutorT ([SWS_CM_11360]).

Использование

Метод RegisterGetHandler в пространстве имён <SI-Namespace>::skeleton::fields::<Field> регистрирует обратный вызов на стороне приложения (handler), который вызывается коммуникационной привязкой при входящем вызове Get() от прокси ([SWS_CM_11360], EXP ARAComAPI §5.4.8.1 «Registering Getters»). В отличие от базовой перегрузки без параметров [SWS_CM_00114], метод принимает контекст выполнения executor типа ExecutorT, в котором выполнение обратного вызова происходит асинхронно ([SWS_CM_11360]). В качестве исполнителя может использоваться стандартизированный ara::core::Executor или определяемый пользователем тип с таким же интерфейсом ([SWS_CM_11360]).

Зарегистрированный обработчик возвращает ara::core::Future<FieldType>, благодаря чему вычисление значения поля отвязывается через паттерн Promise/Future ([SWS_CM_11360], EXP ARAComAPI §5.4.8.1 «Registering Getters»). Регистрация является полностью опциональной: если обработчик не зарегистрирован, Communication Management автономно отвечает на запросы последним значением, установленным через Update() (EXP ARAComAPI §5.4.8.1 «Registering Getters»). Обработчик-геттер в первую очередь подходит для вычисления ресурсоёмких или требующих много времени значений полей по требованию (EXP ARAComAPI §5.4.8.1 «Registering Getters»).

Ограничения и обработка ошибок

Метод присутствует в скелетоне исключительно в том случае, если в IDL для поля был сконфигурирован геттер (Field.hasGetter == TRUE, [SWS_CM_00114], EXP ARAComAPI §5.4.8.1 «Registering Getters»). RegisterGetHandler объявлен как noexcept; однако если передаётся недопустимый или пустой вызываемый объект (Callable), возникает InvalidHandlerViolation ([SWS_CM_11360]). Интерпретация: переданный исполнитель (Executor), по всей видимости, должен оставаться действительным на протяжении всего времени использования обработчика, поскольку входящие запросы направляются асинхронно в его контекст. Вопрос Q-c58eb22b06a8c27c (открытый)

Использование

Метод RegisterSetHandler служит на стороне сервера (скелетона) для регистрации функции обратного вызова, которая вызывается при поступлении от клиента запроса Set() для поля [SWS_CM_00116]. Метод существует исключительно тогда, когда предоставляемое поле сконфигурировано с поддержкой сеттера (Field.hasSetter == TRUE) [SWS_CM_00116]. В отличие от регистрации геттера, вызов RegisterSetHandler обязателен, поскольку реализация сервера должна предварительно валидировать новые или обновленные значения полей от анонимных клиентов EXP ARAComAPI §5.4.8.2 «Registering Setters».

Зарегистрированный обработчик получает новое значение в качестве аргумента и возвращает ara::core::Future<FieldType> с эффективным, при необходимости скорректированным значением [SWS_CM_00116], EXP ARAComAPI §5.4.8.2 «Registering Setters». Это эффективное значение неявно принимается системой управления коммуникациями и публикуется клиентам; поэтому явный вызов Update() внутри обработчика является излишним EXP ARAComAPI §5.4.8.2 «Registering Setters».

Обработка ошибок и граничные условия

Функция определена как noexcept и безопасна относительно исключений [SWS_CM_00116]. Если передан несуществующий или недействительный (null) вызываемый объект, имеет место нарушение спецификации в форме InvalidHandlerViolation [SWS_CM_00116]. Интерпретация: регистрация, вероятно, должна выполняться до предоставления сервиса через OfferService(), чтобы иметь возможность принимать входящие запросы клиентов с самого начала. Вопрос Q-d45be0a899ddb6dd (открытый)

Взаимодействие

Наряду с базовым методом существует шаблонная перегрузка [SWS_CM_11362], с помощью которой выполнение обработчика может быть привязано к конкретному контексту выполнения (ExecutorT согласно [SWS_CM_11360]) EXP ARAComAPI.

Шаблонная функция RegisterSetHandler регистрирует на уровне сервера или скелетона (skeleton) поля функцию обратного вызова, которая вызывается, как только клиент передает запрос Set() ([SWS_CM_11362], [SWS_CM_00116]). Интерфейс существует только в том случае, если сконфигурированное поле сервиса предусматривает поддержку сеттера (Field.hasSetter == TRUE) ([SWS_CM_00116]). В отличие от регистрации Get, регистрация обработчика Set является обязательной, поскольку реализация сервера всегда должна валидировать новые значения полей от анонимных клиентов (EXP ARAComAPI §5.4.8.2 «Registering Setters»).

По сравнению со стандартной регистрацией согласно [SWS_CM_00116] эта перегрузка дополнительно принимает контекст выполнения executor типа ExecutorT&& ([SWS_CM_11362], [SWS_CM_11360]). Интерпретация: executor, вероятно, управляет тем, в контексте какого потока или планировщика задач выполняется обратный вызов. Вопрос Q-6dec4c0005c388dd (открытый) Переданный обработчик имеет сигнатуру std::function<ara::core::Future<FieldType>(<SFieldDerivedType> value)>; он принимает установленное клиентом значение и асинхронно возвращает через ara::core::Future фактическое — при необходимости валидированное или скорректированное — значение ([SWS_CM_11362], EXP ARAComAPI §5.4.8.2 «Registering Setters»).

Communication Management неявно принимает возвращенное обработчиком фактическое значение так, как если бы серверное приложение само вызвало Update(); поэтому ручной вызов Update() внутри обработчика является избыточным (EXP ARAComAPI §5.4.8.2 «Registering Setters», EXP ARAComAPI §4.6 «Data Type Abstractions»).

Обработка ошибок и параллелизм:

• Безопасность исключений: функция объявлена как noexcept и специфицирована как исключениебезопасная (exception safe) ([SWS_CM_11362]).
• Нарушения: если переданный вызываемый объект (Callable) setHandler не существует или равен nullptr, возникает нарушение InvalidHandlerViolation ([SWS_CM_11362]).
• Контекст: метод гарантирует, что выполнение обработчика происходит в предоставленном контексте executor ([SWS_CM_11362]).

Функция SetTransportFaultConditionHandler служит для регистрации обработчика ошибок типа ara::com::e2e::TransportFaultConditionHandler для запросов Get и Set поля на уровне скелетона в пространстве имён <SI-Namespace>::skeleton::fields::<Field> [SWS_CM_00096]. Вызов выполняется синхронно, не имеет возвращаемого значения (void) и гарантирует безопасность исключений благодаря спецификации как noexcept [SWS_CM_00096]. Для сценариев, в которых выполнение обработчика должно быть делегировано явному контексту выполнения, доступна шаблонная перегрузка с объектом исполнителя ExecutorT&& executor [SWS_CM_00097].

В качестве условия ошибки определено нарушение InvalidHandlerViolation; оно наступает, если переданный вызываемый объект handler не существует или равен null [SWS_CM_00096]. В то время как на стороне клиента ошибки при запросах методов и полей сообщаются через ComErrc::kCommunicationFailure в соответствующих экземплярах ara::core::Future [SWS_CM_00090], эта функция позволяет экземпляру сервера принимать транспортные ошибки при входящих вызовах Get и Set [SWS_CM_00096].

Концепция корреспондирует с соответствующими механизмами регистрации для всех методов экземпляра сервиса-скелетона [SWS_CM_00093], а также с обработчиками на стороне прокси для событий [SWS_CM_00099], триггеров [SWS_CM_00106] и уведомителей полей [SWS_CM_00109]. Интерпретация: регистрацию обработчика целесообразно выполнять на этапе инициализации до предоставления скелетона, чтобы обеспечить бесшовный перехват ошибок при начальном доступе к полям. Вопрос Q-627229896b666532 (открытый)

Функция SetTransportFaultConditionHandler в пространстве имен <SI-Namespace>::skeleton::fields::<Field> регистрирует обработчик ошибок для транспортных сбоев при запросах Get и Set поля на уровне Skeleton [SWS_CM_00097]. Она подключается через заголовочный файл <SiNamespaceDerivedDirectoryPath>/<SiShortname>_skeleton.h [SWS_CM_00097].

Использование и параметры

Вызов происходит синхронно и не имеет возвращаемого значения (void) [SWS_CM_00097]. В качестве параметров передаются вызываемый обратный вызов ошибки handler типа ara::com::e2e::TransportFaultConditionHandler, а также универсальная ссылка executor универсального типа ExecutorT&& [SWS_CM_00097]. Параметр executor обозначает объект выполнения, в контексте которого выполняются возможные асинхронные вычисления [SWS_CM_00097].

Обработка ошибок и параллелизм

Метод объявлен как noexcept и гарантирует полную безопасность исключений (exception safe) [SWS_CM_00097]. Если переданный handler-callable не существует или равен null, генерируется InvalidHandlerViolation [SWS_CM_00097]. Интерпретация: через переданный executor-объект, предположительно, определяется, в контексте какого потока или задачи обрабатывается асинхронное уведомление при транспортных ошибках. Вопрос Q-4101faaa8d6a3130 (открытый)

Взаимодействие

Метод расширяет стандартную регистрацию [SWS_CM_00096] выделенным контекстом выполнения для полей Skeleton [SWS_CM_00097]. Соответствующие перегрузки с Executor существуют также для методов Skeleton ([SWS_CM_00094]), а также на стороне клиента/Proxy для событий ([SWS_CM_00100]) и нотификаторов полей ([SWS_CM_00110]).

Функция UnsetTransportFaultConditionHandler служит на стороне скелетона сервисного интерфейса для отмены ранее зарегистрированного ara::com::e2e::TransportFaultConditionHandler для Get- и Set-запросов поля ([SWS_CM_00098]). Она определена в пространстве имен <SI-Namespace>::skeleton::fields::<Field> и подключена через заголовочный файл <SiNamespaceDerivedDirectoryPath>/<SiShortname>_skeleton.h (AUTOSAR_AP_SWS_CommunicationManagement §8.4.3.2.1.3 «UnsetTransportFaultConditionHandler»). Вызов выполняется синхронно, не принимает входных параметров и не возвращает значения (void).

В результате отмены деактивируется специфический для приложения обратный вызов для состояний транспортных ошибок при запросах поля (AUTOSAR_AP_SWS_CommunicationManagement §7.4.1 «End-to-end communication protection for SOMEIP»). Интерфейс объявлен как noexcept и гарантирует безопасность исключений (exception safe) ([SWS_CM_00098]). Коды ошибок или специфические сообщения об ошибках через DET или DEM не специфицированы; процесс спроектирован так, чтобы завершаться безошибочно.

Относительно параллелизма и реентерабельности спецификация не содержит отдельных требований. Следовательно, отмену регистрации предпочтительно выполнять на этапах деинициализации или вне параллельной обработки Get/Set во избежание несогласованности при текущих процессах коммуникации. Вопрос Q-06bc8d90f1891904 (открытый)

Данная операция является частью защиты сквозной (End-to-End) коммуникации для экземпляров сервисов (AUTOSAR_AP_SWS_CommunicationManagement §7.4.1 «End-to-end communication protection for SOMEIP»). Она представляет собой относящийся к полям аналог [SWS_CM_00095], который отменяет регистрацию обработчика для всех методов скелетона. На стороне прокси она корреспондирует с соответствующими отменами регистрации для событий ([SWS_CM_00105]), триггеров ([SWS_CM_00108]) и нотификаторов полей ([SWS_CM_00126]).

Метод Update() вызывается на стороне сервера в области видимости <SI-Namespace>::skeleton::fields::<Field> для обновления внутреннего значения поля и инициирования передачи новых данных подписанным клиентам ([SWS_CM_00119], AUTOSAR_AP_EXP_ARAComAPI §4.6 «Data Type Abstractions»). Уведомление отправляется подписчикам, если для поля сконфигурировано hasNotifier == TRUE ([SWS_CM_00119], [SWS_CM_00120], [SWS_CM_00162]). Параметр value передаётся по ссылке; реализация связывания создаёт во время вызова типично сериализованную копию, так что данные приложения после возврата управления на стороне вызывающего могут быть изменены или освобождены (AUTOSAR_EXP_ARAComAPI «UpdateRate Class»).

Функция определена как noexcept, а также exception safe и синхронно возвращает ara::core::Result<void> ([SWS_CM_00119]). При возникновении ошибки результат содержит код ошибки из ara::com::ComErrc ([SWS_CM_00119], [SWS_CM_10432]). В частности, ComErrc::kMinimumSendIntervalViolationError с семантикой отката возвращается в том случае, если запросы на отправку поступают чаще, чем задано сконфигурированным минимальным интервалом отправки ServiceInterfaceDeploymentElement.minimumSendInterval ([SWS_CM_00119]).

В жизненном цикле сервиса требуется начальный вызов Update() перед предложением сервиса: если OfferService() вызывается до инициализации значения поля, предоставление завершается сбоем с ComErrc::kFieldValueNotInitialized ([SWS_CM_00101], [SWS_CM_00128]). Из-за отсутствия в стандарте явной гарантии реентерабельности одновременные вызовы для одного и того же экземпляра поля, вероятно, должны синхронизироваться на стороне приложения. Вопрос Q-67b174ef05867989 (открытый)