Node.js Client API

version 2.0

Cache

Cache methods facilitate interaction with the servers. A Cache object is used to instantiate and get a Region.

Cache
Instance Members
close()
createRegion(regionName, configuration)
executeFunction(functionName, options)
executeQueryOnDefaultPool(queryString)
getPoolManager()
getRegion(regionName)
rootRegions()

CacheFactory

This is a top level object for configuring GemFire on a client. Use CacheFactory.create() to create a Cache object.

CacheFactory
Instance Members
create()
set(gemfireProperty, value)
setAuthentication(propertiesCallback, closeCallback)
setPdxIgnoreUnreadFields(ignore)

gemfire

The gemfire nodejs module provides the global entry point into the GemFire API. To make use of the API, an application must create a gemfire object by using require("gemfire").

gemfire
Instance Members
createCacheFactory()
createCacheFactory(systemPropertiesFile, clientXmlFile)

Pool

A Pool object represents a set of connections between the client and a set of servers.

Pool
Instance Members
destroy(keepAlive)
executeFunction(functionName, target, args?)
getFreeConnectionTimeout()
getIdleTimeout()
getLoadConditioningInterval()
getLocators()
getMaxConnections()
getMinConnections()
getMultiuserAuthentication()
getName()
getPingInterval()
getPRSingleHopEnabled()
getReadTimeout()
getRetryAttempts()
getServerGroup()
getServers()
getSocketBufferSize()
getStatisticInterval()
getSubscriptionAckInterval()
getSubscriptionEnabled()
getSubscriptionMessageTrackingTimeout()
getSubscriptionRedundancy()
getThreadLocalConnections()
getUpdateLocatorListInterval()
isDestroyed()
releaseThreadLocalConnection()

PoolFactory

Facilitates the configuration and creation of a Pool object.

Default values used when creating a Pool:

Property Type Default
FreeConnectionTimeout number (milliseconds) 10000
IdleTimeout number (milliseconds) 5000
LoadConditioningInterval number (milliseconds) 300000
MaxConnections number -1 (unlimited)
MinConnections number 1
MultiuserAuthentication boolean false
PingInterval number (milliseconds) 10000
PRSingleHopEnabled boolean true
ReadTimeout number (milliseconds) 10000
RetryAttempts number -1 (unlimited)
ServerGroup string '' (all servers)
SocketBufferSize number 32768
StatisticInterval number (milliseconds) 0 (disabled)
SubscriptionAckInterval number (milliseconds) 100
SubscriptionEnabled boolean true
SubscriptionMessageTrackingTimeout number (milliseconds) 900000
SubscriptionRedundancy number 0
ThreadLocalConnections boolean false
UpdateLocatorListInterval number (milliseconds) 5000
PoolFactory
Instance Members
addLocator(locatorAddress, locatorPort)
addServer(serverAddress, serverPort)
create(poolName)
setFreeConnectionTimeout(milliseconds)
setIdleTimeout(milliseconds)
setLoadConditioningInterval(milliseconds)
setMaxConnections(connections)
setMinConnections(connections)
setMultiuserAuthentication(multiuserAuth)
setPingInterval(milliseconds)
setPRSingleHopEnabled(enabled)
setReadTimeout(milliseconds)
setRetryAttempts(retries)
setServerGroup(serverGroupName)
setSocketBufferSize(size)
setStatisticInterval(milliseconds)
setSubscriptionAckInterval(milliseconds)
setSubscriptionEnabled(enabled)
setSubscriptionMessageTrackingTimeout(milliseconds)
setSubscriptionRedundancy(level)
setThreadLocalConnections(enabled)
setUpdateLocatorListInterval(milliseconds)

PoolManager

Manages creation and access to pools for a client. PoolManager is used to create a PoolFactory.

PoolManager
Instance Members
createFactory()
find(poolName)

Region

A region is a collection of key-value pair entries.

Region
Instance Members
attributes()
clear()
destroyRegion()
entries()
executeFunction(functionName, options?)
existsValue(query)
get(key)
getAll(keyArray)
keys()
localDestroyRegion()
name()
on(eventType, eventHandler)
put(key, value)
putAll(keyObject)
query(queryString, query)
registerAllKeys()
remove(key)
selectValue(queryString)
serverKeys()
unregisterAllKeys()
values()