Mirror/zeek
1
0
Fork 0
mirror of https://github.com/zeek/zeek.git synced 2025-10-10 18:48:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Fix documentation warnings for MQTT identifiers

Browse source 
I.e. a type was not in the export section, but a field was added
to connection record via a redef that uses the "hidden" type.
That generally doesn't help to hide it that way since a user comes
to rely on it indirectly anyway, and it also causes problems with
the Zeekygen documentation not being able to find it.
This commit is contained in:
Jon Siwek 2019-08-05 18:55:48 -07:00
parent 704969ddd6
commit 1eb1771c25
1 changed files with 17 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

11
scripts/policy/protocols/mqtt/main.zeek
View file

@ -105,15 +105,24 @@ export {
## Event that can be handled to access the MQTT record as it is sent on ## Event that can be handled to access the MQTT record as it is sent on
## to the logging framework. ## to the logging framework.
global MQTT::log_mqtt: event(rec: ConnectInfo); global MQTT::log_mqtt: event(rec: ConnectInfo);
}
## The expiration function for published messages that haven't been logged
## yet simply causes the message to be logged.
global publish_expire: function(tbl: table[count] of PublishInfo, idx: count): interval; global publish_expire: function(tbl: table[count] of PublishInfo, idx: count): interval;
## The expiration function for subscription messages that haven't been logged
## yet simply causes the message to be logged.
global subscribe_expire: function(tbl: table[count] of SubscribeInfo, idx: count): interval; global subscribe_expire: function(tbl: table[count] of SubscribeInfo, idx: count): interval;
## Data structure to track pub/sub messaging state of a given connection.
type State: record { type State: record {
## Published messages that haven't been logged yet.
publish: table[count] of PublishInfo &optional &write_expire=5secs &expire_func=publish_expire; publish: table[count] of PublishInfo &optional &write_expire=5secs &expire_func=publish_expire;
## Subscription/unsubscription messages that haven't been ACK'd or
## logged yet.
subscribe: table[count] of SubscribeInfo &optional &write_expire=5secs &expire_func=subscribe_expire; subscribe: table[count] of SubscribeInfo &optional &write_expire=5secs &expire_func=subscribe_expire;
}; };
}
function publish_expire(tbl: table[count] of PublishInfo, idx: count): interval function publish_expire(tbl: table[count] of PublishInfo, idx: count): interval
{ {