класс <SI-Namespace>::skeleton::<SI>Skeleton

Метод OfferService() вызывается на экземпляре скелетон-класса, чтобы предложить предоставленный сервис в системе и сделать его доступным для обнаружения потребителями через Service Discovery [SWS_CM_00101], ARAComAPI §6.5 «Service Discovery». Вызов выполняется без параметров и синхронно, как только реализация сервиса полностью инстанцирована и приведена в рабочее состояние AUTOSAR_AP_EXP_ARAComAPI §5.4.4 «Offering Service instance». Функция объявлена как noexcept и возвращает ara::core::Result<void> [SWS_CM_00101].

Предложение является обязательным условием для функциональной коммуникации через методы, события, поля или триггеры AUTOSAR_AP_EXP_ARAComAPI §4.2 «Means of Communication». Если, например, попытаться отправить триггер без предварительного предложения, это завершится ошибкой с ComErrc::kServiceNotOffered [SWS_CM_00721]. В отношении параллелизма действует следующее: как только вызывается OfferService(), входящие вызовы методов уже могут доставляться экземпляру сервиса — даже если вызов OfferService() еще не завершился AUTOSAR_AP_EXP_ARAComAPI §5.4.4 «Offering Service instance».

Если предложение завершается неудачно, возвращаемый ara::core::Result содержит соответствующий код ошибки из ComErrc [SWS_CM_00101], [SWS_CM_10432]:

• ComErrc::kFieldValueNotInitialized: по меньшей мере одно сконфигурированное значение поля еще не было инициализировано до предложения [SWS_CM_00101].
• ComErrc::kFieldSetHandlerNotSet: для поля с поддержкой сеттера еще не был зарегистрирован обработчик через RegisterSetHandler() [SWS_CM_00101].
• ComErrc::kCommunicationFailure: сетевая привязка сообщает об устранимой ошибке коммуникации или о сбое защищенной коммуникации [SWS_CM_00101].

Если предоставление сервиса требуется прекратить, необходимо вызвать StopOfferService() AUTOSAR_AP_EXP_ARAComAPI §5.4.4 «Offering Service instance».

Метод ProcessNextMethodCall() служит поставщикам сервисов в скелетоне для детерминированной обработки входящих вызовов методов в режиме поллинга [SWS_CM_00199]. Его разрешается использовать исключительно в том случае, если экземпляр скелетона был сконфигурирован с режимом ara::com::MethodCallProcessingMode::kPoll EXP ARAComAPI §2 «Polling».

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

Функция не принимает параметров и выполняет ожидающий запрос вызова метода синхронно в контексте потока вызывающей стороны [SWS_CM_00199], [SWS_CM_00191]. Это позволяет, в частности, приложениям реального времени обрабатывать запросы сервисов без неконтролируемых переключений контекста потока в пределах выделенного им бюджета времени EXP ARAComAPI §5.4 «ProcessNextMethodCall». Возвращаемое значение сигнализирует о результате выборки:

• true: по меньшей мере один ожидающий запрос находился в очереди и был обработан [SWS_CM_00199].
• false: ожидающих запросов не было; очередь была пуста [SWS_CM_00199]. Прямой последующий вызов после false, как правило, не дает эффекта EXP ARAComAPI §5.4 «ProcessNextMethodCall».

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

Функция специфицирована как noexcept и exception safe [SWS_CM_00199]. Вызов на скелетоне, который был инстанцирован с kEvent или kEventSingleThread, представляет собой нарушение (WrongMethodCallProcessingModeViolation) [SWS_CM_00199]. Интерпретация: поскольку стандартные исключения C++ исключены благодаря noexcept, такое нарушение, вероятно, должно обрабатываться со стороны платформы как критическая ошибка времени выполнения. Вопрос Q-61661dbd6cc37bc7 (открытый)

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

Функция SetTransportFaultConditionHandler служит для регистрации обратного вызова типа ara::com::e2e::TransportFaultConditionHandler в пространстве имен класса Skeleton (<SI-Namespace>::skeleton::<SI>) [SWS_CM_00093]. Через этот обработчик сообщается о транспортных ошибках для всех методов соответствующего экземпляра сервиса AUTOSAR_AP_SWS_CommunicationManagement §7.4.1 «End-to-end communication protection for SOMEIP». Функция принимает вызываемый объект handler и не имеет возвращаемого значения (void) [SWS_CM_00093].

