:tocdepth: 3

base/bif/reporter.bif.bro
=========================
.. bro:namespace:: GLOBAL
.. bro:namespace:: Reporter

The reporter built-in functions allow for the scripting layer to
generate messages of varying severity.  If no event handlers
exist for reporter messages, the messages are output to stderr.
If event handlers do exist, it's assumed they take care of determining
how/where to output the messages.

See :doc:`/scripts/base/frameworks/reporter/main.bro` for a convenient
reporter message logging framework.

:Namespaces: GLOBAL, Reporter
:Source File: :download:`/scripts/base/bif/reporter.bif.bro`

Summary
~~~~~~~
Functions
#########
================================================= ========================================================================
:bro:id:`Reporter::error`: :bro:type:`function`   Generates a non-fatal error indicative of a definite problem that should
                                                  be addressed.
:bro:id:`Reporter::fatal`: :bro:type:`function`   Generates a fatal error on stderr and terminates program execution.
:bro:id:`Reporter::info`: :bro:type:`function`    Generates an informational message.
:bro:id:`Reporter::warning`: :bro:type:`function` Generates a message that warns of a potential problem.
================================================= ========================================================================


Detailed Interface
~~~~~~~~~~~~~~~~~~
Functions
#########
.. bro:id:: Reporter::error

   :Type: :bro:type:`function` (msg: :bro:type:`string`) : :bro:type:`bool`

   Generates a non-fatal error indicative of a definite problem that should
   be addressed. Program execution does not terminate.
   

   :msg: The error message to report.
   

   :returns: Always true.
   
   .. bro:see:: reporter_error

.. bro:id:: Reporter::fatal

   :Type: :bro:type:`function` (msg: :bro:type:`string`) : :bro:type:`bool`

   Generates a fatal error on stderr and terminates program execution.
   

   :msg: The error message to report.
   

   :returns: Always true.

.. bro:id:: Reporter::info

   :Type: :bro:type:`function` (msg: :bro:type:`string`) : :bro:type:`bool`

   Generates an informational message.
   

   :msg: The informational message to report.
   

   :returns: Always true.
   
   .. bro:see:: reporter_info

.. bro:id:: Reporter::warning

   :Type: :bro:type:`function` (msg: :bro:type:`string`) : :bro:type:`bool`

   Generates a message that warns of a potential problem.
   

   :msg: The warning message to report.
   

   :returns: Always true.
   
   .. bro:see:: reporter_warning


