класс ara::log::Logger

Функция-член LogDebug класса ara::log::Logger служит для создания сообщений журнала с уровнем важности Debug и возвращает для этого соответствующим образом настроенный объект LogStream [SWS_LOG_00068]. Объявление выполняется через заголовочный файл #include "ara/log/logger.h" [SWS_LOG_00068].

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

• Вызов и возвращаемое значение: метод не принимает входных параметров и напрямую возвращает объект LogStream с уровнем важности Debug [SWS_LOG_00068]. Принцип работы при этом соответствует методу Logger::LogFatal() [SWS_LOG_00068].
• Обработка ошибок: сигнатура объявлена как noexcept и специфицирована как безопасная относительно исключений (exception safe) [SWS_LOG_00068]. В случае ошибки сообщения об ошибках или коды ошибок не выдаются [SWS_LOG_00068].
• Параллелизм: функция-член классифицирована как константная (const), а также явно как потокобезопасная (thread-safe) [SWS_LOG_00068], поэтому параллельный доступ на чтение через один и тот же экземпляр логгера допустим.

Метод LogError класса ara::log::Logger служит для инициации записи журнала с уровнем важности Error [SWS_LOG_00065]. Функция объявляется через заголовочный файл ara/log/logger.h и не принимает параметров [SWS_LOG_00065].

Использование и возвращаемое значение

Синхронный вызов возвращает объект типа LogStream с уровнем важности Error [SWS_LOG_00065]. При этом поведение функционально соответствует поведению Logger::LogFatal() [SWS_LOG_00065]. Поскольку LogError объявлен как const, вызов не изменяет состояние объекта логгера и может выполняться также на константных экземплярах [SWS_LOG_00065].

Параллелизм и безопасность исключений

Для контекста вызова действуют установленные гарантии [SWS_LOG_00065]:

• Потокобезопасность: функция специфицирована как thread-safe [SWS_LOG_00065]. Интерпретация: таким образом, вызовы предположительно могут выполняться параллельно из нескольких потоков на одном и том же экземпляре без внешней синхронизации. Вопрос Q-e55d2b523c5cbcb3 (открытый)
• Безопасность исключений: метод объявлен как noexcept, а также как exception safe [SWS_LOG_00065]; во время выполнения он не выбрасывает исключений.

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

Специфические коды ошибок или уведомления в DET или DEM для LogError не предусмотрены [SWS_LOG_00065]. Состояния ошибок при вызове исключены благодаря гарантированной безопасности исключений и интерфейсу без параметров [SWS_LOG_00065].

Использование и время жизни

Метод LogFatal класса ara::log::Logger (предоставляемый через заголовочный файл ara/log/logger.h) создает объект LogStream с уровнем серьезности Fatal ([SWS_LOG_00064]). Функция не принимает аргументов и возвращает поток напрямую. Возвращенный объект LogStream последовательно принимает сообщения журнала и параметры через потоковый оператор << ([SWS_LOG_00064]). В штатном сценарии применения время жизни созданного потока ограничено одной инструкцией и завершается точкой с запятой после последнего переданного параметра ([SWS_LOG_00064]). Чтобы продлить время жизни объекта потока сверх этого, его можно присвоить именованной переменной ([SWS_LOG_00064]).

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

Функция объявлена как noexcept и специфицирована как исключениебезопасная (exception safe) ([SWS_LOG_00064]). Во время выполнения она не выбрасывает исключений и не использует специфических кодов ошибок. В отношении параллелизма метод специфицирован как const, а также как полностью потокобезопасный (thread-safe), благодаря чему допустимы параллельные вызовы через один и тот же экземпляр логгера ([SWS_LOG_00064]).

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

По интерфейсу и поведению метод соответствует родственным методам журналирования для других уровней серьезности внутри ara::log::Logger: LogError ([SWS_LOG_00065]), LogWarn ([SWS_LOG_00066]), LogInfo ([SWS_LOG_00067]), LogDebug ([SWS_LOG_00068]), а также LogVerbose ([SWS_LOG_00069]).

Функция-член LogInfo класса ara::log::Logger ([SWS_LOG_00067]) объявляется через заголовочный файл ara/log/logger.h. Она служит для создания сообщения журнала с уровнем важности Info, не требует входных параметров и синхронно возвращает объект типа LogStream ([SWS_LOG_00067]). Поведение согласно спецификации соответствует поведению Logger::LogFatal() ([SWS_LOG_00067]), при этом интерпретация состоит в том, что функциональность работает аналогично и лишь уровень важности зафиксирован как Info.

Касательно параллелизма и контекста вызова метод объявлен как const и явно специфицирован как потокобезопасный (thread-safe) ([SWS_LOG_00067]). Благодаря этому LogInfo разрешается вызывать параллельно из нескольких потоков на одном и том же экземпляре логгера в любое время, без необходимости использования механизмов синхронизации или блокировок со стороны приложения.

