-
-
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. SPDX-License-Identifier: CC-BY-4.0
.. CAUTION: this document is generated from source in doc/src/rtd.
.. To make changes edit the source and recompile the document.
.. Do NOT make changes directly to .rst or .md files.
-
============================================================================================
Man Page: rmr_set_vlevel
============================================================================================
-RMR Library Functions
-============================================================================================
-
-
-NAME
---------------------------------------------------------------------------------------------
+
+
+RMR LIBRARY FUNCTIONS
+=====================
+
+
+
+NAME
+----
+
rmr_set_vlevel
-
-SYNOPSIS
---------------------------------------------------------------------------------------------
-
+
+
+SYNOPSIS
+--------
+
::
-
+
#include <rmr/rmr.h>
#include <rmr/rmr_logging.h>
+
void rmr_set_vlevel( int new_level )
-
-
-DESCRIPTION
---------------------------------------------------------------------------------------------
-
-The rmr_set_vlevel allows the user programme to set the
+
+
+DESCRIPTION
+-----------
+
+The ``rmr_set_vlevel`` allows the user programme to set the
verbosity level which is used to determine the messages RMR
-writes to standard error. The new_vlevel value must be one of
-the following constants which have the indicated meanings:
-
-
-RMR_VL_OFF
-
- Turns off all message writing. This includes the stats and
- debugging messages generated by the route collector thread
- which are normally affected only by the externally managed
- verbose level file (and related environment variable).
-
-
-RMR_VL_CRIT
-
- Write only messages of critical importance. From the point
- of view of RMR, when a critical proper behaviour of the
- library cannot be expected or guaranteed.
-
-RMR_VL_ERR
-
- Include error messages in the output. An error is an event
- from which RMR has no means to recover. Continued proper
- execution is likely except where the affected connection
- and/or component mentioned in the error is concerned.
-
-RMR_VL_WARN
-
- Include warning messages in the output. A warning
- indicates an event which is not considered to be normal,
- but is expected and continued acceptable behaviour of the
- system is assured.
-
-RMR_VL_INFO
-
- Include informational messagees in the output.
- Informational messages include some diagnostic information
- which explain the activities of RMR.
-
-RMR_VL_DEBUG
-
- Include all debugging messages in the output. Debugging
- must have also been enabled during the build as a
- precaution to accidentally enabling this level of output
- as it can grossly affect performance.
+writes to standard error. The ``new_vlevel`` value must be
+one of the following constants which have the indicated
+meanings:
+
+ .. list-table::
+ :widths: auto
+ :header-rows: 0
+ :class: borderless
+
+ * - **RMR_VL_OFF**
+ -
+ Turns off all message writing. This includes the stats and
+ debugging messages generated by the route collector thread
+ which are normally affected only by the externally managed
+ verbose level file (and related environment variable).
+
+ * - **RMR_VL_CRIT**
+ -
+ Write only messages of critical importance. From the point of
+ view of RMR, when a critical proper behaviour of the library
+ cannot be expected or guaranteed.
+
+ * - **RMR_VL_ERR**
+ -
+ Include error messages in the output. An error is an event
+ from which RMR has no means to recover. Continued proper
+ execution is likely except where the affected connection
+ and/or component mentioned in the error is concerned.
+
+ * - **RMR_VL_WARN**
+ -
+ Include warning messages in the output. A warning indicates
+ an event which is not considered to be normal, but is
+ expected and continued acceptable behaviour of the system is
+ assured.
+
+ * - **RMR_VL_INFO**
+ -
+ Include informational messagees in the output. Informational
+ messages include some diagnostic information which explain
+ the activities of RMR.
+
+ * - **RMR_VL_DEBUG**
+ -
+ Include all debugging messages in the output. Debugging must
+ have also been enabled during the build as a precaution to
+ accidentally enabling this level of output as it can grossly
+ affect performance.
+
Generally RMR does not write messages to the standard error
function must be used. The default value, if this function is
never called, and the environment variable is not present, is
RMR_VL_ERR.
-
-SEE ALSO
---------------------------------------------------------------------------------------------
-
+
+
+SEE ALSO
+--------
+
rmr_init(3)
Code Review / ric-plt / lib / rmr.git / blobdiff