Broker Namespace

Namespace: Broker.

class zlogging.enum.broker.BrokerProtocol(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: IntFlag

Enum: Broker::BrokerProtocol.

See also

base/bif/comm.bif.zeek

NATIVE = 1
WEBSOCKET = 2
static _generate_next_value_(name, start, count, last_values)

Generate the next value when not given.

name: the name of the member start: the initial start value or None count: the number of existing members last_values: the last value assigned or None

class zlogging.enum.broker.DataType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: IntFlag

Enum: Broker::DataType.

Enumerates the possible types that Broker::Data may be in terms of Zeek data types.

See also

base/bif/data.bif.zeek

NONE = 1
BOOL = 2
INT = 4
COUNT = 8
DOUBLE = 16
STRING = 32
ADDR = 64
SUBNET = 128
PORT = 256
TIME = 512
INTERVAL = 1024
ENUM = 2048
SET = 4096
TABLE = 8192
VECTOR = 16384
static _generate_next_value_(name, start, count, last_values)

Generate the next value when not given.

name: the name of the member start: the initial start value or None count: the number of existing members last_values: the last value assigned or None

class zlogging.enum.broker.Type(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: IntFlag

Enum: Broker::Type.

The type of a Broker activity being logged.

See also

base/frameworks/broker/log.zeek

STATUS = 1

An informational status update.

ERROR = 2

An error situation.

static _generate_next_value_(name, start, count, last_values)

Generate the next value when not given.

name: the name of the member start: the initial start value or None count: the number of existing members last_values: the last value assigned or None

class zlogging.enum.broker.ErrorCode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: IntFlag

Enum: Broker::ErrorCode.

Enumerates the possible error types.

See also

base/frameworks/broker/main.zeek

NO_ERROR = 1

(present if base/bif/comm.bif.zeek is loaded)

UNSPECIFIED = 2

The unspecified default error code.

PEER_INCOMPATIBLE = 4

Version incompatibility.

PEER_INVALID = 8

Referenced peer does not exist.

PEER_UNAVAILABLE = 16

Remote peer not listening.

PEER_DISCONNECT_DURING_HANDSHAKE = 32

(present if base/bif/comm.bif.zeek is loaded)

PEER_TIMEOUT = 64

A peering request timed out.

MASTER_EXISTS = 128

Master with given name already exists.

NO_SUCH_MASTER = 256

Master with given name does not exist.

NO_SUCH_KEY = 512

The given data store key does not exist.

REQUEST_TIMEOUT = 1024

The store operation timed out.

TYPE_CLASH = 2048

The operation expected a different type than provided.

INVALID_DATA = 4096

The data value cannot be used to carry out the desired operation.

BACKEND_FAILURE = 8192

The storage backend failed to execute the operation.

STALE_DATA = 16384

The storage backend failed to execute the operation.

CANNOT_OPEN_FILE = 32768

(present if base/bif/comm.bif.zeek is loaded)

CANNOT_WRITE_FILE = 65536

(present if base/bif/comm.bif.zeek is loaded)

INVALID_TOPIC_KEY = 131072

(present if base/bif/comm.bif.zeek is loaded)

END_OF_FILE = 262144

(present if base/bif/comm.bif.zeek is loaded)

INVALID_TAG = 524288

(present if base/bif/comm.bif.zeek is loaded)

INVALID_STATUS = 1048576

(present if base/bif/comm.bif.zeek is loaded)

CAF_ERROR = 2097152

Catch-all for a CAF-level problem.

static _generate_next_value_(name, start, count, last_values)

Generate the next value when not given.

name: the name of the member start: the initial start value or None count: the number of existing members last_values: the last value assigned or None

class zlogging.enum.broker.PeerStatus(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: IntFlag

Enum: Broker::PeerStatus.

The possible states of a peer endpoint.

See also

base/frameworks/broker/main.zeek

INITIALIZING = 1

The peering process is initiated.

CONNECTING = 2

Connection establishment in process.

CONNECTED = 4

Connection established, peering pending.

PEERED = 8

Successfully peered.

DISCONNECTED = 16

Connection to remote peer lost.

RECONNECTING = 32

Reconnecting to peer after a lost connection.

static _generate_next_value_(name, start, count, last_values)

Generate the next value when not given.

name: the name of the member start: the initial start value or None count: the number of existing members last_values: the last value assigned or None

class zlogging.enum.broker.BackendType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: IntFlag

Enum: Broker::BackendType.

Enumerates the possible storage backends.

See also

base/frameworks/broker/store.zeek

MEMORY = 1
SQLITE = 2
static _generate_next_value_(name, start, count, last_values)

Generate the next value when not given.

name: the name of the member start: the initial start value or None count: the number of existing members last_values: the last value assigned or None

class zlogging.enum.broker.QueryStatus(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: IntFlag

Enum: Broker::QueryStatus.

Whether a data store query could be completed or not.

See also

base/frameworks/broker/store.zeek

SUCCESS = 1
FAILURE = 2
static _generate_next_value_(name, start, count, last_values)

Generate the next value when not given.

name: the name of the member start: the initial start value or None count: the number of existing members last_values: the last value assigned or None

class zlogging.enum.broker.SQLiteFailureMode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: IntFlag

Enum: Broker::SQLiteFailureMode.

Behavior when the SQLite database file is found to be corrupt or otherwise fails to open or initialize.

See also

base/frameworks/broker/store.zeek

SQLITE_FAILURE_MODE_FAIL = 1

Fail during initialization.

SQLITE_FAILURE_MODE_DELETE = 2

Attempt to delete the database file and retry.

static _generate_next_value_(name, start, count, last_values)

Generate the next value when not given.

name: the name of the member start: the initial start value or None count: the number of existing members last_values: the last value assigned or None

class zlogging.enum.broker.SQLiteJournalMode(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: IntFlag

Enum: Broker::SQLiteJournalMode.

Values supported for SQLite’s PRAGMA journal_mode statement.

See also

base/frameworks/broker/store.zeek

SQLITE_JOURNAL_MODE_DELETE = 1
SQLITE_JOURNAL_MODE_WAL = 2
static _generate_next_value_(name, start, count, last_values)

Generate the next value when not given.

name: the name of the member start: the initial start value or None count: the number of existing members last_values: the last value assigned or None

class zlogging.enum.broker.SQLiteSynchronous(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: IntFlag

Enum: Broker::SQLiteSynchronous.

Values supported for SQLite’s PRAGMA synchronous statement.

See also

base/frameworks/broker/store.zeek

SQLITE_SYNCHRONOUS_OFF = 1
SQLITE_SYNCHRONOUS_NORMAL = 2
SQLITE_SYNCHRONOUS_FULL = 4
SQLITE_SYNCHRONOUS_EXTRA = 8
static _generate_next_value_(name, start, count, last_values)

Generate the next value when not given.

name: the name of the member start: the initial start value or None count: the number of existing members last_values: the last value assigned or None