zeek/doc/scripts/base/bif/storage-async.bif.zeek.rst
Tim Wojtulewicz ded98cd373 Copy docs into Zeek repo directly
This is based on commit 2731def9159247e6da8a3191783c89683363689c from the
zeek-docs repo.
2025-09-26 02:58:29 +00:00

59 lines
2.1 KiB
ReStructuredText

:tocdepth: 3
base/bif/storage-async.bif.zeek
===============================
.. zeek:namespace:: GLOBAL
.. zeek:namespace:: Storage::Async
Functions related to asynchronous storage operations.
:Namespaces: GLOBAL, Storage::Async
Summary
~~~~~~~
Functions
#########
================================================================= =
:zeek:id:`Storage::Async::__close_backend`: :zeek:type:`function`
:zeek:id:`Storage::Async::__erase`: :zeek:type:`function`
:zeek:id:`Storage::Async::__get`: :zeek:type:`function`
:zeek:id:`Storage::Async::__open_backend`: :zeek:type:`function`
:zeek:id:`Storage::Async::__put`: :zeek:type:`function`
================================================================= =
Detailed Interface
~~~~~~~~~~~~~~~~~~
Functions
#########
.. zeek:id:: Storage::Async::__close_backend
:source-code: base/bif/storage-async.bif.zeek 14 14
:Type: :zeek:type:`function` (backend: :zeek:type:`opaque` of Storage::BackendHandle) : :zeek:type:`Storage::OperationResult`
.. zeek:id:: Storage::Async::__erase
:source-code: base/bif/storage-async.bif.zeek 23 23
:Type: :zeek:type:`function` (backend: :zeek:type:`opaque` of Storage::BackendHandle, key: :zeek:type:`any`) : :zeek:type:`Storage::OperationResult`
.. zeek:id:: Storage::Async::__get
:source-code: base/bif/storage-async.bif.zeek 20 20
:Type: :zeek:type:`function` (backend: :zeek:type:`opaque` of Storage::BackendHandle, key: :zeek:type:`any`) : :zeek:type:`Storage::OperationResult`
.. zeek:id:: Storage::Async::__open_backend
:source-code: base/bif/storage-async.bif.zeek 11 11
:Type: :zeek:type:`function` (btype: :zeek:type:`Storage::Backend`, options: :zeek:type:`any`, key_type: :zeek:type:`any`, val_type: :zeek:type:`any`) : :zeek:type:`Storage::OperationResult`
.. zeek:id:: Storage::Async::__put
:source-code: base/bif/storage-async.bif.zeek 17 17
:Type: :zeek:type:`function` (backend: :zeek:type:`opaque` of Storage::BackendHandle, key: :zeek:type:`any`, value: :zeek:type:`any`, overwrite: :zeek:type:`bool`, expire_time: :zeek:type:`interval`) : :zeek:type:`Storage::OperationResult`