1. class
  2. Relay
  3. \
  4. Table

Table

class Table

Relay Table is a persistent hash table shared across workers that can store arbitrary data.

Methods

static mixed
get(string $key, string|null $namespace = null)

Returns a key's value, or null if key doesn't exist.

static array|false
getWithMeta(mixed $key, string|null $namespace = null)

Get the value and metadata of key.

static bool
set(string $key, mixed $value, int|null $expire = null, string|null $namespace = null)

Sets a key and its value.

static bool
exists(string $key, string|null $namespace = null)

Checks if a key exists in the table.

static bool
delete(string $key, string|null $namespace = null)

Remove a key from the table.

static int|false
ttl(string $key, string|null $namespace = null)

Returns the remaining time to live of a key that has a timeout, or false if the key doesn't exist or has no timeout.

static int|false
count(string|null $namespace = null)

Returns the number of keys stored in the table.

static bool
clear(string|null $namespace = null)

Removes all keys from the table.

static array|false
keys(mixed $pattern, string|null $namespace = null)

Returns all keys matching pattern.

static int|false
memory(string|null $namespace = null)

Returns the number of bytes allocated for all elements.

static array|false
namespaces()

Returns all table namespaces.

static int|false
clearAll()

Removes all keys from all namespaces.

static Generator|false
fullscan(mixed $match = null, int $count = 0)

Scan the keyspace for matching keys on each namespace.

static array|false
stats()

Returns statistics about Table.

Details

at line 4968
static mixed get(string $key, string|null $namespace = null)

Returns a key's value, or null if key doesn't exist.

Parameters

string $key
string|null $namespace

Return Value

mixed

at line 4977
static array|false getWithMeta(mixed $key, string|null $namespace = null)

Get the value and metadata of key.

Parameters

mixed $key
string|null $namespace

Return Value

array|false

at line 4988
static bool set(string $key, mixed $value, int|null $expire = null, string|null $namespace = null)

Sets a key and its value.

Parameters

string $key
mixed $value
int|null $expire
string|null $namespace

Return Value

bool

at line 4997
static bool exists(string $key, string|null $namespace = null)

Checks if a key exists in the table.

Parameters

string $key
string|null $namespace

Return Value

bool

at line 5006
static bool delete(string $key, string|null $namespace = null)

Remove a key from the table.

Parameters

string $key
string|null $namespace

Return Value

bool

at line 5016
static int|false ttl(string $key, string|null $namespace = null)

Returns the remaining time to live of a key that has a timeout, or false if the key doesn't exist or has no timeout.

Parameters

string $key
string|null $namespace

Return Value

int|false

at line 5024
static int|false count(string|null $namespace = null)

Returns the number of keys stored in the table.

Parameters

string|null $namespace

Return Value

int|false

at line 5032
static bool clear(string|null $namespace = null)

Removes all keys from the table.

Parameters

string|null $namespace

Return Value

bool

at line 5041
static array|false keys(mixed $pattern, string|null $namespace = null)

Returns all keys matching pattern.

Parameters

mixed $pattern
string|null $namespace

Return Value

array|false

at line 5049
static int|false memory(string|null $namespace = null)

Returns the number of bytes allocated for all elements.

Parameters

string|null $namespace

Return Value

int|false

at line 5056
static array|false namespaces()

Returns all table namespaces.

Return Value

array|false

at line 5063
static int|false clearAll()

Removes all keys from all namespaces.

Return Value

int|false

at line 5072
static Generator|false fullscan(mixed $match = null, int $count = 0)

Scan the keyspace for matching keys on each namespace.

Parameters

mixed $match
int $count

Return Value

Generator|false

at line 5079
static array|false stats()

Returns statistics about Table.

Return Value

array|false