Generate docs

Author: zeek-bot

script-reference/autogenerated-package-index.rst

@@ -397,6 +397,9 @@
    purpose is to provide an easy way to load all known Zeek scripts plus any
    extra scripts needed or used by the documentation process.
 
+:doc:`policy/frameworks/cluster/backend/zeromq </scripts/policy/frameworks/cluster/backend/zeromq/index>`
+
+
 :doc:`policy/frameworks/management/agent </scripts/policy/frameworks/management/agent/index>`
 
 

script-reference/autogenerated-script-index.rst

@@ -253,6 +253,7 @@
    base/bif/plugins/Zeek_WebSocket.functions.bif.zeek </scripts/base/bif/plugins/Zeek_WebSocket.functions.bif.zeek>
    base/bif/plugins/Zeek_WebSocket.types.bif.zeek </scripts/base/bif/plugins/Zeek_WebSocket.types.bif.zeek>
    base/bif/plugins/Zeek_XMPP.events.bif.zeek </scripts/base/bif/plugins/Zeek_XMPP.events.bif.zeek>
+   base/bif/plugins/Zeek_Cluster_Backend_ZeroMQ.cluster_backend_zeromq.bif.zeek </scripts/base/bif/plugins/Zeek_Cluster_Backend_ZeroMQ.cluster_backend_zeromq.bif.zeek>
    base/bif/plugins/Zeek_ARP.events.bif.zeek </scripts/base/bif/plugins/Zeek_ARP.events.bif.zeek>
    base/bif/plugins/Zeek_UDP.events.bif.zeek </scripts/base/bif/plugins/Zeek_UDP.events.bif.zeek>
    base/bif/plugins/Zeek_ICMP.events.bif.zeek </scripts/base/bif/plugins/Zeek_ICMP.events.bif.zeek>
@@ -495,6 +496,8 @@
    builtin-plugins/Zeek_AF_Packet/init.zeek </scripts/builtin-plugins/Zeek_AF_Packet/init.zeek>
    zeekygen/__load__.zeek </scripts/zeekygen/__load__.zeek>
    test-all-policy.zeek </scripts/test-all-policy.zeek>
+   policy/frameworks/cluster/backend/zeromq/__load__.zeek </scripts/policy/frameworks/cluster/backend/zeromq/__load__.zeek>
+   policy/frameworks/cluster/backend/zeromq/main.zeek </scripts/policy/frameworks/cluster/backend/zeromq/main.zeek>
    policy/frameworks/cluster/experimental.zeek </scripts/policy/frameworks/cluster/experimental.zeek>
    policy/frameworks/management/agent/__load__.zeek </scripts/policy/frameworks/management/agent/__load__.zeek>
    policy/frameworks/management/agent/api.zeek </scripts/policy/frameworks/management/agent/api.zeek>
@@ -614,6 +617,7 @@
    policy/protocols/ssl/weak-keys.zeek </scripts/policy/protocols/ssl/weak-keys.zeek>
    policy/tuning/json-logs.zeek </scripts/policy/tuning/json-logs.zeek>
    policy/tuning/track-all-assets.zeek </scripts/policy/tuning/track-all-assets.zeek>
+   policy/frameworks/cluster/backend/zeromq/connect.zeek </scripts/policy/frameworks/cluster/backend/zeromq/connect.zeek>
    policy/frameworks/cluster/nodes-experimental/manager.zeek </scripts/policy/frameworks/cluster/nodes-experimental/manager.zeek>
    policy/frameworks/control/controllee.zeek </scripts/policy/frameworks/control/controllee.zeek>
    policy/frameworks/control/controller.zeek </scripts/policy/frameworks/control/controller.zeek>

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

@@ -19,6 +19,10 @@ Functions
 :zeek:id:`Cluster::make_event`: :zeek:type:`function`      Create a data structure that may be used to send a remote event via
                                                            :zeek:see:`Broker::publish`.
 :zeek:id:`Cluster::publish`: :zeek:type:`function`         Publishes an event to a given topic.
+:zeek:id:`Cluster::publish_hrw`: :zeek:type:`function`     Publishes an event to a node within a pool according to Rendezvous
+                                                           (Highest Random Weight) hashing strategy.
+:zeek:id:`Cluster::publish_rr`: :zeek:type:`function`      Publishes an event to a node within a pool according to Round-Robin
+                                                           distribution strategy.
 ========================================================== ===================================================================
 
 
@@ -83,4 +87,51 @@ Functions
 
    :returns: true if the message is sent.
 
