base/protocols/conn/polling.zeek

ConnPolling

Implements a generic way to poll connections looking for certain features (e.g. monitor bytes transferred). The specific feature of a connection to look for, the polling interval, and the code to execute if the feature is found are all controlled by user-defined callback functions.

Namespace

ConnPolling

Summary

Functions

ConnPolling::watch: function

Starts monitoring a given connection.

Detailed Interface

Functions

ConnPolling::watch
Type

function (c: connection, callback: function (c: connection, cnt: count) : interval, cnt: count, i: interval) : void

Starts monitoring a given connection.

Parameters
  • c – The connection to watch.

  • callback – A callback function that takes as arguments the monitored connection, and counter cnt that increments each time the callback is called. It returns an interval indicating how long in the future to schedule an event which will call the callback. A negative return interval causes polling to stop.

  • cnt – The initial value of a counter which gets passed to callback.

  • i – The initial interval at which to schedule the next callback. May be 0secs to poll right away.