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

Fix typos and formatting in the communication framework doc

Browse source 
Fixed a link that was pointing to the wrong "connect".
This commit is contained in:
Daniel Thayer 2013-10-10 14:42:01 -05:00
parent f21f45ac1a
commit e2c5a5c4a5
1 changed files with 12 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

22
scripts/base/frameworks/communication/main.bro
View file

@ -42,10 +42,11 @@ export {
type Info: record { type Info: record {
## The network time at which a communication event occurred. ## The network time at which a communication event occurred.
ts: time &log; ts: time &log;
## The peer name (if any) with which a communication event is concerned. ## The peer name (if any) with which a communication event is
## concerned.
peer: string &log &optional; peer: string &log &optional;
## Where the communication event message originated from, that is, ## Where the communication event message originated from, that
## either from the scripting layer or inside the Bro process. ## is, either from the scripting layer or inside the Bro process.
src_name: string &log &optional; src_name: string &log &optional;
## .. todo:: currently unused. ## .. todo:: currently unused.
connected_peer_desc: string &log &optional; connected_peer_desc: string &log &optional;
@ -71,8 +72,8 @@ export {
## can specify a particular :rfc:`4007` ``zone_id``. ## can specify a particular :rfc:`4007` ``zone_id``.
zone_id: string &optional; zone_id: string &optional;
## Port of the remote Bro communication endpoint if we are initiating ## Port of the remote Bro communication endpoint if we are
## the connection based on the :bro:id:`connect` field. ## initiating the connection (based on the *connect* field).
p: port &optional; p: port &optional;
## When accepting a connection, the configuration only ## When accepting a connection, the configuration only
@ -87,7 +88,7 @@ export {
events: pattern &optional; events: pattern &optional;
## Whether we are going to connect (rather than waiting ## Whether we are going to connect (rather than waiting
## for the other sie to connect to us). ## for the other side to connect to us).
connect: bool &default = F; connect: bool &default = F;
## If disconnected, reconnect after this many seconds. ## If disconnected, reconnect after this many seconds.
@ -103,13 +104,14 @@ export {
request_logs: bool &default = F; request_logs: bool &default = F;
## When performing state synchronization, whether we consider ## When performing state synchronization, whether we consider
## our state to be authoritative. If so, we will send the peer ## our state to be authoritative (only one side can be
## our current set when the connection is set up. ## authoritative). If so, we will send the peer our current
## (Only one side can be authoritative) ## set when the connection is set up.
auth: bool &default = F; auth: bool &default = F;
## If not set, no capture filter is sent. ## If not set, no capture filter is sent.
## If set to "", the default capture filter is sent. ## If set to an empty string, then the default capture filter
## is sent.
capture_filter: string &optional; capture_filter: string &optional;
## Whether to use SSL-based communication. ## Whether to use SSL-based communication.