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

Copy docs into Zeek repo directly

Browse source 
This is based on commit 2731def9159247e6da8a3191783c89683363689c from the
zeek-docs repo.
This commit is contained in:
Tim Wojtulewicz 2025-09-15 15:52:18 -07:00
parent 83f1e74643
commit ded98cd373
1074 changed files with 169319 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

48
doc/scripts/base/bif/plugins/Zeek_WebSocket.functions.bif.zeek.rst Normal file
View file

@ -0,0 +1,48 @@
:tocdepth: 3
base/bif/plugins/Zeek_WebSocket.functions.bif.zeek
==================================================
.. zeek:namespace:: GLOBAL
.. zeek:namespace:: WebSocket
:Namespaces: GLOBAL, WebSocket
Summary
~~~~~~~
Functions
#########
================================================================= =================================
:zeek:id:`WebSocket::__configure_analyzer`: :zeek:type:`function` Configure the WebSocket analyzer.
================================================================= =================================
Detailed Interface
~~~~~~~~~~~~~~~~~~
Functions
#########
.. zeek:id:: WebSocket::__configure_analyzer
:source-code: base/bif/plugins/Zeek_WebSocket.functions.bif.zeek 24 24
:Type: :zeek:type:`function` (c: :zeek:type:`connection`, aid: :zeek:type:`count`, config: :zeek:type:`WebSocket::AnalyzerConfig`) : :zeek:type:`bool`
Configure the WebSocket analyzer.
Called during :zeek:see:`websocket_established` to configure
the WebSocket analyzer given the selected protocol and extension
as chosen by the server.
:param c: The WebSocket connection.
:param aid: The identifier for the WebSocket analyzer as provided to :zeek:see:`websocket_established`.
:param server_protocol: The protocol as found in the server's Sec-WebSocket-Protocol HTTP header, or empty.
:param server_extensions: The extension as selected by the server via the Sec-WebSocket-Extensions HTTP Header.
.. zeek:see:: websocket_established