Структура so_4::transport_layer::msg_channel_lost

Полный список членов класса

---

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

Сообщение о закрытии транспортного канала.

Начиная с:

v.4.4.0-b4 Отсылается объектом-channel_controller при обнаружении того, что канал оказался закрытым или разорванным.

Транспортные агенты должны использовать typedef для объявления типа данного сообщения:

 class a_client_channel_t : public so_4::rt::agent_t
   {
   public :
     typedef so_4::transport_layer::msg_channel_lost msg_channel_lost;
     ...
   };

Открытые члены
	msg_channel_lost ()
	msg_channel_lost (const channel_id_t &id, const std::string &reason)
Открытые статические члены
static bool	check (const msg_channel_lost *msg)
static so_4::ret_code_t	send (const std::string &agent_name, const channel_id_t &id, const std::string &reason)
Открытые атрибуты
channel_id_t	m_id
	Идентификатор потерянного канала.
const std::string	m_reason
	Текстовое описание причины закрытия.

---

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

so_4::transport_layer::msg_channel_lost::msg_channel_lost

(

)

Конструктор по-умолчанию обнуляет все поля.

Используется в send().

so_4::transport_layer::msg_channel_lost::msg_channel_lost	(	const channel_id_t &	id,
		const std::string &	reason
	)

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

---

Методы

bool so_4::transport_layer::msg_channel_lost::check

(

const msg_channel_lost *

msg

)

[static]

Объявляет сообщение некорректным, если msg равен 0.

so_4::ret_code_t so_4::transport_layer::msg_channel_lost::send	(	const std::string &	agent_name,
		const channel_id_t &	id,
		const std::string &	reason
	)			[static]

Создает и отсылает экземпляр сообщения целенаправлено указанному агенту. При этом считается, что данный агент так же является и владельцем сообщения.

Аргументы:

agent_name	Получатель и владелец сообщения.
id	Идентификатор потерянного канала.
reason	Описание причины закрытия.

Перекрестные ссылки msg_channel_lost() и so_4::api::send_msg_safely().

Используется в so_4::transport_layer::std_channel_owner_notificator_t::on_lost().

---

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

channel_id_t so_4::transport_layer::msg_channel_lost::m_id

Идентификатор потерянного канала.

Это значение совпадает с идентификатором в сообщении msg_channel_created.

Используется в so_4::transport_layer::std_channel_owner_notificator_t::channel_id(), so_4::transport_layer::std_channel_owner_notificator_factory_t::create(), so_4::rt::comm::a_channel_processor_base_t::evt_channel_lost(), so_4::transport_layer::std_channel_owner_notificator_t::on_lost() и so_4::transport_layer::std_channel_owner_notificator_t::on_success().

const std::string so_4::transport_layer::msg_channel_lost::m_reason

Текстовое описание причины закрытия.

Заметки:

Может оказаться, что не во всех случаях причина неудачи будет известна. Поэтому иногда это поле может быть пустым.