API Docs for: 0.8.0
Show:

MemoryEntityService Class

Defined in: include/service/memory_entity_service.js:24
Module: Storage
Parent Module: Services

Memory storage service

Item Index

Methods

Properties

Methods

_set

(
  • key
  • value
  • cb
)
private

Defined in include/service/memory_entity_service.js:183

Sets a value

Parameters:

  • key String
  • value Object | String | Integer | Float | Boolean
  • cb Function

createChangeHandler

() static

Defined in include/service/memory_entity_service.js:302

Creates a change handler that will update the value of a property when an incomming command requests it.

dispose

(
  • cb
)
static

Defined in include/service/memory_entity_service.js:353

Disposes of the storage and timers. It also terminates the reaping of expired keys.

Parameters:

  • cb Function

() String static

Defined in include/service/memory_entity_service.js:291

Retrieves the command type that is to be used to listen for changes to key/value pairs within the registered instance

Returns:

String:

The command type to be registered for

get

(
  • key
  • cb
)

Defined in include/service/memory_entity_service.js:110

Retrieve a value from memory

Parameters:

  • key String
  • cb Function

    Callback function

getCorrectValueField

(
  • rawVal
  • valueField
)
private static

Defined in include/service/memory_entity_service.js:146

Parameters:

  • rawVal Object
  • valueField Object

Returns:

:

getKey

(
  • key
  • site
  • objType
)
String static

Defined in include/service/memory_entity_service.js:278

Retrieves the internal key format for a given key

Parameters:

  • key String
  • site String
  • objType String

Returns:

String:

getSiteValue

(
  • self
  • internalKey
)
private static

Defined in include/service/memory_entity_service.js:124

Parameters:

  • self Object
  • internalKey Object

Returns:

:

onSet

(
  • key,
  • value
)

Defined in include/service/memory_entity_service.js:220

Called when when a value changes

Parameters:

  • key, String
  • value Object | String | Integer | Float | Boolean

purge

(
  • key
  • cb
)

Defined in include/service/memory_entity_service.js:261

Purge the key from memory

Parameters:

  • key String
  • cb Function

    Callback function

reap

() Number static

Defined in include/service/memory_entity_service.js:314

Searches for expired keys and removes them from memory

Returns:

Number:

The number of keys that were reaped

set

(
  • key
  • value
  • cb
)

Defined in include/service/memory_entity_service.js:165

Set a value in memory. Triggers a command to be sent to the cluster to update the value

Parameters:

  • key String
  • value
  • cb Function

    Callback function

setKeyExpiration

(
  • key
)

Defined in include/service/memory_entity_service.js:242

Sets a timeout to purge a key after the configured timeout has occurred. If a timeout has already been set it will be cleared and a new one will be created.

Parameters:

  • key String

    The key for the value to be cleared

startReaper

() Boolean static

Defined in include/service/memory_entity_service.js:335

Attempts to start the reaper that will remove expired keys from the in-memory cache

Returns:

Boolean:

TRUE if reaper is started, FALSE if it is already started

Properties

GLOBAL_SITE

String private static

Defined in include/service/memory_entity_service.js:59

TIMERS

Object private static

Defined in include/service/memory_entity_service.js:67

Object private static

Defined in include/service/memory_entity_service.js:75

Number private static

Defined in include/service/memory_entity_service.js:83

DEFAULT_REAPER_INTERVAL

Number private static

Defined in include/service/memory_entity_service.js:91

TYPE

String private static

Defined in include/service/memory_entity_service.js:100

The type string that describes the storage medium for the service