MemcachedCache

Implements: ICache, IConfigurable, IReferenceable, IOpenable

Description

The MemcachedCache class allows you to create distributed cache that stores values in Memcached’s caching service.

Important points

• The current implementation does not support authentication.

Configuration parameters

• connection(s):
  • discovery_key: (optional) key to retrieve the connection from IDiscovery
  • host: host name or IP address
  • port: port number
  • uri: resource URI or connection string with all parameters in it
• options:
  • max_size: maximum number of values stored in this cache (default: 1000)
  • max_key_size: maximum key length (default: 250)
  • max_expiration: maximum expiration duration in milliseconds (default: 2592000)
  • max_value: maximum value length (default: 1048576)
  • pool_size: pool size (default: 5)
  • reconnect: reconnection timeout in milliseconds (default: 10 sec)
  • retries: number of retries (default: 3)
  • timeout: default caching timeout in milliseconds (default: 1 minute)
  • failures: number of failures before stop retrying (default: 5)
  • retry: retry timeout in milliseconds (default: 30 sec)
  • idle: idle timeout before disconnect in milliseconds (default: 5 sec)

References

• *:discovery:*:*:1.0 - (optional) IDiscovery services to resolve connection

Instance methods

close

Closes a component and frees used resources.

public close(correlationId: string): Promise<void>

• correlationId: string - (optional) transaction id used to trace execution through the call chain.

configure

Configures a component by passing its configuration parameters.

public configure(config: ConfigParams): void

• config: ConfigParams - configuration parameters to be set.

isOpen

Checks if the component is open.

public isOpen(): boolean

• returns: boolean - true if the component has been opened and false otherwise.

open

Opens the component.

public open(correlationId: string): Promise<void>

• correlationId: string - (optional) transaction id used to trace execution through the call chain.

remove

Removes a value from the cache by its key.

public remove(correlationId: string, key: string): Promise<any>

• correlationId: string - (optional) transaction id used to trace execution through the call chain.
• key: string - unique value key.
• return: Promise<any> - deleted value.

retrieve

Retrieves a cached value from the cache using its key. If the value is missing in the cache or expired, it returns null.

public retrieve(correlationId: string, key: string): Promise<any>

• correlationId: string - (optional) transaction id used to trace execution through the call chain.
• key: string - unique value key.
• return: Promise<any> - cached value or null if nothing was found.

setReferences

Sets references to dependent components.

public setReferences(references: IReferences): void

• references: IReferences - references to locate the component’s dependencies.

store

Stores a value in the cache with an expiration time.

public store(correlationId: string, key: string, value: any, timeout: number): Promise<any>

• correlationId: string - (optional) transaction id used to trace execution through the call chain.
• key: string - unique value key.
• value: any - value to store.
• timeout: number - expiration timeout in milliseconds.
• returns: Promise<any> - stored value

Examples

let cache = new MemcachedCache();
cache.configure(ConfigParams.fromTuples(
  "host", "localhost",
  "port", 11211
));

await cache.open("123");
await cache.store("123", "key1", "ABC");
let value = await cache.store("123", "key1"); // Result: "ABC"