base/frameworks/broker/store.bro

Broker

Various data structure definitions for use with Bro’s communication system.

Namespace:Broker Imports:base/bif/data.bif.bro, base/bif/store.bif.bro, base/frameworks/broker/main.bro Source File:/scripts/base/frameworks/broker/store.bro

Summary

Types

Broker::BackendOptions: record	Options to tune the particular storage backends.
Broker::BackendType: enum	Enumerates the possible storage backends.
Broker::ExpiryTime: record	An expiry time for a key-value pair inserted in to a data store.
Broker::QueryResult: record	The result of a data store query.
Broker::QueryStatus: enum	Whether a data store query could be completed or not.
Broker::RocksDBOptions: record	Options to tune the RocksDB storage backend.
Broker::SQLiteOptions: record	Options to tune the SQLite storage backend.

Detailed Interface

Types

Broker::BackendOptions

Type:

record

sqlite: Broker::SQLiteOptions &default = [path=store.sqlite] &optional

rocksdb: Broker::RocksDBOptions &default = [path=store.rocksdb] &optional

Options to tune the particular storage backends.

Broker::BackendType

Type:

enum

Broker::MEMORY

Broker::SQLITE

Broker::ROCKSDB

Enumerates the possible storage backends.

Broker::ExpiryTime

Type:

record

absolute: time &optional

Absolute point in time at which to expire the entry.

since_last_modification: interval &optional

A point in time relative to the last modification time at which to expire the entry. New modifications will delay the expiration.

An expiry time for a key-value pair inserted in to a data store.

Broker::QueryResult

Type:

record

status: Broker::QueryStatus

Whether the query completed or not.

result: Broker::Data

The result of the query. Certain queries may use a particular data type (e.g. querying store size always returns a count, but a lookup may return various data types).

The result of a data store query.

Broker::QueryStatus

Type:

enum

Broker::SUCCESS

Broker::FAILURE

Whether a data store query could be completed or not.

Broker::RocksDBOptions

Type:

record

path: string &default = "store.rocksdb" &optional

File system path of the database.

Options to tune the RocksDB storage backend.

Broker::SQLiteOptions

Type:

record

path: string &default = "store.sqlite" &optional

File system path of the database.

Options to tune the SQLite storage backend.