В плане обработки ошибок функция снабжена обозначением noexcept и классифицирована как безопасная относительно исключений (exception safe) ([SWS_LOG_00067]). Не возвращается никаких специфических кодов ошибок, а также не генерируются сообщения об ошибках DEM или DET ([SWS_LOG_00067]); ситуация ошибки для этого вызова не определена.

В структуре требований интерфейс напрямую сопоставлен с вышестоящими требованиями [RS_LT_00003] и [RS_LT_00049] ([SWS_LOG_00067]), которые определяют общие руководящие принципы для подсистемы логирования и трассировки.

Метод LogVerbose() класса ara::log::Logger из заголовочного файла #include "ara/log/logger.h" служит для создания вывода журнала с наиболее подробным уровнем важности Verbose [SWS_LOG_00069]. При вызове параметры не передаются. Функция синхронно возвращает объект LogStream, который явно инициализирован уровнем важности Verbose и используется для передачи содержимого сообщений [SWS_LOG_00069].

Спецификация указывает поведение как идентичное Logger::LogFatal() [SWS_LOG_00069]; в качестве интерпретации это, вероятно, означает, что буферизация и предоставление потока следуют общему механизму логирования и отличаются лишь назначенным уровнем важности. Вопрос Q-522523e7a845dc3a (открытый) Для обработки ошибок метод специфицирован как noexcept, а также exception safe [SWS_LOG_00069]. Следовательно, исключения не возникают, а специфические коды ошибок в контексте вызова отсутствуют [SWS_LOG_00069].

В отношении параллелизма и контрактов интерфейса действуют следующие свойства:

• Потокобезопасность: метод классифицирован как thread-safe, благодаря чему конкурирующие вызовы через один и тот же или различные экземпляры логгера могут безопасно выполняться [SWS_LOG_00069].
• Константность: объявление как const гарантирует, что вызов не изменяет внутреннее состояние объекта логгера [SWS_LOG_00069].

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

Функция-член LogWarn класса ara::log::Logger предоставляется через заголовочный файл ara/log/logger.h [SWS_LOG_00066]. Вызов выполняется без параметров на экземпляре логгера через сигнатуру LogStream LogWarn () const noexcept; [SWS_LOG_00066]. В качестве возвращаемого значения функция синхронно возвращает объект типа LogStream с классификацией важности Warn (Warn severity) [SWS_LOG_00066]. Функциональное поведение при этом соответствует описанию Logger::LogFatal() [SWS_LOG_00066]. Интерпретация: возвращаемый объект LogStream, вероятно, служит для составления сообщений журнала уровня предупреждения для последующего вывода. Вопрос Q-02b18df759926020 (открытый)

Параллелизм и безопасность ошибок

Что касается контекста вызова и параллелизма, метод специфицирован как thread-safe [SWS_LOG_00066]. Таким образом, его можно безопасно вызывать из нескольких параллельных потоков на одном и том же экземпляре. Функция гарантирует полную безопасность исключений (exception safe) и объявлена с noexcept [SWS_LOG_00066]. Специфические коды ошибок, значения ошибок или сигналы обратной связи для ошибок времени выполнения для этой операции не определены [SWS_LOG_00066]; интерпретация: сбой возврата значения при штатной работе, вероятно, исключен. Вопрос Q-44b264cd97ff8159 (открытый)

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

Шаблонный метод LogWith класса ara::log::Logger служит для структурированного журналирования сообщений на основе идентификатора, а также связанных атрибутов и аргументов [SWS_LOG_00133]. Он подключается через заголовочный файл #include "ara/log/logger.h" и выполняется синхронно без возвращаемого значения [SWS_LOG_00133].

Функция принимает следующие параметры [SWS_LOG_00133]:

• attrs: std::tuple с атрибутами сообщения (типы Attrs...),
• msgId: определяемый реализацией экземпляр типа MsgId для идентификации объекта сообщения,
• params: вариативные аргументы (типы Params...), добавляемые к записи журнала.

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

Функция специфицирована как thread-safe и может выполняться конкурентно [SWS_LOG_00133]. Она объявлена с noexcept и классифицирована как исключениебезопасная (exception safe), поэтому исключения C++ не генерируются [SWS_LOG_00133]. Специфические коды ошибок или сообщения об ошибках не определены.

Для инстанцирования шаблона действует следующее: функция не участвует в разрешении перегрузки, если хотя бы один из типов в Attrs... не представляет собой допустимый атрибут сообщения [SWS_LOG_00133]. Интерпретация: поскольку требование к типу Attr в спецификации помечено как TBD, конкретная проверка типов, по всей видимости, зависит от конкретной реализации платформы. Вопрос Q-30f5de483410d716 (открытый)