KVStore

Properties

server

private Main $server

log

private Logger $log

config

Configuration for the KV Store component.

private array $config

kvStore

private array $kvStore

kvExpire

private array $kvExpire

db

public BTree $db

compactTime

private int $compactTime

lastCompact

private int $lastCompact

Methods

__construct

KVStore constructor.

public __construct(Main $server, array $config): void

Parameters

Parameter	Type	Description
$server	Main	the server instance
$config	array	configuration for the KV Store component

enablePersistentStorage

public enablePersistentStorage(int $compactTime = 3600): bool

Parameters

Parameter	Type	Description
$compactTime	int

disablePersistentStorage

public disablePersistentStorage(): void

expireKeys

public expireKeys(): void

touch

public touch(string $namespace, string $key): void

Parameters

Parameter	Type	Description
$namespace	string
$key	string

process

public process(Client $client, PacketType $command, mixed $payload): void

Parameters

Parameter	Type	Description
$client	Client
$command	PacketType
$payload	mixed

get

public get(Client $client, mixed $payload, string $namespace): void

Parameters

Parameter	Type	Description
$client	Client
$payload	mixed
$namespace	string

set

public set(Client $client, mixed $payload, string $namespace): void

Parameters

Parameter	Type	Description
$client	Client
$payload	mixed
$namespace	string

has

public has(Client $client, \stdClass $payload, string $namespace): void

Parameters

Parameter	Type	Description
$client	Client
$payload	\stdClass
$namespace	string

del

public del(Client $client, \stdClass $payload, string $namespace): void

Parameters

Parameter	Type	Description
$client	Client
$payload	\stdClass
$namespace	string

public (Client $client, \stdClass $payload, string $namespace): void

Parameters

Parameter	Type	Description
$client	Client
$payload	\stdClass
$namespace	string

clear

public clear(Client $client, \stdClass $payload, string $namespace): void

Parameters

Parameter	Type	Description
$client	Client
$payload	\stdClass
$namespace	string

pull

public pull(Client $client, \stdClass $payload, string $namespace): void

Parameters

Parameter	Type	Description
$client	Client
$payload	\stdClass
$namespace	string

push

public push(Client $client, \stdClass $payload, string $namespace): void

Parameters

Parameter	Type	Description
$client	Client
$payload	\stdClass
$namespace	string

pop

public pop(Client $client, \stdClass $payload, string $namespace): void

Parameters

Parameter	Type	Description
$client	Client
$payload	\stdClass
$namespace	string

shift

public shift(Client $client, \stdClass $payload, string $namespace): void

Parameters

Parameter	Type	Description
$client	Client
$payload	\stdClass
$namespace	string

unshift

public unshift(Client $client, \stdClass $payload, string $namespace): void

Parameters

Parameter	Type	Description
$client	Client
$payload	\stdClass
$namespace	string

count

public count(Client $client, \stdClass $payload, string $namespace): void

Parameters

Parameter	Type	Description
$client	Client
$payload	\stdClass
$namespace	string

incr

public incr(Client $client, \stdClass $payload, string $namespace): void

Parameters

Parameter	Type	Description
$client	Client
$payload	\stdClass
$namespace	string

decr

public decr(Client $client, \stdClass $payload, string $namespace): void

Parameters

Parameter	Type	Description
$client	Client
$payload	\stdClass
$namespace	string

keys

public keys(Client $client, \stdClass $payload, string $namespace): void

Parameters

Parameter	Type	Description
$client	Client
$payload	\stdClass
$namespace	string

values

public values(Client $client, \stdClass $payload, string $namespace): void

Parameters

Parameter	Type	Description
$client	Client
$payload	\stdClass
$namespace	string

---

Generated by Hazaar API Doc Generator on Wed, 25 Jun 2025 06:07:11 +0000