Generate docs

Author: zeek-bot

script-reference/autogenerated-protocol-analyzer-index.rst

@@ -726,7 +726,7 @@ Events
 ++++++
 
 .. zeek:id:: Cluster::websocket_client_added
-   :source-code: base/frameworks/cluster/main.zeek 688 693
+   :source-code: base/frameworks/cluster/main.zeek 702 707
 
    :Type: :zeek:type:`event` (endpoint: :zeek:type:`Cluster::EndpointInfo`, subscriptions: :zeek:type:`string_vec`)
 
@@ -739,7 +739,7 @@ Events
    :param subscriptions: The WebSocket client's subscriptions as provided in the handshake.
 
 .. zeek:id:: Cluster::websocket_client_lost
-   :source-code: base/frameworks/cluster/main.zeek 695 701
+   :source-code: base/frameworks/cluster/main.zeek 709 715
 
    :Type: :zeek:type:`event` (endpoint: :zeek:type:`Cluster::EndpointInfo`, code: :zeek:type:`count`, reason: :zeek:type:`string`)
 

scripts/base/bif/cluster.bif.zeek.rst

@@ -39,7 +39,7 @@ Detailed Interface
 Events
 ######
 .. zeek:id:: Cluster::Backend::error
-   :source-code: base/frameworks/cluster/main.zeek 704 708
+   :source-code: base/frameworks/cluster/main.zeek 718 722
 
    :Type: :zeek:type:`event` (tag: :zeek:type:`string`, message: :zeek:type:`string`)
 

scripts/base/bif/plugins/Zeek_Cluster_WebSocket.events.bif.zeek.rst

@@ -23,7 +23,7 @@ Detailed Interface
 Events
 ######
 .. zeek:id:: Cluster::websocket_client_added
-   :source-code: base/frameworks/cluster/main.zeek 688 693
+   :source-code: base/frameworks/cluster/main.zeek 702 707
 
    :Type: :zeek:type:`event` (endpoint: :zeek:type:`Cluster::EndpointInfo`, subscriptions: :zeek:type:`string_vec`)
 
@@ -36,7 +36,7 @@ Events
    :param subscriptions: The WebSocket client's subscriptions as provided in the handshake.
 
 .. zeek:id:: Cluster::websocket_client_lost
-   :source-code: base/frameworks/cluster/main.zeek 695 701
+   :source-code: base/frameworks/cluster/main.zeek 709 715
 
    :Type: :zeek:type:`event` (endpoint: :zeek:type:`Cluster::EndpointInfo`, code: :zeek:type:`count`, reason: :zeek:type:`string`)
 

scripts/base/frameworks/analyzer/logging.zeek.rst

@@ -51,7 +51,7 @@ Detailed Interface
 Runtime Options
 ###############
 .. zeek:id:: Analyzer::Logging::failure_data_max_size
-   :source-code: base/frameworks/analyzer/logging.zeek 37 37
+   :source-code: base/frameworks/analyzer/logging.zeek 39 39
 
    :Type: :zeek:type:`count`
    :Attributes: :zeek:attr:`&redef`
@@ -63,7 +63,7 @@ Runtime Options
 Types
 #####
 .. zeek:type:: Analyzer::Logging::Info
-   :source-code: base/frameworks/analyzer/logging.zeek 13 33
+   :source-code: base/frameworks/analyzer/logging.zeek 13 35
 
    :Type: :zeek:type:`record`
 
@@ -97,7 +97,12 @@ Types
 
    .. zeek:field:: id :zeek:type:`conn_id` :zeek:attr:`&log` :zeek:attr:`&optional`
 
-      Connection identifier if available
+      Connection identifier if available.
+
+
+   .. zeek:field:: proto :zeek:type:`transport_proto` :zeek:attr:`&log` :zeek:attr:`&optional`
+
+      Transport protocol for the violation, if available.
 
 
    .. zeek:field:: failure_reason :zeek:type:`string` :zeek:attr:`&log`
@@ -124,7 +129,7 @@ Types
 Events
 ######
 .. zeek:id:: Analyzer::Logging::log_analyzer
-   :source-code: base/frameworks/analyzer/logging.zeek 41 41
+   :source-code: base/frameworks/analyzer/logging.zeek 43 43
 
    :Type: :zeek:type:`event` (rec: :zeek:type:`Analyzer::Logging::Info`)
 

scripts/base/frameworks/cluster/main.zeek.rst

@@ -118,9 +118,11 @@ Events
 
 Hooks
 #####
-============================================================ =============================================
+============================================================ =============================================================
 :zeek:id:`Cluster::log_policy`: :zeek:type:`Log::PolicyHook` A default logging policy hook for the stream.
-============================================================ =============================================
+:zeek:id:`Cluster::on_subscribe`: :zeek:type:`hook`          A hook invoked for every :zeek:see:`Cluster::subscribe` call.
+:zeek:id:`Cluster::on_unsubscribe`: :zeek:type:`hook`        A hook invoked for every :zeek:see:`Cluster::subscribe` call.
+============================================================ =============================================================
 
 Functions
 #########
@@ -750,7 +752,7 @@ Types
 Events
 ######
 .. zeek:id:: Cluster::hello
-   :source-code: base/frameworks/cluster/main.zeek 498 523
+   :source-code: base/frameworks/cluster/main.zeek 512 537
 
    :Type: :zeek:type:`event` (name: :zeek:type:`string`, id: :zeek:type:`string`)
 
@@ -784,10 +786,34 @@ Hooks
 
    A default logging policy hook for the stream.
 