Обработка ошибок

Операция объявлена с noexcept и является исключениебезопасной (exception safe) [SWS_CM_00093]. Если переданная вызываемая сущность не существует или равна null, генерируется InvalidHandlerViolation [SWS_CM_00093]. В случае ошибки настроенный обработчик сообщает о возникших транспортных сбоях, таких как TransportFaultCondition::kSampleRejected, когда запросы отбрасываются из-за нехватки ресурсов или повреждения на транспортном уровне AUTOSAR_AP_SWS_CommunicationManagement §7.4.2.3 «Methods».

Параллелизм и ограничения

Интерпретация: поскольку данный базовый интерфейс не принимает контекст выполнения, обратный вызов, скорее всего, вызывается синхронно из внутреннего потока Communication Management. Вопрос Q-e4007fa72de6aa12 (открытый) Если требуется выполнение обработчика в определенном пуле потоков или воркере, следует использовать перегрузку с ExecutorT&& executor [SWS_CM_00094].

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

Регистрация централизованно привязывает обработку ошибок ко всем методам экземпляра Skeleton [SWS_CM_00093]. Она интегрируется в вышестоящую обработку ошибок ara::com:

• В то время как методы Skeleton сообщают о транспортных ошибках через этот обработчик, методы клиента асинхронно сигнализируют о транспортных сбоях через свой результирующий ara::core::Future с ComErrc::kCommunicationFailure [SWS_CM_00090].
• Для операций с полями (Get/Set) на уровне Skeleton существуют отдельные интерфейсы [SWS_CM_00096].
• На уровне Proxy предусмотрены аналогичные функции регистрации для событий [SWS_CM_00099], триггеров [SWS_CM_00106], а также нотификаторов [SWS_CM_00109].

Шаблонная функция SetTransportFaultConditionHandler в пространстве имен класса скелетона служит для регистрации обработчика ошибок для транспортных ошибок всех методов экземпляра сервиса [SWS_CM_00094]. Она расширяет базовую функцию без параметров [SWS_CM_00093] контекстом выполнения:

• Вызов и параметры: передаются вызываемый объект handler типа ara::com::e2e::TransportFaultConditionHandler, а также универсальная ссылка executor [SWS_CM_00094]. В этом объекте-экзекуторе должны запускаться любые асинхронные вычисления и выполнения колбэков. Функция не имеет возвращаемого значения.
• Обработка ошибок: интерфейс объявлен как noexcept и специфицирован как безопасный по отношению к исключениям [SWS_CM_00094]. Если переданный вызываемый объект не существует или равен null, возникает InvalidHandlerViolation [SWS_CM_00094].
• Взаимодействие: область действия охватывает все методы скелетона [SWS_CM_00094], в то время как для операций Get и Set полей предоставляются отдельные функции регистрации ([SWS_CM_00096], [SWS_CM_00097]). В сетевом биндинге DDS сконфигурированный обработчик сообщает о транспортных ошибках, таких как TransportFaultCondition::kSampleRejected [SWS_CM_00216]; на стороне клиента такие ошибки, напротив, сигнализируются через ComErrc::kCommunicationFailure в будущих результатах (futures) [SWS_CM_00090].
• Параллелизм: интерпретация: передача экзекутора отделяет обработку ошибок от внутреннего контекста коммуникационного уровня; вероятно, регистрацию следует выполнять заблаговременно при инициализации скелетона до поступления первых вызовов методов. Вопрос Q-e56b2a1928cf32ad (открытый)

Конструктор [SWS_CM_00130] создает экземпляр скелетона сервиса на основе конкретного ara::com::InstanceIdentifier. Скелетон привязывает реализацию сервиса со стороны приложения к транспортному уровню Communication Management, чтобы распределенные потребители сервиса могли получить к нему доступ (ARAComAPI §5.1 «Proxy Skeleton Pattern»).

