mirror of
https://github.com/zeek/zeek.git
synced 2025-10-03 15:18:20 +00:00

This is based on commit 2731def9159247e6da8a3191783c89683363689c from the zeek-docs repo.
57 lines
2.3 KiB
ReStructuredText
57 lines
2.3 KiB
ReStructuredText
:tocdepth: 3
|
|
|
|
base/utils/conn-ids.zeek
|
|
========================
|
|
.. zeek:namespace:: GLOBAL
|
|
|
|
Simple functions for generating ASCII strings from connection IDs.
|
|
|
|
:Namespace: GLOBAL
|
|
|
|
Summary
|
|
~~~~~~~
|
|
Functions
|
|
#########
|
|
==================================================== ===================================================================
|
|
:zeek:id:`directed_id_string`: :zeek:type:`function` Calls :zeek:id:`id_string` or :zeek:id:`reverse_id_string` if the
|
|
second argument is T or F, respectively.
|
|
:zeek:id:`id_string`: :zeek:type:`function` Takes a conn_id record and returns a string representation with the
|
|
general data flow appearing to be from the connection originator
|
|
on the left to the responder on the right.
|
|
:zeek:id:`reverse_id_string`: :zeek:type:`function` Takes a conn_id record and returns a string representation with the
|
|
general data flow appearing to be from the connection responder
|
|
on the right to the originator on the left.
|
|
==================================================== ===================================================================
|
|
|
|
|
|
Detailed Interface
|
|
~~~~~~~~~~~~~~~~~~
|
|
Functions
|
|
#########
|
|
.. zeek:id:: directed_id_string
|
|
:source-code: base/utils/conn-ids.zeek 39 42
|
|
|
|
:Type: :zeek:type:`function` (id: :zeek:type:`conn_id`, is_orig: :zeek:type:`bool`) : :zeek:type:`string`
|
|
|
|
Calls :zeek:id:`id_string` or :zeek:id:`reverse_id_string` if the
|
|
second argument is T or F, respectively.
|
|
|
|
.. zeek:id:: id_string
|
|
:source-code: base/utils/conn-ids.zeek 25 30
|
|
|
|
:Type: :zeek:type:`function` (id: :zeek:type:`conn_id`) : :zeek:type:`string`
|
|
|
|
Takes a conn_id record and returns a string representation with the
|
|
general data flow appearing to be from the connection originator
|
|
on the left to the responder on the right.
|
|
|
|
.. zeek:id:: reverse_id_string
|
|
:source-code: base/utils/conn-ids.zeek 32 37
|
|
|
|
:Type: :zeek:type:`function` (id: :zeek:type:`conn_id`) : :zeek:type:`string`
|
|
|
|
Takes a conn_id record and returns a string representation with the
|
|
general data flow appearing to be from the connection responder
|
|
on the right to the originator on the left.
|
|
|
|
|