Class template basic_event_composer . Boost , Chapter 1. Boost.Log v2 , Sinks

Class template basic_event_composer

boost::log::sinks::event_log::basic_event_composer — An event composer.

Synopsis

// In header: <boost/log/sinks/event_log_backend.hpp>
template<typename CharT> 
class basic_event_composer {
public:
  // types
  typedef CharT                          char_type;             // Character type. 
  typedef std::basic_string< char_type > string_type;           // String type to be used as a message text holder. 
  typedef unspecified                    event_id_mapper_type;  // Event identifier mapper type. 
  typedef basic_formatter< char_type >   formatter_type;        // Type of an insertion composer (a formatter) 
  typedef std::vector< string_type >     insertion_list;        // Type of the composed insertions list. 
  // construct/copy/destruct
  explicit basic_event_composer(event_id_mapper_type const &);
  basic_event_composer(basic_event_composer const &);
  basic_event_composer & operator=(basic_event_composer);
  ~basic_event_composer();
  // public member functions
  void swap(basic_event_composer &);
  event_map_reference operator[](event_id);
  event_map_reference operator[](int);
  event_id operator()(record_view const &, insertion_list &) const;
};

Description

Этот класс является функциональным объектом, который извлекает идентификатор события из набора значений атрибутов и форматирует строки вставки для конкретного события. Каждая строка вставки отформатирована с помощью отдельного форматтера, который может быть создан так же, как обычные формататоры раковин.

Перед использованием композитор должен быть инициализирован со следующей информацией:

Логика извлечения идентификатора события. Можно использовать классы<basic_direct_event_id_mapping>или<basic_custom_event_id_mapping>, чтобы создать такой экстрактор и передать его композитору-конструктору.
Идентификаторы событий и форматеры строк вставки. Композитор предоставляет следующий синтаксис для предоставления этой информации:

event_composer comp;
comp[MY_EVENT_ID1] % formatter1 % ... % formatterN;
comp[MY_EVENT_ID2] % formatter1 % ... % formatterN;
...

Идентификаторы событий в квадратных скобках предоставляются сгенерированным заголовком компилятора сообщений (фактические имена указаны в файле .mc). Форматтеры представляют собой строки вставки, которые будут использоваться для замены заполнителей в сообщениях о событиях, поэтому число и порядок форматтеров должны соответствовать определению сообщения.

`basic_event_composer` public construct/copy/destruct

explicitbasic_event_composer(event_id_mapper_typeconst&id_mapper);

Конструктор по умолчанию. Создает пустую карту событий.

Параметры:

<id_mapper>

Функция отображения идентификатора события, которая будет использоваться для извлечения идентификатора события из значений атрибутов

<
```
basic_event_composer(basic_event_composerconst&that);
```
>
Копировать конструктор. Выполняет глубокую копию объекта.
<
```
basic_event_composer&operator=(basic_event_composerthat);
```
>
Назначение. Обеспечивает сильную гарантию исключения.
<
```
~basic_event_composer();
```
>
Разрушитель

`basic_event_composer` public member functions

<
```
voidswap(basic_event_composer&that);
```
>
Свопы<*this>и<that>объекты.
<
```
event_map_referenceoperator[](event_idid);
```
>
Инициирует создание нового описания события. Результат оператора можно использовать для добавления формататоров для построения вставных строк. Возвращенный эталонный тип - это деталь реализации.
Параметры:
<id>
Идентификатор событий.

event_map_referenceoperator[](intid);

Инициирует создание нового описания события. Результат оператора можно использовать для добавления формататоров для построения вставных строк. Возвращенный эталонный тип - это деталь реализации.

Class template basic_event_composer

Boost , Chapter 1. Boost.Log v2 , Sinks

Boost C++ Libraries

Class template basic_event_composer

Synopsis

Description

basic_event_composer public construct/copy/destruct

basic_event_composer public member functions

`basic_event_composer` public construct/copy/destruct

`basic_event_composer` public member functions