Класс so_4::sop::send_msg_info_t

Граф наследования:so_4::sop::send_msg_info_t:

so_4::sop::req_info_t Полный список членов класса

Подробное описание

Класс запроса на отправку сообщения.


Открытые типы

typedef std::list< field_tfield_list_t
 Тип списка полей сообщения.

Открытые члены

 send_msg_info_t ()
 Конструктор по умолчанию.
 send_msg_info_t (const std::string &agent, const std::string &msg)
 Инициализирующий конструктор.
const std::string & query_agent () const
 Опредение имени агента-владельца сообщения.
const std::string & query_msg () const
 Определение имени сообщения.
const std::string & query_receiver () const
 Определение имени агента-получателя сообщения.
void set_receiver (const std::string &receiver)
 Установить имя агента-получателя сообщения.
unsigned int query_delay () const
 Определить задержку перед отправкой сообщения.
void set_delay (unsigned int delay)
 Установить задержку перед отправкой сообщения.
unsigned int query_period () const
 Определить период повтора переодического сообщения.
void set_period (unsigned int period)
 Установить период повтора переодического сообщения.
const field_list_tquery_field_list () const
 Получить список значений полей сообщения.
void add_field (const std::string &name, int value_type, const std::string &value, unsigned int items_in_value)
 Добавить значение очередного поля.

Закрытые данные

std::string m_agent
 Имя агента-владельца сообщения.
std::string m_msg
 Имя сообщения.
std::string m_receiver
 Имя агента-получателя.
unsigned int m_delay
 Задержка перед отправкой сообщения.
unsigned int m_period
 Период повтора переодического сообщения.
field_list_t m_field_list
 Значения полей сообщения.

Классы

struct  field_t
 Структура для хранения одного поля отправляемого сообщения. Подробнее...


Конструктор(ы)

so_4::sop::send_msg_info_t::send_msg_info_t const std::string &  agent,
const std::string &  msg
 

Инициализирующий конструктор.

Аргументы:
agent  Имя агента-владельца сообщения.
msg  Имя сообщения.


Методы

void so_4::sop::send_msg_info_t::add_field const std::string &  name,
int  value_type,
const std::string &  value,
unsigned int  items_in_value
 

Добавить значение очередного поля.

Аргументы:
name  Имя поля сообщения.
value_type  Тип значения поля.
value  Сериализованное значение поля.
items_in_value  Количество элементов (не байт) в сериализованном значении.

unsigned int so_4::sop::send_msg_info_t::query_delay  )  const
 

Определить задержку перед отправкой сообщения.

Возвращает:
0, если эта величина не была задана.

unsigned int so_4::sop::send_msg_info_t::query_period  )  const
 

Определить период повтора переодического сообщения.

Возвращает:
0, если эта величина не была задана.

const std::string & so_4::sop::send_msg_info_t::query_receiver  )  const
 

Определение имени агента-получателя сообщения.

Возвращает:
Пустую строку, если получатель не был указан.

void so_4::sop::send_msg_info_t::set_delay unsigned int  delay  ) 
 

Установить задержку перед отправкой сообщения.

Аргументы:
delay  Значение в миллисекундах.

void so_4::sop::send_msg_info_t::set_period unsigned int  period  ) 
 

Установить период повтора переодического сообщения.

Аргументы:
period  Значение в миллисекундах.


Данные класса

unsigned int so_4::sop::send_msg_info_t::m_delay [private]
 

Задержка перед отправкой сообщения.

0, если не задана.

unsigned int so_4::sop::send_msg_info_t::m_period [private]
 

Период повтора переодического сообщения.

0, если не задан.

std::string so_4::sop::send_msg_info_t::m_receiver [private]
 

Имя агента-получателя.

Пустая строка, если получатель не задан.


Документация по SObjectizer. Последние изменения: Thu Jan 12 10:52:52 2006. Создано системой  doxygen 1.4.6-NO
Hosted by uCoz