Через параметр mode определяется то, как обрабатываются входящие вызовы методов. В качестве значения по умолчанию задан событийно-ориентированный режим ara::com::MethodCallProcessingMode::kEvent [SWS_CM_00130]. Если вместо этого выбирается режим на основе опроса (polling), выполнение ожидающих вызовов методов происходит синхронно в контексте вызова ProcessNextMethodCall() [SWS_CM_00199].

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

Функция конструктора объявлена с noexcept и не генерирует исключений C++ [SWS_CM_00130]. Возможные нарушения сигнализируются через систему времени выполнения: если создание отклоняется механизмом grant enforcement, возникает InsufficientPermissionsViolation; при передаче недопустимого режима обработки результатом является WrongMethodCallProcessingModeViolation [SWS_CM_00130]. Интерпретация: валидация режима обработки, по-видимому, происходит непосредственно во время выполнения конструктора. Вопрос Q-80e02c0079757082 (открытый)

Операции копирования для скелетона явно удалены [SWS_CM_00134], тогда как перемещающее конструирование поддерживается [SWS_CM_00135]. Чтобы сервис стал доступен для обнаружения в сети, после инстанцирования необходимо вызвать OfferService() [SWS_CM_00101] (ARAComAPI §6.5 «Service Discovery»). Перед уничтожением экземпляра [SWS_CM_11370] предоставление сервиса может быть снова прекращено с помощью StopOfferService() [SWS_CM_00111].

Конструктор создает экземпляр сервисного скелетона на основе идентификатора экземпляра [SWS_CM_00152]. Он служит для подключения конкретной реализации сервиса к транспортному уровню Communication Management. В качестве параметров передаются ara::core::InstanceSpecifier, а также опционально режим обработки ara::com::MethodCallProcessingMode, значением по умолчанию которого является kEvent [SWS_CM_00152].

Относительно обработки ошибок и поведения при исключениях конструктор объявлен как noexcept и exception safe [SWS_CM_00152]. При некорректных конфигурациях или отклонениях в моделировании специфицированы следующие нарушения (violations):

• InstanceSpecifierMappingIntegrityViolation, если идентификатор не может быть разрешен в контексте выполнения или не указывает на PortPrototype [SWS_CM_00152].
• PortInterfaceMappingViolation и ProcessMappingViolation, если тип сопоставления и тип интерфейса не совпадают [SWS_CM_00152].
• InstanceSpecifierAlreadyInUseViolation, если InstanceSpecifier уже используется [SWS_CM_00152].
• WrongMethodCallProcessingModeViolation, а также InsufficientPermissionsViolation при недостаточных правах [SWS_CM_00152].

Интерпретация: поскольку конструктор объявлен как noexcept, специфицированные нарушения, вероятно, распространяются во время выполнения не как сгенерированные исключения C++, а перехватываются платформенными проверками или принудительным применением прав (grant enforcement). Вопрос Q-f1a1a0baeb56e482 (открытый)

Для жизненного цикла и параллелизма действует правило: конструктор копирования удален [SWS_CM_00134], в то время как доступен конструктор перемещения [SWS_CM_00135]. Освобождение осуществляется через виртуальный деструктор [SWS_CM_11370]. После успешного конструирования сервис обычно предлагается в сети через [SWS_CM_00101] (OfferService). Если в качестве режима обработки был выбран kPoll, приложение должно явно обрабатывать входящие вызовы методов сервиса [SWS_CM_00191] через [SWS_CM_00199] (ProcessNextMethodCall).

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

Конструктор инстанцирует скелет сервиса на основе контейнера идентификаторов экземпляров (instanceIDs) и связывает реализацию сервиса на стороне сервера с транспортным уровнем Communication Management [SWS_CM_00153], ARAComAPI §5.1 «Proxy Skeleton Pattern». Через параметр mode определяется способ обработки входящих вызовов методов; по умолчанию обработка осуществляется по событиям через kEvent [SWS_CM_00153]. В качестве альтернативы доступны конструкторы для отдельных идентификаторов экземпляров [SWS_CM_00130] или спецификаторов экземпляров [SWS_CM_00152].

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

Функция объявлена как noexcept и специфицирована как безопасная относительно исключений (exception safe) [SWS_CM_00153]. Возможными нарушениями при создании являются WrongMethodCallProcessingModeViolation при передаче недопустимого режима обработки, а также InsufficientPermissionsViolation в случае сбоя проверки полномочий (Grant Enforcement) [SWS_CM_00153].

