X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Frmr_set_vlevel.3.rst;h=37bd8fd9d72e45397f7ce6a07614e3eb22ead060;hb=refs%2Ftags%2F4.7.4;hp=ed805618002a51837d7d87f20c88b141bff7bacd;hpb=117030c67f7a3722e64f1ecc3305a5862b3b7ce9;p=ric-plt%2Flib%2Frmr.git diff --git a/docs/rmr_set_vlevel.3.rst b/docs/rmr_set_vlevel.3.rst index ed80561..37bd8fd 100644 --- a/docs/rmr_set_vlevel.3.rst +++ b/docs/rmr_set_vlevel.3.rst @@ -1,108 +1,117 @@ - - -.. 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_set_vlevel - -SYNOPSIS --------------------------------------------------------------------------------------------- - - -:: - - #include - #include - void rmr_set_vlevel( int new_level ) - - - -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. - - -Generally RMR does not write messages to the standard error -device from *critical path* functions, therefore it is -usually not harmful to enable a verbosity level of either -RMR_VL_CRIT or RMR_VL_ERR. - -Messages written from the route table collection thread are -still governed by the value placed into the verbose level -control file (see the man page for rmr_init()); those -messages are affected only when logging is completely -disabled by passing RMR_VL_OFF to this function. - -The verbosity level can also be set via an environment -variable prior to the start of the RMR based application. The -environment variable is read only during initialisation; if -the programme must change the value during execution, this -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 --------------------------------------------------------------------------------------------- - -rmr_init(3) +.. 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_set_vlevel + + +SYNOPSIS +-------- + + +:: + + #include + #include + + void rmr_set_vlevel( int new_level ) + + + +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: + + .. 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 +device from *critical path* functions, therefore it is +usually not harmful to enable a verbosity level of either +RMR_VL_CRIT or RMR_VL_ERR. + +Messages written from the route table collection thread are +still governed by the value placed into the verbose level +control file (see the man page for rmr_init()); those +messages are affected only when logging is completely +disabled by passing RMR_VL_OFF to this function. + +The verbosity level can also be set via an environment +variable prior to the start of the RMR based application. The +environment variable is read only during initialisation; if +the programme must change the value during execution, this +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 +-------- + +rmr_init(3)