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

Lay out initial parts for the Storage framework

Browse source 
This includes a manager, component manager, BIF and script code, and
parts to support new storage backend plugins.
This commit is contained in:
Tim Wojtulewicz 2023-09-11 12:21:58 -07:00
parent 3d6e7c85b0
commit 2ea0f3e70a
32 changed files with 874 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

1
scripts/base/frameworks/storage/__load__.zeek Normal file
View file

@ -0,0 +1 @@
@load ./main

85
scripts/base/frameworks/storage/main.zeek Normal file
View file

@ -0,0 +1,85 @@
##! The storage framework provides a way to store long-term data to disk.
@load base/bif/storage.bif
module Storage;
export {
## Opens a new backend connection based on a configuration object.
##
## btype: A tag indicating what type of backend should be opened.
##
## options: A record containing the configuration for the connection.
##
## Returns: A handle to the new backend connection, or null if the
## connection failed.
global open_backend: function(btype: Storage::Backend, options: any): opaque of Storage::BackendHandle;
## Closes an existing backend connection.
##
## backend: A handle to a backend connection.
##
## Returns: A boolean indicating success or failure of the operation.
global close_backend: function(backend: opaque of Storage::BackendHandle): bool;
## Inserts a new entry into a backend.
##
## backend: A handle to a backend connection.
##
## key: A key value.
##
## value: A corresponding value.
##
## overwrite: A flag indicating whether this value should overwrite an
## existing entry for the key.
##
## Returns: A boolean indicating success or failure of the operation.
global put: function(backend: opaque of Storage::BackendHandle, key: any, value: any, overwrite: bool): bool;
## Gets an entry from the backend.
##
## backend: A handle to a backend connection.
##
## key: The key to look up.
##
## val_type: The type of the value to return.
##
## Returns: A boolean indicating success or failure of the
## operation. Type conversion failures for the value will
## return false.
global get: function(backend: opaque of Storage::BackendHandle, key: any, val_type: any): any;
## Erases an entry from the backend.
##
## backend: A handle to a backend connection.
##
## key: The key to erase.
##
## Returns: A boolean indicating success or failure of the operation.
global erase: function(backend: opaque of Storage::BackendHandle, key: any): bool;
}
function open_backend(btype: Storage::Backend, options: any): opaque of Storage::BackendHandle
{
return Storage::__open_backend(btype, options);
}
function close_backend(backend: opaque of Storage::BackendHandle): bool
{
return Storage::__close_backend(backend);
}
function put(backend: opaque of Storage::BackendHandle, key: any, value: any, overwrite: bool): bool
{
return Storage::__put(backend, key, value, overwrite);
}
function get(backend: opaque of Storage::BackendHandle, key: any, val_type: any): any
{
return Storage::__get(backend, key, val_type);
}
function erase(backend: opaque of Storage::BackendHandle, key: any): bool
{
return Storage::__erase(backend, key);
}