API Docs for: 0.8.0
Show:

ServerRegistration Class

Defined in: include/system/server_registration.js:37
Module: Session

Service that provides the ability for the process/node to register itself so that other nodes in the system can find it. In addition, it helps with the health monitoring of the system.

Constructor

ServerRegistration

()

Defined in include/system/server_registration.js:37

Item Index

Methods

Properties

Methods

addItem

(
  • name
  • The
)
Boolean static

Defined in include/system/server_registration.js:192

Registers a function to be called on every status update. The function should take one parameter: a callback function that accepts two parameters, the first being an error if it occurred and the second being the current value for the information requested.

Parameters:

  • name String

    The name and/or description of the information being gathered

  • The Function

    function to be called to gather the data.

Returns:

Boolean:

TRUE if the function is successfully registered, FALSE if not.

doRegistration

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

Defined in include/system/server_registration.js:213

Performs the request for information and persists it through the storage provider.

Parameters:

  • [cb] A callback that provides two parameters: cb(Error, [RESULT] Function optional

    )

flush

(
  • cb
)
static

Defined in include/system/server_registration.js:132

Removes all entries from the server registry

Parameters:

  • cb Function

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

generateKey

() String static

Defined in include/system/server_registration.js:277

Generates the unique key for the PB process/node.

Returns:

String:

The unique identifier

generateServerKey

() String static

Defined in include/system/server_registration.js:287

Retrieves a unique key for the server but not for the process

Returns:

String:

server key

getClusterStatus

(
  • cb
)

Defined in include/system/server_registration.js:123

Retrieves the most recent status from the entire cluster.

Parameters:

  • cb Function

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

getInstance

(
  • [provider]
)
ServerRegistration static

Defined in include/system/server_registration.js:318

Retrieves the singleton instance of the service registry

Parameters:

  • [provider] RegistrationProvider optional

Returns:

ServerRegistration:

getIp

() String static

Defined in include/system/server_registration.js:297

Retrieves the first IP address found for the node.

Returns:

String:

The first IP address found for the node

init

(
  • cb
)
static

Defined in include/system/server_registration.js:142

Should only be called once at startup. The function verifies that the registry is enabled and initializes the correct storage provider.

Parameters:

  • cb Function

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

logUpdateResult

(
  • key
  • update
  • err
  • result
)
static

Defined in include/system/server_registration.js:257

Parameters:

  • key String
  • update Object
  • err Error
  • result Boolean

shutdown

(
  • cb
)
static

Defined in include/system/server_registration.js:174

Called during shutdown. The function is responsible for clearing any scheduled updates and shutting down the storage provider.

Parameters:

  • cb Function

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

Properties

INSTANCE

ServerRegistration private static

Defined in include/system/server_registration.js:28

Singleton instance

ITEM_CALLBACKS

Object private

Defined in include/system/server_registration.js:52

The default set of functions that gather the default set of information.