docs/rmr_set_vlevel.3.rst

   1
   2
   3 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   4 .. SPDX-License-Identifier: CC-BY-4.0
   5 .. CAUTION: this document is generated from source in doc/src/rtd.
   6 .. To make changes edit the source and recompile the document.
   7 .. Do NOT make changes directly to .rst or .md files.
   8
   9
  10 ============================================================================================
  11 Man Page: rmr_set_vlevel
  12 ============================================================================================
  13
  14 RMR Library Functions
  15 ============================================================================================
  16
  17
  18 NAME
  19 --------------------------------------------------------------------------------------------
  20
  21 rmr_set_vlevel
  22
  23 SYNOPSIS
  24 --------------------------------------------------------------------------------------------
  25
  26
  27 ::
  28
  29  #include <rmr/rmr.h>
  30  #include <rmr/rmr_logging.h>
  31  void rmr_set_vlevel( int new_level )
  32
  33
  34
  35 DESCRIPTION
  36 --------------------------------------------------------------------------------------------
  37
  38 The rmr_set_vlevel allows the user programme to set the
  39 verbosity level which is used to determine the messages RMR
  40 writes to standard error. The new_vlevel value must be one of
  41 the following constants which have the indicated meanings:
  42
  43
  44 RMR_VL_OFF
  45
  46   Turns off all message writing. This includes the stats and
  47   debugging messages generated by the route collector thread
  48   which are normally affected only by the externally managed
  49   verbose level file (and related environment variable).
  50
  51
  52 RMR_VL_CRIT
  53
  54   Write only messages of critical importance. From the point
  55   of view of RMR, when a critical proper behaviour of the
  56   library cannot be expected or guaranteed.
  57
  58 RMR_VL_ERR
  59
  60   Include error messages in the output. An error is an event
  61   from which RMR has no means to recover. Continued proper
  62   execution is likely except where the affected connection
  63   and/or component mentioned in the error is concerned.
  64
  65 RMR_VL_WARN
  66
  67   Include warning messages in the output. A warning
  68   indicates an event which is not considered to be normal,
  69   but is expected and continued acceptable behaviour of the
  70   system is assured.
  71
  72 RMR_VL_INFO
  73
  74   Include informational messagees in the output.
  75   Informational messages include some diagnostic information
  76   which explain the activities of RMR.
  77
  78 RMR_VL_DEBUG
  79
  80   Include all debugging messages in the output. Debugging
  81   must have also been enabled during the build as a
  82   precaution to accidentally enabling this level of output
  83   as it can grossly affect performance.
  84
  85
  86 Generally RMR does not write messages to the standard error
  87 device from *critical path* functions, therefore it is
  88 usually not harmful to enable a verbosity level of either
  89 RMR_VL_CRIT or RMR_VL_ERR.
  90
  91 Messages written from the route table collection thread are
  92 still governed by the value placed into the verbose level
  93 control file (see the man page for rmr_init()); those
  94 messages are affected only when logging is completely
  95 disabled by passing RMR_VL_OFF to this function.
  96
  97 The verbosity level can also be set via an environment
  98 variable prior to the start of the RMR based application. The
  99 environment variable is read only during initialisation; if
 100 the programme must change the value during execution, this
 101 function must be used. The default value, if this function is
 102 never called, and the environment variable is not present, is
 103 RMR_VL_ERR.
 104
 105 SEE ALSO
 106 --------------------------------------------------------------------------------------------
 107
 108 rmr_init(3)