+.. zeek:id:: Cluster::on_subscribe
+   :source-code: base/frameworks/cluster/main.zeek 410 410
+
+   :Type: :zeek:type:`hook` (topic: :zeek:type:`string`) : :zeek:type:`bool`
+
+   A hook invoked for every :zeek:see:`Cluster::subscribe` call.
+   
+   Breaking from this hook has no effect.
+   
+
+   :param topic: The topic string as given to :zeek:see:`Cluster::subscribe`.
+
+.. zeek:id:: Cluster::on_unsubscribe
+   :source-code: base/frameworks/cluster/main.zeek 417 417
+
+   :Type: :zeek:type:`hook` (topic: :zeek:type:`string`) : :zeek:type:`bool`
+
+   A hook invoked for every :zeek:see:`Cluster::subscribe` call.
+   
+   Breaking from this hook has no effect.
+   
+
+   :param topic: The topic string as given to :zeek:see:`Cluster::subscribe`.
+
 Functions
 #########
 .. zeek:id:: Cluster::create_store
-   :source-code: base/frameworks/cluster/main.zeek 578 653
+   :source-code: base/frameworks/cluster/main.zeek 592 667
 
    :Type: :zeek:type:`function` (name: :zeek:type:`string`, persistent: :zeek:type:`bool` :zeek:attr:`&default` = ``F`` :zeek:attr:`&optional`) : :zeek:type:`Cluster::StoreInfo`
 
@@ -806,7 +832,7 @@ Functions
             be set until the node containing the master store has connected.
 
 .. zeek:id:: Cluster::get_active_node_count
-   :source-code: base/frameworks/cluster/main.zeek 442 445
+   :source-code: base/frameworks/cluster/main.zeek 456 459
 
    :Type: :zeek:type:`function` (node_type: :zeek:type:`Cluster::NodeType`) : :zeek:type:`count`
 
@@ -815,15 +841,15 @@ Functions
    out how many nodes should be responding to requests.
 
 .. zeek:id:: Cluster::get_node_count
-   :source-code: base/frameworks/cluster/main.zeek 429 440
+   :source-code: base/frameworks/cluster/main.zeek 443 454
 
    :Type: :zeek:type:`function` (node_type: :zeek:type:`Cluster::NodeType`) : :zeek:type:`count`
 
    Returns the number of nodes defined in the cluster layout for a given
    node type.
 
 .. zeek:id:: Cluster::init
-   :source-code: base/frameworks/cluster/main.zeek 660 663
+   :source-code: base/frameworks/cluster/main.zeek 674 677
 
    :Type: :zeek:type:`function` () : :zeek:type:`bool`
 
@@ -835,7 +861,7 @@ Functions
    :returns: T on success, else F.
 
 .. zeek:id:: Cluster::is_enabled
-   :source-code: base/frameworks/cluster/main.zeek 447 450
+   :source-code: base/frameworks/cluster/main.zeek 461 464
 
    :Type: :zeek:type:`function` () : :zeek:type:`bool`
 
@@ -846,7 +872,7 @@ Functions
    :returns: True if :zeek:id:`Cluster::node` has been set.
 
 .. zeek:id:: Cluster::listen_websocket
-   :source-code: base/frameworks/cluster/main.zeek 675 678
+   :source-code: base/frameworks/cluster/main.zeek 689 692
 
    :Type: :zeek:type:`function` (options: :zeek:type:`Cluster::WebSocketServerOptions`) : :zeek:type:`bool`
 
@@ -859,7 +885,7 @@ Functions
    :returns: T on success, else F.
 
 .. zeek:id:: Cluster::local_node_metrics_port
-   :source-code: base/frameworks/cluster/main.zeek 463 475
+   :source-code: base/frameworks/cluster/main.zeek 477 489
 
    :Type: :zeek:type:`function` () : :zeek:type:`port`
 
@@ -872,7 +898,7 @@ Functions
    :returns: The metrics port used by the calling node.
 
 .. zeek:id:: Cluster::local_node_type
-   :source-code: base/frameworks/cluster/main.zeek 452 461
+   :source-code: base/frameworks/cluster/main.zeek 466 475
 
    :Type: :zeek:type:`function` () : :zeek:type:`Cluster::NodeType`
 
@@ -885,7 +911,7 @@ Functions
    :returns: The :zeek:type:`Cluster::NodeType` the calling node acts as.
 
 .. zeek:id:: Cluster::log
-   :source-code: base/frameworks/cluster/main.zeek 655 658
+   :source-code: base/frameworks/cluster/main.zeek 669 672
 
    :Type: :zeek:type:`function` (msg: :zeek:type:`string`) : :zeek:type:`void`
 
@@ -919,7 +945,7 @@ Functions
             a given cluster node.
 
 .. zeek:id:: Cluster::nodeid_to_node
-   :source-code: base/frameworks/cluster/main.zeek 487 496
+   :source-code: base/frameworks/cluster/main.zeek 501 510
 
    :Type: :zeek:type:`function` (id: :zeek:type:`string`) : :zeek:type:`Cluster::NamedNode`
 
@@ -950,7 +976,7 @@ Functions
             a given cluster node.
 
 .. zeek:id:: Cluster::subscribe
-   :source-code: base/frameworks/cluster/main.zeek 665 668
+   :source-code: base/frameworks/cluster/main.zeek 679 682
 
    :Type: :zeek:type:`function` (topic: :zeek:type:`string`) : :zeek:type:`bool`
 
@@ -963,7 +989,7 @@ Functions
    :returns: T on success, else F.
 
 .. zeek:id:: Cluster::unsubscribe
-   :source-code: base/frameworks/cluster/main.zeek 670 673
+   :source-code: base/frameworks/cluster/main.zeek 684 687
 
    :Type: :zeek:type:`function` (topic: :zeek:type:`string`) : :zeek:type:`bool`