+.. zeek:id:: Cluster::publish_hrw
+   :source-code: base/bif/cluster.bif.zeek 80 80
+
+   :Type: :zeek:type:`function` (...) : :zeek:type:`bool`
+
+   Publishes an event to a node within a pool according to Rendezvous
+   (Highest Random Weight) hashing strategy.
+   
+
+   :param pool: the pool of nodes that are eligible to receive the event.
+   
+
+   :param key: data used for input to the hashing function that will uniformly
+        distribute keys among available nodes.
+   
+
+   :param args: Either the event arguments as already made by
+         :zeek:see:`Broker::make_event` or the argument list to pass along
+         to it.
+   
+
+   :returns: true if the message is sent.
+
+.. zeek:id:: Cluster::publish_rr
+   :source-code: base/bif/cluster.bif.zeek 63 63
+
+   :Type: :zeek:type:`function` (...) : :zeek:type:`bool`
+
+   Publishes an event to a node within a pool according to Round-Robin
+   distribution strategy.
+   
+
+   :param pool: the pool of nodes that are eligible to receive the event.
+   
+
+   :param key: an arbitrary string to identify the purpose for which you're
+        distributing the event.  e.g. consider using namespacing of your
+        script like "Intel::cluster_rr_key".
+   
+
+   :param args: Either the event arguments as already made by
+         :zeek:see:`Cluster::make_event` or the argument list to pass along
+         to it.
+   
+
+   :returns: true if the message is sent.
+
 

scripts/base/bif/index.rst

@@ -461,6 +461,9 @@ Package: base/bif
 :doc:`/scripts/base/bif/plugins/Zeek_XMPP.events.bif.zeek`
 
 
+:doc:`/scripts/base/bif/plugins/Zeek_Cluster_Backend_ZeroMQ.cluster_backend_zeromq.bif.zeek`
+
+
 :doc:`/scripts/base/bif/plugins/Zeek_ARP.events.bif.zeek`
 
 

scripts/base/bif/messaging.bif.zeek.rst

@@ -3,12 +3,11 @@
 base/bif/messaging.bif.zeek
 ===========================
 .. zeek:namespace:: Broker
-.. zeek:namespace:: Cluster
 .. zeek:namespace:: GLOBAL
 
 Functions for peering and various messaging patterns.
 
-:Namespaces: Broker, Cluster, GLOBAL
+:Namespaces: Broker, GLOBAL
 
 Summary
 ~~~~~~~
@@ -25,10 +24,6 @@ Functions
 :zeek:id:`Broker::make_event`: :zeek:type:`function`       Create a data structure that may be used to send a remote event via
                                                            :zeek:see:`Broker::publish`.
 :zeek:id:`Broker::publish`: :zeek:type:`function`          Publishes an event at a given topic.
-:zeek:id:`Cluster::publish_hrw`: :zeek:type:`function`     Publishes an event to a node within a pool according to Rendezvous
-                                                           (Highest Random Weight) hashing strategy.
-:zeek:id:`Cluster::publish_rr`: :zeek:type:`function`      Publishes an event to a node within a pool according to Round-Robin
-                                                           distribution strategy.
 ========================================================== ===================================================================
 
 
@@ -112,51 +107,4 @@ Functions
 
    :returns: true if the message is sent.
 
-.. zeek:id:: Cluster::publish_hrw
-   :source-code: base/bif/messaging.bif.zeek 94 94
-
-   :Type: :zeek:type:`function` (...) : :zeek:type:`bool`
-
-   Publishes an event to a node within a pool according to Rendezvous
-   (Highest Random Weight) hashing strategy.
-   
-
-   :param pool: the pool of nodes that are eligible to receive the event.
-   
-
-   :param key: data used for input to the hashing function that will uniformly
-        distribute keys among available nodes.
-   
-
-   :param args: Either the event arguments as already made by
-         :zeek:see:`Broker::make_event` or the argument list to pass along
-         to it.
-   
-
-   :returns: true if the message is sent.
-
-.. zeek:id:: Cluster::publish_rr
-   :source-code: base/bif/messaging.bif.zeek 77 77
-
-   :Type: :zeek:type:`function` (...) : :zeek:type:`bool`
-
-   Publishes an event to a node within a pool according to Round-Robin
-   distribution strategy.
-   
-
-   :param pool: the pool of nodes that are eligible to receive the event.
-   
-
-   :param key: an arbitrary string to identify the purpose for which you're
-        distributing the event.  e.g. consider using namespacing of your
-        script like "Intel::cluster_rr_key".
-   
-
-   :param args: Either the event arguments as already made by
-         :zeek:see:`Broker::make_event` or the argument list to pass along
-         to it.
-   
-
-   :returns: true if the message is sent.
-
 

scripts/base/bif/plugins/Zeek_Cluster_Backend_ZeroMQ.cluster_backend_zeromq.bif.zeek.rst

@@ -0,0 +1,29 @@
+:tocdepth: 3
+
+base/bif/plugins/Zeek_Cluster_Backend_ZeroMQ.cluster_backend_zeromq.bif.zeek
+============================================================================
+.. zeek:namespace:: GLOBAL
+
+
+:Namespace: GLOBAL
+
+Summary
+~~~~~~~
+Functions
+#########
+================================================================================== =
+:zeek:id:`Cluster::Backend::ZeroMQ::spawn_zmq_proxy_thread`: :zeek:type:`function` 
+================================================================================== =
+
+
+Detailed Interface
+~~~~~~~~~~~~~~~~~~
+Functions
+#########
+.. zeek:id:: Cluster::Backend::ZeroMQ::spawn_zmq_proxy_thread
+   :source-code: base/bif/plugins/Zeek_Cluster_Backend_ZeroMQ.cluster_backend_zeromq.bif.zeek 6 6
+
+   :Type: :zeek:type:`function` () : :zeek:type:`bool`
+
+
+