:orphan:

.. index:: pair: struct; rgt_gen_ctx
.. _doxid-structrgt__gen__ctx:

struct rgt_gen_ctx
==================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Structure that keeps generic data used in processing raw log file. :ref:`More...<details-structrgt__gen__ctx>`


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

	#include <rgt_common.h>
	
	struct rgt_gen_ctx {
		// fields
	
		char* :ref:`rawlog_fname<doxid-structrgt__gen__ctx_1af51db3914418a36699abf49c4ecc71bb>`;
		FILE* :ref:`rawlog_fd<doxid-structrgt__gen__ctx_1ad3c04369630be0577050dbd67280b3dc>`;
		off_t :ref:`rawlog_size<doxid-structrgt__gen__ctx_1a4a8b08b7fadc4b78faf0c0774765c0d7>`;
		off_t :ref:`rawlog_fpos<doxid-structrgt__gen__ctx_1a7c8c9e89164554a4839a03484fc9cc3d>`;
		char* :ref:`out_fname<doxid-structrgt__gen__ctx_1a7e13e6091f1e397435f0e3e1f3f2ba65>`;
		FILE* :ref:`out_fd<doxid-structrgt__gen__ctx_1af64fe33cb6855ed5c5422f903f1da7f8>`;
		const char* :ref:`fltr_fname<doxid-structrgt__gen__ctx_1af7728eafc05e64750ae9decd74841bb0>`;
		char* :ref:`tmp_dir<doxid-structrgt__gen__ctx_1aa91d2b1702d0ae25b1fc417854c58c3a>`;
		:ref:`rgt_op_mode_t<doxid-rgt__common_8h_1aaaa719a390e6043ec739eec548055e26>` :ref:`op_mode<doxid-structrgt__gen__ctx_1a712bb3f097ad3c25d1c17d5616631d5b>`;
		const char* :ref:`op_mode_str<doxid-structrgt__gen__ctx_1a105041b805e55cd19d8612c5ea27080f>`;
		:ref:`rgt_io_mode_t<doxid-io_8h_1a3f33be20fd6f5cd68f01c489c620f8bf>` :ref:`io_mode<doxid-structrgt__gen__ctx_1ae93b1f35f68e7151e21eaec6b3e9b922>`;
		:ref:`f_fetch_log_msg<doxid-rgt__common_8h_1a0a27a6c2814d6c7940c2caf810fccc88>` :ref:`fetch_log_msg<doxid-structrgt__gen__ctx_1a07b50b0afdb40ad989be7d7a02aa1d65>`;
		bool :ref:`proc_cntrl_msg<doxid-structrgt__gen__ctx_1a41c01e8aea4867777fba61f5126d7660>`;
		bool :ref:`mi_meta<doxid-structrgt__gen__ctx_1a3b10f786c52a70051a3ffe3991853a81>`;
		bool :ref:`proc_incomplete<doxid-structrgt__gen__ctx_1a4c2fd940f2d2062d2d46e7121ee477e0>`;
		bool :ref:`verb<doxid-structrgt__gen__ctx_1aa8d60db7684f4827db8bf09171d03f87>`;
		int :ref:`current_nest_lvl<doxid-structrgt__gen__ctx_1a45a782ce6e6bffe2dba93a084104c473>`;
		char* :ref:`xml_fname<doxid-structrgt__gen__ctx_1a21d60aabdba42bc5e5ab9846fbf46971>`;
		bool :ref:`expand_entities<doxid-structrgt__gen__ctx_1a0330a291d3f2bc1cd4f525ac68fa014d>`;
		uint32_t :ref:`depth<doxid-structrgt__gen__ctx_1a578e0a9ec90da8e519f58588fa5d805e>`;
		GArray* :ref:`depth_info<doxid-structrgt__gen__ctx_1a3d48428edb49686e9ddb786d777950da>`;
		:ref:`rgt_state_t<doxid-xml2gen_8h_1a803e0e46be92d480d2281a6d97bc89d4>` :ref:`state<doxid-structrgt__gen__ctx_1a2257124285dd4f66d35d482c8bc966ad>`;
		:ref:`rgt_mem_ctx_t<doxid-xml2gen_8h_1adaff5d893ae117117e0dbbf6a0ddb837>` :ref:`mem_ctx<doxid-structrgt__gen__ctx_1a4bcadeb4cc58392787f0cbe069e5eee1>`;
		void* :ref:`user_data<doxid-structrgt__gen__ctx_1af28b5494ff8c10083bc42fa8309a0bdc>`;
	};
.. _details-structrgt__gen__ctx:

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

Structure that keeps generic data used in processing raw log file.

Structure that keeps basic data used in processing XML file.

Fields
------

.. index:: pair: variable; rawlog_fname
.. _doxid-structrgt__gen__ctx_1af51db3914418a36699abf49c4ecc71bb:

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

	char* rawlog_fname

Raw log file name

.. index:: pair: variable; rawlog_fd
.. _doxid-structrgt__gen__ctx_1ad3c04369630be0577050dbd67280b3dc:

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

	FILE* rawlog_fd

Raw log file pointer

.. index:: pair: variable; rawlog_size
.. _doxid-structrgt__gen__ctx_1a4a8b08b7fadc4b78faf0c0774765c0d7:

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

	off_t rawlog_size

