:orphan:

.. index:: pair: struct; ta_reboot_context
.. _doxid-structta__reboot__context:

struct ta_reboot_context
========================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Contextual information for rebooting the agent :ref:`More...<details-structta__reboot__context>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <rcf.h>
	
	struct ta_reboot_context {
		// fields
	
		:ref:`ta_reboot_state<doxid-rcf_8h_1a6fd4bb8367ff06e08e82ab02318526ce>` :ref:`state<doxid-structta__reboot__context_1a6f1396f8b76d7508f423b50e81c34ebc>`;
		int :ref:`requested_types<doxid-structta__reboot__context_1a74b0604ad37ac3099b1d45109aad37a9>`;
		int :ref:`allowed_types<doxid-structta__reboot__context_1a74103b6778ff7ca9f6af3f5f830f415a>`;
		:ref:`ta_reboot_type<doxid-rcf_8h_1a5abc2dbb2dac0a52af58602f825afbd8>` :ref:`current_type<doxid-structta__reboot__context_1acdbe1510a0bbed1173f480f8e23920ce>`;
		time_t :ref:`reboot_timestamp<doxid-structta__reboot__context_1a93b471ecfd7bd0b71c4e6781b8c9cf95>`;
		:ref:`usrreq<doxid-structusrreq>`* :ref:`req<doxid-structta__reboot__context_1a46fb82d0644f4e68f0b16c789d5ad634>`;
		bool :ref:`is_answer_recv<doxid-structta__reboot__context_1a38d4ea5dc16610224269c7244423f77c>`;
		:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`error<doxid-structta__reboot__context_1a1090f21bb5e2bd4aa1a282aeffc64a93>`;
		bool :ref:`is_agent_reboot_msg_sent<doxid-structta__reboot__context_1ad1a30ca564685504a30496a26935f494>`;
		unsigned int :ref:`restart_attempt<doxid-structta__reboot__context_1aac92b27f9de04af5e27bab836177a5b7>`;
		bool :ref:`is_cold_reboot_time_expired<doxid-structta__reboot__context_1acfa3813e8069ec9321c70be466d15bad>`;
	};
.. _details-structta__reboot__context:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

Contextual information for rebooting the agent

Fields
------

.. index:: pair: variable; state
.. _doxid-structta__reboot__context_1a6f1396f8b76d7508f423b50e81c34ebc:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`ta_reboot_state<doxid-rcf_8h_1a6fd4bb8367ff06e08e82ab02318526ce>` state

Current reboot state

.. index:: pair: variable; requested_types
.. _doxid-structta__reboot__context_1a74b0604ad37ac3099b1d45109aad37a9:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	int requested_types

Bitmask of the requested reboot types by the user

.. index:: pair: variable; allowed_types
.. _doxid-structta__reboot__context_1a74103b6778ff7ca9f6af3f5f830f415a:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	int allowed_types

Bitmask of the allowed reboot types by the user

.. index:: pair: variable; current_type
.. _doxid-structta__reboot__context_1acdbe1510a0bbed1173f480f8e23920ce:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`ta_reboot_type<doxid-rcf_8h_1a5abc2dbb2dac0a52af58602f825afbd8>` current_type

Current reboot type. The current reboot type will increase to the requested type according to the Reboot types are enumerated from the lowest one up to *requested_type* until until one of them completes successfully

.. index:: pair: variable; reboot_timestamp
.. _doxid-structta__reboot__context_1a93b471ecfd7bd0b71c4e6781b8c9cf95:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	time_t reboot_timestamp

Timestamp of one reboot state

.. index:: pair: variable; req
.. _doxid-structta__reboot__context_1a46fb82d0644f4e68f0b16c789d5ad634:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`usrreq<doxid-structusrreq>`* req

User request with reboot message

.. index:: pair: variable; is_answer_recv
.. _doxid-structta__reboot__context_1a38d4ea5dc16610224269c7244423f77c:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool is_answer_recv

The flag to check that the response from the agent is received. Use for the reboot context only.

.. index:: pair: variable; error
.. _doxid-structta__reboot__context_1a1090f21bb5e2bd4aa1a282aeffc64a93:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` error

The error that occurred during the reboot

.. index:: pair: variable; is_agent_reboot_msg_sent
.. _doxid-structta__reboot__context_1ad1a30ca564685504a30496a26935f494:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool is_agent_reboot_msg_sent

This field is used to avoid a lot of message "Agent in the reboot state" in the logs

.. index:: pair: variable; restart_attempt
.. _doxid-structta__reboot__context_1aac92b27f9de04af5e27bab836177a5b7:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	unsigned int restart_attempt

Number of agent restart attempts

.. index:: pair: variable; is_cold_reboot_time_expired
.. _doxid-structta__reboot__context_1acfa3813e8069ec9321c70be466d15bad:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool is_cold_reboot_time_expired

The flag to check that timeout for cold reboot is expired