base/bif/reporter.bif.bro

GLOBAL
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 base/frameworks/reporter/main.bro for a convenient reporter message logging framework.

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

Summary

Functions

Reporter::error: function Generates a non-fatal error indicative of a definite problem that should be addressed.
Reporter::fatal: function Generates a fatal error on stderr and terminates program execution.
Reporter::info: function Generates an informational message.
Reporter::warning: function Generates a message that warns of a potential problem.

Detailed Interface

Functions

Reporter::error
Type:function (msg: string) : 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.

See also: reporter_error

Reporter::fatal
Type:function (msg: string) : bool

Generates a fatal error on stderr and terminates program execution.

Msg:The error message to report.
Returns:Always true.
Reporter::info
Type:function (msg: string) : bool

Generates an informational message.

Msg:The informational message to report.
Returns:Always true.

See also: reporter_info

Reporter::warning
Type:function (msg: string) : bool

Generates a message that warns of a potential problem.

Msg:The warning message to report.
Returns:Always true.

See also: reporter_warning


Previous Page

base/bif/bro.bif.bro

Copyright 2016, The Bro Project. Last updated on December 15, 2017. Created using Sphinx 1.5.2.