Size of Raw log file, has sense only in postponed mode

.. index:: pair: variable; rawlog_fpos
.. _doxid-structrgt__gen__ctx_1a7c8c9e89164554a4839a03484fc9cc3d:

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

	off_t rawlog_fpos

Position in raw log file on reading the current message

.. index:: pair: variable; out_fname
.. _doxid-structrgt__gen__ctx_1a7e13e6091f1e397435f0e3e1f3f2ba65:

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

	char* out_fname

Output file name

.. index:: pair: variable; out_fd
.. _doxid-structrgt__gen__ctx_1af64fe33cb6855ed5c5422f903f1da7f8:

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

	FILE* out_fd

Output file pointer

.. index:: pair: variable; fltr_fname
.. _doxid-structrgt__gen__ctx_1af7728eafc05e64750ae9decd74841bb0:

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

	const char* fltr_fname

XML filter file name

.. index:: pair: variable; tmp_dir
.. _doxid-structrgt__gen__ctx_1aa91d2b1702d0ae25b1fc417854c58c3a:

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

	char* tmp_dir

Temporary directory used for offloading of message pointers into files

.. index:: pair: variable; op_mode
.. _doxid-structrgt__gen__ctx_1a712bb3f097ad3c25d1c17d5616631d5b:

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

	:ref:`rgt_op_mode_t<doxid-rgt__common_8h_1aaaa719a390e6043ec739eec548055e26>` op_mode

Rgt operation mode

.. index:: pair: variable; op_mode_str
.. _doxid-structrgt__gen__ctx_1a105041b805e55cd19d8612c5ea27080f:

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

	const char* op_mode_str

Rgt operation mode in string representation

.. index:: pair: variable; io_mode
.. _doxid-structrgt__gen__ctx_1ae93b1f35f68e7151e21eaec6b3e9b922:

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

	:ref:`rgt_io_mode_t<doxid-io_8h_1a3f33be20fd6f5cd68f01c489c620f8bf>` io_mode

Operation mode (live or postponed) influences on desirable read behaviour that can be blocking or nonblocking. This field keeps current rgt reading mode.

.. index:: pair: variable; fetch_log_msg
.. _doxid-structrgt__gen__ctx_1a07b50b0afdb40ad989be7d7a02aa1d65:

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

	:ref:`f_fetch_log_msg<doxid-rgt__common_8h_1a0a27a6c2814d6c7940c2caf810fccc88>` fetch_log_msg

Pointer to a function that should be used for extracting of log messages from a raw log file. This field is set to an appropriate function according to RLF version determined from the first byte of the RLF.

.. index:: pair: variable; proc_cntrl_msg
.. _doxid-structrgt__gen__ctx_1a41c01e8aea4867777fba61f5126d7660:

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

	bool proc_cntrl_msg

Whether Rgt should process control messages or not

.. index:: pair: variable; mi_meta
.. _doxid-structrgt__gen__ctx_1a3b10f786c52a70051a3ffe3991853a81:

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

	bool mi_meta

Include MI artifacts in <meta> section

.. index:: pair: variable; proc_incomplete
.. _doxid-structrgt__gen__ctx_1a4c2fd940f2d2062d2d46e7121ee477e0:

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

	bool proc_incomplete

Whether Rgt should process incomplete log reports as normal or give error message

.. index:: pair: variable; verb
.. _doxid-structrgt__gen__ctx_1aa8d60db7684f4827db8bf09171d03f87:

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

	bool verb

Whether to use verbose output or not

.. index:: pair: variable; current_nest_lvl
.. _doxid-structrgt__gen__ctx_1a45a782ce6e6bffe2dba93a084104c473:

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

	int current_nest_lvl

Current nesting level

.. index:: pair: variable; xml_fname
.. _doxid-structrgt__gen__ctx_1a21d60aabdba42bc5e5ab9846fbf46971:

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

	char* xml_fname

XML file name

.. index:: pair: variable; expand_entities
.. _doxid-structrgt__gen__ctx_1a0330a291d3f2bc1cd4f525ac68fa014d:

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

	bool expand_entities

Whether to expand standard XML entities like < and > or not?

.. index:: pair: variable; depth
.. _doxid-structrgt__gen__ctx_1a578e0a9ec90da8e519f58588fa5d805e:

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

	uint32_t depth

The current processing depth in the node tree

.. index:: pair: variable; depth_info
.. _doxid-structrgt__gen__ctx_1a3d48428edb49686e9ddb786d777950da:

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

	GArray* depth_info

Array of information about the particular depth

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

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

	:ref:`rgt_state_t<doxid-xml2gen_8h_1a803e0e46be92d480d2281a6d97bc89d4>` state

Current processing state

.. index:: pair: variable; mem_ctx
.. _doxid-structrgt__gen__ctx_1a4bcadeb4cc58392787f0cbe069e5eee1:

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

	:ref:`rgt_mem_ctx_t<doxid-xml2gen_8h_1adaff5d893ae117117e0dbbf6a0ddb837>` mem_ctx

Memory element processing context. Make sense only in STATE_MEM\_...

.. index:: pair: variable; user_data
.. _doxid-structrgt__gen__ctx_1af28b5494ff8c10083bc42fa8309a0bdc:

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

	void* user_data

User-specific data pointer