comm.bif.zeek

Broker

GLOBAL

Functions and events regarding broker communication mechanisms.

Namespaces:: Broker, GLOBAL

Summary

Types

Broker::BrokerProtocol: enum

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 the local endpoint has lost its peering with another endpoint.
`Broker::peer_removed`: `event`	Generated when the local endpoint has removed its peering with another endpoint.
`Broker::status`: `event`	Generated when an unspecified change occurs in Broker.

Functions

`Broker::__listen`: `function`
`Broker::__node_id`: `function`
`Broker::__peer`: `function`
`Broker::__peer_no_retry`: `function`
`Broker::__peers`: `function`
`Broker::__unpeer`: `function`

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. This event reports local errors in Broker, as indicated by the provided Broker::ErrorCode.

Parameters:

code – the type of error that triggered this event.
msg – a message providing additional context.

Broker::peer_added

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

Generated when a new peering has been established. Both sides of the peering receive this event, created independently in each endpoint. For the endpoint establishing the peering, the added endpoint’s network information will match the address and port provided to Broker::peer; for the listening endpoint it’s the peer’s TCP client’s address and (likely ephemeral) TCP port.

Parameters:

endpoint – the added endpoint’s Broker ID and connection information.
msg – a message providing additional context.

Broker::peer_lost

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

Generated when the local endpoint has lost its peering with another endpoint. This event fires when the other endpoint stops or removes the peering for some other reason. This event is independent of the original directionality of connection establishment.

Parameters:

endpoint – the lost endpoint’s Broker ID and connection information.
msg – a message providing additional context.

Broker::peer_removed

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

Generated when the local endpoint has removed its peering with another endpoint. This event can fire for multiple reasons, such as a local call to Broker::unpeer, or because Broker autonomously decides to unpeer. One reason it might do this is message I/O backpressure overflow, meaning that the remote peer cannot keep up with the stream of messages the local endpoint sends it. Regardless of the cause, the remote endpoint will locally trigger a corresponding Broker::peer_lost event once the peering ends. These events are independent of the original directionality of TCP connection establishment and only reflect which endpoint terminates the peering.

Parameters:

endpoint – the removed endpoint’s Broker ID and connection information.
msg – a message providing additional context. If backpressure overflow caused this unpeering, the message contains the string caf::sec::backpressure_overflow.

Broker::status

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

Generated when an unspecified change occurs in Broker. This event only fires when the status change isn’t covered by more specific Broker events. The provided message string may be empty.

Parameters:

endpoint – the Broker ID and connection information, if available, of the endpoint the update relates to.
msg – a message providing additional context.

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::__unpeer

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