1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. SPDX-License-Identifier: CC-BY-4.0
3 .. CAUTION: this document is generated from source in doc/src/rtd.
4 .. To make changes edit the source and recompile the document.
5 .. Do NOT make changes directly to .rst or .md files.
7 ============================================================================================
8 Man Page: rmr_set_vlevel
9 ============================================================================================
32 #include <rmr/rmr_logging.h>
34 void rmr_set_vlevel( int new_level )
41 The ``rmr_set_vlevel`` allows the user programme to set the
42 verbosity level which is used to determine the messages RMR
43 writes to standard error. The ``new_vlevel`` value must be
44 one of the following constants which have the indicated
54 Turns off all message writing. This includes the stats and
55 debugging messages generated by the route collector thread
56 which are normally affected only by the externally managed
57 verbose level file (and related environment variable).
61 Write only messages of critical importance. From the point of
62 view of RMR, when a critical proper behaviour of the library
63 cannot be expected or guaranteed.
67 Include error messages in the output. An error is an event
68 from which RMR has no means to recover. Continued proper
69 execution is likely except where the affected connection
70 and/or component mentioned in the error is concerned.
74 Include warning messages in the output. A warning indicates
75 an event which is not considered to be normal, but is
76 expected and continued acceptable behaviour of the system is
81 Include informational messagees in the output. Informational
82 messages include some diagnostic information which explain
83 the activities of RMR.
87 Include all debugging messages in the output. Debugging must
88 have also been enabled during the build as a precaution to
89 accidentally enabling this level of output as it can grossly
94 Generally RMR does not write messages to the standard error
95 device from *critical path* functions, therefore it is
96 usually not harmful to enable a verbosity level of either
97 RMR_VL_CRIT or RMR_VL_ERR.
99 Messages written from the route table collection thread are
100 still governed by the value placed into the verbose level
101 control file (see the man page for rmr_init()); those
102 messages are affected only when logging is completely
103 disabled by passing RMR_VL_OFF to this function.
105 The verbosity level can also be set via an environment
106 variable prior to the start of the RMR based application. The
107 environment variable is read only during initialisation; if
108 the programme must change the value during execution, this
109 function must be used. The default value, if this function is
110 never called, and the environment variable is not present, is