Если для mode сконфигурирована модель опроса (kPoll), серверное приложение должно синхронно обрабатывать ожидающие вызовы методов в контексте собственного потока посредством вызова ProcessNextMethodCall() [SWS_CM_00199]. Конструктор копирования класса скелета удален (delete) [SWS_CM_00134]; перемещение, напротив, поддерживается через конструктор перемещения [SWS_CM_00135].

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

После успешного инстанцирования сервис предоставляется для удаленных или локальных потребителей через OfferService() [SWS_CM_00101], ARAComAPI §6.5 «Service Discovery». Перед уничтожением скелета с помощью деструктора [SWS_CM_11370] предоставление сервиса следует прекратить через StopOfferService() [SWS_CM_00111]. Входящие вызовы методов возвращают на стороне сервера ara::core::Future [SWS_CM_00191].

Виртуальный деструктор ~<SI>Skeleton() [SWS_CM_11370] завершает жизненный цикл экземпляра скелетона сервиса. Сервисный скелетон как сгенерированный артефакт соединяет конкретную реализацию сервиса с транспортным уровнем Communication Management, благодаря чему потребители сервиса могут обращаться к предоставляемым методам и функциональности (ARAComAPI §5.1 «Proxy Skeleton Pattern»).

Уничтожение происходит синхронно при удалении производного класса реализации. Метод не принимает параметров и не объявляет возвращаемого значения. В отличие от конструкторов скелетона, таких как [SWS_CM_00130] или [SWS_CM_00152], деструктор в спецификации явно классифицирован как not exception safe [SWS_CM_11370].

Относительно обработки ошибок и граничных условий установлено, что при нарушении предусловия может возникнуть DanglingSamplesViolation [SWS_CM_11370]. Если сервис ранее предоставлялся вовне посредством OfferService() [SWS_CM_00101] (ARAComAPI §6.5 «Service Discovery»), перед вызовом деструктора, вероятно, потребуется вызвать метод StopOfferService() [SWS_CM_00111] для корректного завершения текущих коммуникационных отношений. Вопрос Q-c430a7f0fc838eba (открытый)

Для скелетона конструктор копирования удален [SWS_CM_00134], тогда как операции перемещения поддерживаются [SWS_CM_00135]. Текущие процессы обработки — например, выполнение ожидающих вызовов через ProcessNextMethodCall() [SWS_CM_00199] — должны быть завершены до начала уничтожения.

Метод [SWS_CM_00111] завершает предложение экземпляра сервиса приложением-поставщиком сервиса в ara::com. Вызов выполняется без параметров на конкретном экземпляре скелетона в пространстве имён <SI-Namespace>::skeleton::<SI> и не имеет возвращаемого значения (EXP_ARAComAPI §5.4.1 «Skeleton Class API’s»).

Для использования и поведения во время выполнения действуют следующие условия:

• Контекст вызова и предварительное условие: метод вызывается, когда ранее предоставленный посредством OfferService() экземпляр — например, вследствие изменений состояния — больше не должен быть доступен (EXP_ARAComAPI §5.4.4 «Offering Service instance»).
• Контрактное обязательство (Contract): как только StopOfferService() возвращает управление, согласно контракту дальнейшие вызовы методов больше не пересылаются этому экземпляру сервиса (EXP_ARAComAPI §5.4.4 «Offering Service instance»).
• Жизненный цикл и деструктор: если экземпляр сервиса всё ещё активно предлагается при вызове деструктора класса скелетона, деструктор в обязательном порядке выполняет StopOfferService() внутри себя (EXP_ARAComAPI §5.4.4 «Offering Service instance»).
• Service Discovery: в результате вызова локальный реестр или протокол Service Discovery промежуточного ПО обновляется информацией об отзыве сервиса (EXP_ARAComAPI §7.2.1 «Central vs Distributed approach»).

Функция объявлена как noexcept и считается исключение-безопасной ([SWS_CM_00111]). Она не сигнализирует об ошибках ни через исключения, ни через сообщения об ошибках или коды возврата.