# NotifyCategory¶

class NotifyCategory

Bases: MemoryBase, ConfigFlags

A particular category of error messages. Typically there will be one of these per package, so that we can turn on or off error messages at least at a package level; further nested categories can be created within a package if a finer grain of control is required.

Inheritance diagram

NotifyCategory(NotifyCategory const&) = default
std::ostream &debug(bool prefix = true) const

A shorthand way to write out(NS_debug).

std::ostream &error(bool prefix = true) const

A shorthand way to write out(NS_error).

std::ostream &fatal(bool prefix = true) const

A shorthand way to write out(NS_fatal).

std::string get_basename(void) const
NotifyCategory *get_child(std::size_t i) const

Returns the nth child Category of this particular Category.

std::string get_fullname(void) const
std::size_t get_num_children(void) const

Returns the number of child Categories of this particular Category.

NotifySeverity get_severity(void) const
std::ostream &info(bool prefix = true) const

A shorthand way to write out(NS_info).

bool is_debug(void) const

A shorthand way to write is_on(NS_debug).

bool is_error(void) const

A shorthand way to write is_on(NS_error).

bool is_fatal(void) const

A shorthand way to write is_on(NS_fatal).

bool is_info(void) const

A shorthand way to write is_on(NS_info).

bool is_on(NotifySeverity severity) const

Returns true if messages of the indicated severity level ought to be reported for this Category.

bool is_spam(void) const

When NOTIFY_DEBUG is not defined, the categories will never be set to “spam” or “debug” severities, and these methods are redefined to be static to make it more obvious to the compiler. However, we still want to present a consistent interface to our scripting language, so during the interrogate pass (that is, when CPPPARSER is defined), we still pretend they’re nonstatic.

A shorthand way to write is_on(NS_spam).

bool is_warning(void) const

A shorthand way to write is_on(NS_warning).

std::ostream &out(NotifySeverity severity, bool prefix = true) const

Begins a new message to this Category at the indicated severity level. If the indicated severity level is enabled, this writes a prefixing string to the Notify::out() stream and returns that. If the severity level is disabled, this returns Notify::null().

static void set_server_delta(long int delta)

Sets a global delta (in seconds) between the local time and the server’s time, for the purpose of synchronizing the time stamps in the log messages of the client with that of a known server.

void set_severity(NotifySeverity severity)

Sets the severity level of messages that will be reported from this Category. This allows any message of this severity level or higher.

std::ostream &spam(bool prefix = true) const

A shorthand way to write out(NS_spam).

std::ostream &warning(bool prefix = true) const

A shorthand way to write out(NS_warning).