##! The storage framework provides a way to store long-term data to disk.

module Storage;

export {
	## Base record for backend options that can be passed to
	## :zeek:see:`Storage::Async::open_backend` and
	## :zeek:see:`Storage::Sync::open_backend`. Backend plugins can redef this record
	## to add relevant fields to it.
	type BackendOptions: record {
		## The serializer used for converting Zeek data.
		serializer: Storage::Serializer &default=Storage::STORAGE_SERIALIZER_JSON;

		## Timeout for connection attempts to the backend. Connection attempts
		## that exceed this time should return
		## :zeek:see:`Storage::CONNECTION_FAILED`. Not all backends will support
		## setting timeouts.
		connect_timeout: interval &default=5 sec;

		## Timeout for operation requests sent to the backend. Operations that
		## exceed this time should return :zeek:see:`Storage::TIMEOUT`. Not all
		## backends will support setting timeouts.
		operation_timeout: interval &default=5 sec;
	};

	## Record for passing arguments to :zeek:see:`Storage::Async::put` and
	## :zeek:see:`Storage::Sync::put`.
	type PutArgs: record {
		## The key to store the value under.
		key: any;

		## The value to store associated with the key.
		value: any;

		## Indicates whether this value should overwrite an existing entry for the
		## key.
		overwrite: bool &default=T;

		## An interval of time until the entry is automatically removed from the
		## backend.
		expire_time: interval &default=0sec;
	};
}