mirror of
https://github.com/zeek/zeek.git
synced 2025-10-03 07:08:19 +00:00
7e9d48f532
The broxygen-generated files now live in the git repo, have tests that check that they are up-to-date, and a script to re-generate them on-demand.
57 lines
1.7 KiB
ReStructuredText
57 lines
1.7 KiB
ReStructuredText
:tocdepth: 3
|
|
|
|
base/protocols/ftp/utils.bro
|
|
============================
|
|
.. bro:namespace:: FTP
|
|
|
|
Utilities specific for FTP processing.
|
|
|
|
:Namespace: FTP
|
|
:Imports: :doc:`base/protocols/ftp/info.bro </scripts/base/protocols/ftp/info.bro>`, :doc:`base/utils/addrs.bro </scripts/base/utils/addrs.bro>`, :doc:`base/utils/paths.bro </scripts/base/utils/paths.bro>`
|
|
|
|
Summary
|
|
~~~~~~~
|
|
Functions
|
|
#########
|
|
================================================== ===========================================================
|
|
:bro:id:`FTP::build_url`: :bro:type:`function` Creates a URL from an :bro:type:`FTP::Info` record.
|
|
:bro:id:`FTP::build_url_ftp`: :bro:type:`function` Creates a URL from an :bro:type:`FTP::Info` record.
|
|
:bro:id:`FTP::describe`: :bro:type:`function` Create an extremely shortened representation of a log line.
|
|
================================================== ===========================================================
|
|
|
|
|
|
Detailed Interface
|
|
~~~~~~~~~~~~~~~~~~
|
|
Functions
|
|
#########
|
|
.. bro:id:: FTP::build_url
|
|
|
|
:Type: :bro:type:`function` (rec: :bro:type:`FTP::Info`) : :bro:type:`string`
|
|
|
|
Creates a URL from an :bro:type:`FTP::Info` record.
|
|
|
|
|
|
:rec: An :bro:type:`FTP::Info` record.
|
|
|
|
|
|
:returns: A URL, not prefixed by ``"ftp://"``.
|
|
|
|
.. bro:id:: FTP::build_url_ftp
|
|
|
|
:Type: :bro:type:`function` (rec: :bro:type:`FTP::Info`) : :bro:type:`string`
|
|
|
|
Creates a URL from an :bro:type:`FTP::Info` record.
|
|
|
|
|
|
:rec: An :bro:type:`FTP::Info` record.
|
|
|
|
|
|
:returns: A URL prefixed with ``"ftp://"``.
|
|
|
|
.. bro:id:: FTP::describe
|
|
|
|
:Type: :bro:type:`function` (rec: :bro:type:`FTP::Info`) : :bro:type:`string`
|
|
|
|
Create an extremely shortened representation of a log line.
|
|
|
|
|