lmcache.experimental.storage_backend.connector package#

Submodules#

lmcache.experimental.storage_backend.connector.base_connector module#

class lmcache.experimental.storage_backend.connector.base_connector.RemoteConnector[source]#

Interface for remote connector

abstract async close()[source]#: Close remote server

abstract async exists(key: CacheEngineKey) → bool[source]#

Check if the remote server contains the key

Input:: key: a string

Returns:: True if the cache engine contains the key, False otherwise

abstract async get(key: CacheEngineKey) → MemoryObj | None[source]#

Get the memory_obj of the corresponding key

Input:: key: the key of the corresponding object

Returns:: The memory_obj of the corresponding key Return None if the key does not exist

abstract async list() → List[str][source]#

List all keys in the remote server

Returns:: A list of keys in the remote server

abstract async put(key: CacheEngineKey, memory_obj: MemoryObj)[source]#

Send the memory_obj with the corresponding key directly to the remote server. Will decrease the ref count after send finishes.

Input:: key: the CacheEngine key memory_obj: the memory_obj of the corresponding key

lmcache.experimental.storage_backend.connector.infinistore_connector module#

class lmcache.experimental.storage_backend.connector.infinistore_connector.InfinistoreConnector(host: str, port: int, dev_name, loop: AbstractEventLoop, memory_allocator: MemoryAllocatorInterface)[source]#

Bases: RemoteConnector

async close()[source]#: Close remote server

async exists(key: CacheEngineKey) → bool[source]#

Check if the remote server contains the key

Input:: key: a string

Returns:: True if the cache engine contains the key, False otherwise

async get(key: CacheEngineKey) → MemoryObj | None[source]#

Get the memory_obj of the corresponding key

Input:: key: the key of the corresponding object

Returns:: The memory_obj of the corresponding key Return None if the key does not exist

async list() → List[str][source]#

List all keys in the remote server

Returns:: A list of keys in the remote server

async put(key: CacheEngineKey, memory_obj: MemoryObj)[source]#

Send the memory_obj with the corresponding key directly to the remote server. Will decrease the ref count after send finishes.

Input:: key: the CacheEngine key memory_obj: the memory_obj of the corresponding key

lmcache.experimental.storage_backend.connector.lm_connector module#

class lmcache.experimental.storage_backend.connector.lm_connector.LMCServerConnector(host: str, port: int, loop: AbstractEventLoop, memory_allocator: MemoryAllocatorInterface)[source]#

Bases: RemoteConnector

async close()[source]#: Close remote server

async exists(key: CacheEngineKey) → bool[source]#

Check if the remote server contains the key

Input:: key: a string

Returns:: True if the cache engine contains the key, False otherwise

get(key: CacheEngineKey) → MemoryObj | None[source]#

Get the memory_obj of the corresponding key

Input:: key: the key of the corresponding object

Returns:: The memory_obj of the corresponding key Return None if the key does not exist

async list() → List[str][source]#

List all keys in the remote server

Returns:: A list of keys in the remote server

async put(key: CacheEngineKey, memory_obj: MemoryObj)[source]#

Send the memory_obj with the corresponding key directly to the remote server. Will decrease the ref count after send finishes.

Input:: key: the CacheEngine key memory_obj: the memory_obj of the corresponding key

receive_all(meta: ServerMetaMessage) → MemoryObj | None[source]#

lmcache.experimental.storage_backend.connector.redis_connector module#

class lmcache.experimental.storage_backend.connector.redis_connector.RedisConnector(host: str, port: int, loop: AbstractEventLoop, memory_allocator: MemoryAllocatorInterface)[source]#

Bases: RemoteConnector

The remote url should start with “redis://” and only have one host-port pair

async close()[source]#: Close remote server

async exists(key: CacheEngineKey) → bool[source]#

Check if the remote server contains the key

Input:: key: a string

Returns:: True if the cache engine contains the key, False otherwise

async get(key: CacheEngineKey) → MemoryObj | None[source]#

Get the memory_obj of the corresponding key

Input:: key: the key of the corresponding object

Returns:: The memory_obj of the corresponding key Return None if the key does not exist

async list() → List[str][source]#

List all keys in the remote server

Returns:: A list of keys in the remote server

async put(key: CacheEngineKey, memory_obj: MemoryObj)[source]#

Send the memory_obj with the corresponding key directly to the remote server. Will decrease the ref count after send finishes.

Input:: key: the CacheEngine key memory_obj: the memory_obj of the corresponding key

class lmcache.experimental.storage_backend.connector.redis_connector.RedisSentinelConnector(hosts_and_ports: List[Tuple[str, str | int]], loop: AbstractEventLoop, memory_allocator: MemoryAllocatorInterface)[source]#

Bases: RemoteConnector

Uses redis.Sentinel to connect to a Redis cluster. The hosts are specified in the config file, started with “redis-sentinel://” and separated by commas.

Example

remote_url: “redis-sentinel://localhost:26379,localhost:26380,localhost:26381”

Extra environment variables: - REDIS_SERVICE_NAME (required) – service name for redis. - REDIS_TIMEOUT (optional) – Timeout in seconds, default is 1 if not set

ENV_REDIS_SERVICE_NAME = 'REDIS_SERVICE_NAME'#

ENV_REDIS_TIMEOUT = 'REDIS_TIMEOUT'#

async close()[source]#: Close remote server

async exists(key: CacheEngineKey) → bool[source]#

Check if the remote server contains the key

Input:: key: a string

Returns:: True if the cache engine contains the key, False otherwise

async get(key: CacheEngineKey) → MemoryObj | None[source]#

Get the memory_obj of the corresponding key

Input:: key: the key of the corresponding object

Returns:: The memory_obj of the corresponding key Return None if the key does not exist

async list() → List[str][source]#

List all keys in the remote server

Returns:: A list of keys in the remote server

async put(key: CacheEngineKey, memory_obj: MemoryObj)[source]#

Send the memory_obj with the corresponding key directly to the remote server. Will decrease the ref count after send finishes.

Input:: key: the CacheEngine key memory_obj: the memory_obj of the corresponding key

Module contents#

lmcache.experimental.storage_backend.connector.CreateConnector(url: str, loop: AbstractEventLoop, memory_allocator: MemoryAllocatorInterface) → RemoteConnector[source]#: Creates the corresponding remote connector from the given URL.

class lmcache.experimental.storage_backend.connector.ParsedRemoteURL(connector_type: str, hosts: List[str], ports: List[int], paths: List[str], query_params: List[Dict[str, str]])[source]#

The parsed URL of the format: <connector_type>://<host>:<port>[/path][?query],<host2>:<port2>[/path2][?query2],…

connector_type: str#

hosts: List[str]#

paths: List[str]#

ports: List[int]#

query_params: List[Dict[str, str]]#

lmcache.experimental.storage_backend.connector.parse_remote_url(url: str) → ParsedRemoteURL[source]#

Parses the remote URL into its constituent parts with support for: - Multiple hosts (comma-separated) - Path and query parameters in each host definition - Forward compatibility with legacy format

Raises:: ValueError – If the URL is invalid.