base/frameworks/cluster/pubsub.zeek

Cluster

Namespace:: Cluster
Imports:: base/bif/cluster.bif.zeek, base/frameworks/cluster/types.zeek

Summary

Hooks

`Cluster::on_subscribe`: `hook`	A hook invoked for every `Cluster::subscribe` call.
`Cluster::on_unsubscribe`: `hook`	A hook invoked for every `Cluster::subscribe` call.

Functions

`Cluster::subscribe`: `function`	Subscribe to the given topic.
`Cluster::unsubscribe`: `function`	Unsubscribe from the given topic.

Detailed Interface

Hooks

Cluster::on_subscribe 

Type:: hook (topic: string) : bool

A hook invoked for every Cluster::subscribe call.

Breaking from this hook has no effect.

Parameters:: topic – The topic string as given to Cluster::subscribe.

Cluster::on_unsubscribe 

Type:: hook (topic: string) : bool

A hook invoked for every Cluster::subscribe call.

Breaking from this hook has no effect.

Parameters:: topic – The topic string as given to Cluster::subscribe.

Functions

Cluster::subscribe 

Type:: function (topic: string) : bool

Subscribe to the given topic.

Parameters:: topic – The topic to subscribe to.
Returns:: T on success, else F.

Cluster::unsubscribe 

Type:: function (topic: string) : bool

Unsubscribe from the given topic.

Parameters:: topic – The topic to unsubscribe from.
Returns:: T on success, else F.