zeek/doc/scripts/base/bif/plugins/Zeek_Cluster_WebSocket.events.bif.zeek.rst
Patrick Kelley 8fd444092b initial
2025-05-07 15:35:15 -04:00

49 lines
1.5 KiB
ReStructuredText

:tocdepth: 3
base/bif/plugins/Zeek_Cluster_WebSocket.events.bif.zeek
=======================================================
.. zeek:namespace:: Cluster
.. zeek:namespace:: GLOBAL
:Namespaces: Cluster, GLOBAL
Summary
~~~~~~~
Events
######
============================================================== ====================================================
:zeek:id:`Cluster::websocket_client_added`: :zeek:type:`event` Generated when a new WebSocket client has connected.
:zeek:id:`Cluster::websocket_client_lost`: :zeek:type:`event` Generated when a WebSocket client was lost.
============================================================== ====================================================
Detailed Interface
~~~~~~~~~~~~~~~~~~
Events
######
.. zeek:id:: Cluster::websocket_client_added
:source-code: base/frameworks/cluster/main.zeek 669 674
:Type: :zeek:type:`event` (endpoint: :zeek:type:`Cluster::EndpointInfo`, subscriptions: :zeek:type:`string_vec`)
Generated when a new WebSocket client has connected.
:param endpoint: Various information about the WebSocket client.
: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 676 681
:Type: :zeek:type:`event` (endpoint: :zeek:type:`Cluster::EndpointInfo`)
Generated when a WebSocket client was lost.
:param endpoint: Various information about the WebSocket client.