base/bif/comm.bif.zeek

Broker
GLOBAL

Functions and events regarding broker communication mechanisms.

Namespaces

Broker, GLOBAL

Summary

Events

Broker::endpoint_discovered: event

Generated when a new Broker endpoint appeared.

Broker::endpoint_unreachable: event

Generated when the last path to a Broker endpoint has been lost.

Broker::error: event

Generated when an error occurs in the Broker sub-system.

Broker::peer_added: event

Generated when a new peering has been established.

Broker::peer_lost: event

Generated when an existing peering has been lost.

Broker::peer_removed: event

Generated when an existing peer has been removed.

Broker::status: event

Generated when something changes in the Broker sub-system.

Detailed Interface

Types

Broker::BrokerProtocol
Type

enum

Broker::NATIVE
Broker::WEBSOCKET

Events

Broker::endpoint_discovered
Type

event (endpoint: Broker::EndpointInfo, msg: string)

Generated when a new Broker endpoint appeared.

Broker::endpoint_unreachable
Type

event (endpoint: Broker::EndpointInfo, msg: string)

Generated when the last path to a Broker endpoint has been lost.

Broker::error
Type

event (code: Broker::ErrorCode, msg: string)

Generated when an error occurs in the Broker sub-system.

Broker::peer_added
Type

event (endpoint: Broker::EndpointInfo, msg: string)

Generated when a new peering has been established.

Broker::peer_lost
Type

event (endpoint: Broker::EndpointInfo, msg: string)

Generated when an existing peering has been lost.

Broker::peer_removed
Type

event (endpoint: Broker::EndpointInfo, msg: string)

Generated when an existing peer has been removed.

Broker::status
Type

event (endpoint: Broker::EndpointInfo, msg: string)

Generated when something changes in the Broker sub-system.

Functions

Broker::__listen
Type

function (a: string, p: port, proto: Broker::BrokerProtocol) : port

Broker::__node_id
Type

function () : string

Broker::__peer
Type

function (a: string, p: port, retry: interval) : bool

Broker::__peer_no_retry
Type

function (a: string, p: port) : bool

Broker::__peers
Type

function () : Broker::PeerInfos

Broker::__set_metrics_export_endpoint_name
Type

function (value: string) : bool

Broker::__set_metrics_export_interval
Type

function (value: interval) : bool

Broker::__set_metrics_export_prefixes
Type

function (filter: string_vec) : bool

Broker::__set_metrics_export_topic
Type

function (value: string) : bool

Broker::__unpeer
Type

function (a: string, p: port) : bool