Class radex::redis::smartredis::Client¶

ClassList > radex > redis > smartredis > Client

RaDex client backed by a SmartRedis (Redis) connection.

#include <smartredis.hpp>

Inherits the following classes: radex::IClient

Public Functions¶

Type	Name
	Client () Connect using configuration read from the environment.
	Client (std::string_view logger_name)
	Client (const Client & other) = delete
	Client (Client && other) = default
virtual bool	contains (std::string_view key) override
virtual radex::detail::BytesBuffer	get_bytes (std::string_view key) override
Client &	operator= (const Client & other) = delete
Client &	operator= (Client && other) = default
virtual void	put_bytes (std::string_view key, const void * bytes, detail::MetaInt length) override Store raw bytes under `key` , overwriting any existing value.
virtual radex::detail::BytesBuffer	wait_for_bytes (std::string_view key, std::chrono::milliseconds timeout) override
	~Client () = default

Public Functions inherited from radex::IClient¶

See radex::IClient

Type	Name
virtual bool	contains (std::string_view key) = 0
void	delete_item (const data::OutgoingHandle & handle) Delete a typed value and its associated metadata.
virtual detail::BytesBuffer	get_bytes (std::string_view key) = 0
std::unique_ptr< detail::ItemInfo >	get_item_info_ptr (const data::IncomingHandle & handle)
std::enable_if< data::is_supported_type< T >::value, T >::type	get_scalar (const data::IncomingHandle handle)
std::enable_if< data::is_supported_type< T >::value, TensorInfo< T > >::type	get_tensor (const data::IncomingHandle & handle)
virtual void	put_bytes (std::string_view key, const void * bytes, detail::MetaInt length) = 0 Store raw bytes under `key` , overwriting any existing value.
std::enable_if< data::is_supported_type< T >::value, void >::type	put_scalar (const data::OutgoingHandle & handle, const T & value)
std::enable_if< data::is_supported_type< T >::value, void >::type	put_tensor (const data::OutgoingHandle & handle, const std::vector< detail::MetaInt > & dims, const std::vector< T > & data)
std::enable_if< data::is_supported_type< T >::value, void >::type	put_tensor (const data::OutgoingHandle & handle, const detail::MetaInt * dims, detail::MetaInt n_dims, const T * elements, detail::MetaInt n_elements)
virtual detail::BytesBuffer	wait_for_bytes (std::string_view key, std::chrono::milliseconds timeout) = 0
std::unique_ptr< detail::ItemInfo >	wait_for_item_info_ptr (const data::IncomingHandle & handle, std::chrono::milliseconds timeout)
std::enable_if< data::is_supported_type< T >::value, T >::type	wait_for_scalar (const data::IncomingHandle handle, std::chrono::milliseconds timeout)
std::enable_if< data::is_supported_type< T >::value, TensorInfo< T > >::type	wait_for_tensor (const data::IncomingHandle & handle, std::chrono::milliseconds timeout)
virtual	~IClient ()

Public Functions Documentation¶

function Client [⅖]¶

Connect using configuration read from the environment.

radex::redis::smartredis::Client::Client ()

function Client [⅗]¶

radex::redis::smartredis::Client::Client (
    std::string_view logger_name
)

Parameters:

logger_name Name used to tag log messages from this client.

function Client [⅘]¶

radex::redis::smartredis::Client::Client (
    const Client & other
) = delete

function Client [5/5]¶

radex::redis::smartredis::Client::Client (
    Client && other
) = default

function contains¶

virtual bool radex::redis::smartredis::Client::contains (
    std::string_view key
) override

Returns:

True if key exists in the backing store.

Implements radex::IClient::contains

function get_bytes¶

virtual radex::detail::BytesBuffer radex::redis::smartredis::Client::get_bytes (
    std::string_view key
) override

Returns:

The raw bytes previously stored under key.

Implements radex::IClient::get_bytes

function operator=¶

Client & radex::redis::smartredis::Client::operator= (
    const Client & other
) = delete

function operator=¶

Client & radex::redis::smartredis::Client::operator= (
    Client && other
) = default

function put_bytes¶

Store raw bytes under key , overwriting any existing value.

virtual void radex::redis::smartredis::Client::put_bytes (
    std::string_view key,
    const void * bytes,
    detail::MetaInt length
) override

Implements radex::IClient::put_bytes

function wait_for_bytes¶

virtual radex::detail::BytesBuffer radex::redis::smartredis::Client::wait_for_bytes (
    std::string_view key,
    std::chrono::milliseconds timeout
) override

Block until key becomes available, then return its raw bytes.

Parameters:

timeout Maximum time to wait for the key to appear.

Implements radex::IClient::wait_for_bytes

function ~Client¶

radex::redis::smartredis::Client::~Client () = default

The documentation for this class was generated from the following file include/radex/smartredis.hpp