API Docs for: 0.8.0
Show:

RedisRegistrationProvider Class

Defined in: include/system/registry/redis_registration_provider.js:24
Module: Session

Implements the necessary functions in order to be able to create and manage a service registry for PB processes in the cluster. This provider uses Redis as the storage. In addition, it leverages Redis's expiry functionality to expire entries automatically if they have not been touched. In order to retrieve all nodes/processes in the cluster the provider must execute Redis's "keys" function which is an expensive operation. To lessen the impact on production systems the provider creates and manages its own Redis client and switches to DB 2 in order to minimize the number of keys that need to be scanned since the rest of the PB system leverages DB 0.

Constructor

RedisRegistrationProvider

()

Defined in include/system/registry/redis_registration_provider.js:24

Item Index

Methods

Properties

Methods

flush

(
  • cb
)

Defined in include/system/registry/redis_registration_provider.js:122

Purges all statuses from storage.

Parameters:

  • cb Function

    A callback that provides two parameters: cb(Error, [RESULT])

get

(
  • cb
)

Defined in include/system/registry/redis_registration_provider.js:70

Retrieves the entire cluster status as an array of status objects. The '_id' property uniquely identifies each process/node.

Parameters:

  • cb Function

    A callback that provides two parameters: cb(Error, Array)

getKey

(
  • id
)
String static

Defined in include/system/registry/redis_registration_provider.js:169

Creates the cache key used to store the status update

Parameters:

  • id String

    The unique identifier for the node/process

Returns:

String:

The cache key to be used for storing the update

getPattern

() String static

Defined in include/system/registry/redis_registration_provider.js:180

Creates the glob pattern to be used to find service registry keys

Returns:

String:

The glob patern to be used to find all status updates

init

(
  • cb
)

Defined in include/system/registry/redis_registration_provider.js:139

This function should only be called once at startup. It is responsible for creating the Redis client that connects to the service registry. It also ensures the proper Redis DB is selected.

Parameters:

  • cb Function

    A callback that takes two parameters. cb(Error, [RESULT])

set

(
  • id
  • status
  • cb
)

Defined in include/system/registry/redis_registration_provider.js:104

Updates the status of a single node.

Parameters:

  • id String

    The unique identifier for the process/node

  • status Object

    The status information

  • cb Function

    A callback that provides two parameters: cb(Error, [RESULT])

shutdown

(
  • id
  • cb
)

Defined in include/system/registry/redis_registration_provider.js:152

Should be called during shutdown. It is responsible for removing the process/node from the registry.

Parameters:

  • id String

    The unique identifier for the node/process

  • cb Function

    A callback that takes two parameters: cb(Error, [RESULT])

Properties

CLIENT

Integer private static

Defined in include/system/registry/redis_registration_provider.js:60

The Redis client used to connect to the service registry

REGISTRY_DB

Integer private static

Defined in include/system/registry/redis_registration_provider.js:39

The Redis DB used for storage

SEP

String private static

Defined in include/system/registry/redis_registration_provider.js:49

The character used to separate the registry key prefix from the unique value that identifies the process/node.