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.
10 ============================================================================================
11 Man Page: rmr_set_vlevel
12 ============================================================================================
15 ============================================================================================
19 --------------------------------------------------------------------------------------------
24 --------------------------------------------------------------------------------------------
30 #include <rmr/rmr_logging.h>
31 void rmr_set_vlevel( int new_level )
36 --------------------------------------------------------------------------------------------
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:
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).
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.
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.
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
74 Include informational messagees in the output.
75 Informational messages include some diagnostic information
76 which explain the activities of RMR.
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.
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.
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.
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
106 --------------------------------------------------------------------------------------------