node-zk-treecache

TODO Desc module (in ConnectionState)

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Object literals

DEFAULT_ACL_PROVIDER

Type aliases

ConnectionStateListener

ConnectionStateListener: function

Type declaration

- (client: CuratorFramework, state: ConnectionState.CONNECTED | ConnectionState.SUSPENDED | ConnectionState.RECONNECTED | ConnectionState.LOST | ConnectionState.READ_ONLY): void
- Parameters
  - client: CuratorFramework
  - state: ConnectionState.CONNECTED | ConnectionState.SUSPENDED | ConnectionState.RECONNECTED | ConnectionState.LOST | ConnectionState.READ_ONLY
  Returns void

CuratorEvent

CuratorEvent: GetDataCuratorEvent | GetChildrenCuratorEvent | ExistsCuratorEvent

TreeCacheListener

TreeCacheListener: function

Type declaration

- (client: CuratorFramework, event: TreeCacheEvent): void
- Parameters
  - client: CuratorFramework
  - event: TreeCacheEvent
  Returns void

UnhandledErrorListener

UnhandledErrorListener: function

Type declaration

- (message: string, error: Error): void
- Parameters
  - message: string
  - error: Error
  Returns void

Variables

ANYONE_ID_UNSAFE

ANYONE_ID_UNSAFE: Id = new Id("world", "anyone")

OPEN_ACL_UNSAFE

OPEN_ACL_UNSAFE: ACL[] = [new ACL(31, ANYONE_ID_UNSAFE)]

PATH_SEPARATOR

PATH_SEPARATOR: "/" = "/"

Functions

EMPTY_CALLBACK

EMPTY_CALLBACK(): void

- Defined in ZkPaths.ts:12
Returns void

Private checkNotNull

checkNotNull<T>(ref: T, message: string): T

- Defined in Utils.ts:9
Type parameters
- T
Parameters
- ref: T
- message: string
Returns T

compareChildData

compareChildData(cd1: ChildData, cd2: ChildData): boolean

- Defined in TreeCache.ts:41
Parameters
- cd1: ChildData
- cd2: ChildData
Returns boolean

consoleLogger

consoleLogger(id: number, console: ConsoleLike): object

- Defined in TreeCacheBuilder.ts:23
Parameters
- id: number
- console: ConsoleLike
Returns object
- id: number
- debug: function
  - debug(msg: string, ...args: any[]): void
  - - Defined in TreeCacheBuilder.ts:25
    Parameters
    - msg: string
    - Rest ...args: any[]
    Returns void
- error: function
  - error(msg: string, ...args: any[]): void
  - - Defined in TreeCacheBuilder.ts:34
    Parameters
    - msg: string
    - Rest ...args: any[]
    Returns void
- info: function
  - info(msg: string, ...args: any[]): void
  - - Defined in TreeCacheBuilder.ts:28
    Parameters
    - msg: string
    - Rest ...args: any[]
    Returns void
- warn: function
  - warn(msg: string, ...args: any[]): void
  - - Defined in TreeCacheBuilder.ts:31
    Parameters
    - msg: string
    - Rest ...args: any[]
    Returns void

createExistsCuratorEvent

createExistsCuratorEvent(path: string, stat: Stat | null, returnCode: ZooKeeperCode.OK | ZooKeeperCode.SYSTEMERROR | ZooKeeperCode.RUNTIMEINCONSISTENCY | ZooKeeperCode.DATAINCONSISTENCY | ZooKeeperCode.CONNECTIONLOSS | ZooKeeperCode.MARSHALLINGERROR | ZooKeeperCode.UNIMPLEMENTED | ZooKeeperCode.OPERATIONTIMEOUT | ZooKeeperCode.BADARGUMENTS | ZooKeeperCode.NEWCONFIGNOQUORUM | ZooKeeperCode.RECONFIGINPROGRESS | ZooKeeperCode.UNKNOWNSESSION | ZooKeeperCode.APIERROR | ZooKeeperCode.NONODE | ZooKeeperCode.NOAUTH | ZooKeeperCode.BADVERSION | ZooKeeperCode.NOCHILDRENFOREPHEMERALS | ZooKeeperCode.NODEEXISTS | ZooKeeperCode.NOTEMPTY | ZooKeeperCode.SESSIONEXPIRED | ZooKeeperCode.INVALIDCALLBACK | ZooKeeperCode.INVALIDACL | ZooKeeperCode.AUTHFAILED | ZooKeeperCode.SESSIONMOVED | ZooKeeperCode.NOTREADONLY | ZooKeeperCode.EPHEMERALONLOCALSESSION | ZooKeeperCode.NOWATCHER | ZooKeeperCode.RECONFIGDISABLED): ExistsCuratorEvent

- Defined in CuratorEvent.ts:196
Parameters
- path: string
- stat: Stat | null
- returnCode: ZooKeeperCode.OK | ZooKeeperCode.SYSTEMERROR | ZooKeeperCode.RUNTIMEINCONSISTENCY | ZooKeeperCode.DATAINCONSISTENCY | ZooKeeperCode.CONNECTIONLOSS | ZooKeeperCode.MARSHALLINGERROR | ZooKeeperCode.UNIMPLEMENTED | ZooKeeperCode.OPERATIONTIMEOUT | ZooKeeperCode.BADARGUMENTS | ZooKeeperCode.NEWCONFIGNOQUORUM | ZooKeeperCode.RECONFIGINPROGRESS | ZooKeeperCode.UNKNOWNSESSION | ZooKeeperCode.APIERROR | ZooKeeperCode.NONODE | ZooKeeperCode.NOAUTH | ZooKeeperCode.BADVERSION | ZooKeeperCode.NOCHILDRENFOREPHEMERALS | ZooKeeperCode.NODEEXISTS | ZooKeeperCode.NOTEMPTY | ZooKeeperCode.SESSIONEXPIRED | ZooKeeperCode.INVALIDCALLBACK | ZooKeeperCode.INVALIDACL | ZooKeeperCode.AUTHFAILED | ZooKeeperCode.SESSIONMOVED | ZooKeeperCode.NOTREADONLY | ZooKeeperCode.EPHEMERALONLOCALSESSION | ZooKeeperCode.NOWATCHER | ZooKeeperCode.RECONFIGDISABLED
Returns ExistsCuratorEvent

Private createGetChildrenCuratorEvent

createGetChildrenCuratorEvent(path: string, stat: Stat | undefined, children: string[] | undefined, returnCode: ZooKeeperCode.OK | ZooKeeperCode.SYSTEMERROR | ZooKeeperCode.RUNTIMEINCONSISTENCY | ZooKeeperCode.DATAINCONSISTENCY | ZooKeeperCode.CONNECTIONLOSS | ZooKeeperCode.MARSHALLINGERROR | ZooKeeperCode.UNIMPLEMENTED | ZooKeeperCode.OPERATIONTIMEOUT | ZooKeeperCode.BADARGUMENTS | ZooKeeperCode.NEWCONFIGNOQUORUM | ZooKeeperCode.RECONFIGINPROGRESS | ZooKeeperCode.UNKNOWNSESSION | ZooKeeperCode.APIERROR | ZooKeeperCode.NONODE | ZooKeeperCode.NOAUTH | ZooKeeperCode.BADVERSION | ZooKeeperCode.NOCHILDRENFOREPHEMERALS | ZooKeeperCode.NODEEXISTS | ZooKeeperCode.NOTEMPTY | ZooKeeperCode.SESSIONEXPIRED | ZooKeeperCode.INVALIDCALLBACK | ZooKeeperCode.INVALIDACL | ZooKeeperCode.AUTHFAILED | ZooKeeperCode.SESSIONMOVED | ZooKeeperCode.NOTREADONLY | ZooKeeperCode.EPHEMERALONLOCALSESSION | ZooKeeperCode.NOWATCHER | ZooKeeperCode.RECONFIGDISABLED): GetChildrenCuratorEvent

- Defined in CuratorEvent.ts:181
Parameters
- path: string
- stat: Stat | undefined
- children: string[] | undefined
- returnCode: ZooKeeperCode.OK | ZooKeeperCode.SYSTEMERROR | ZooKeeperCode.RUNTIMEINCONSISTENCY | ZooKeeperCode.DATAINCONSISTENCY | ZooKeeperCode.CONNECTIONLOSS | ZooKeeperCode.MARSHALLINGERROR | ZooKeeperCode.UNIMPLEMENTED | ZooKeeperCode.OPERATIONTIMEOUT | ZooKeeperCode.BADARGUMENTS | ZooKeeperCode.NEWCONFIGNOQUORUM | ZooKeeperCode.RECONFIGINPROGRESS | ZooKeeperCode.UNKNOWNSESSION | ZooKeeperCode.APIERROR | ZooKeeperCode.NONODE | ZooKeeperCode.NOAUTH | ZooKeeperCode.BADVERSION | ZooKeeperCode.NOCHILDRENFOREPHEMERALS | ZooKeeperCode.NODEEXISTS | ZooKeeperCode.NOTEMPTY | ZooKeeperCode.SESSIONEXPIRED | ZooKeeperCode.INVALIDCALLBACK | ZooKeeperCode.INVALIDACL | ZooKeeperCode.AUTHFAILED | ZooKeeperCode.SESSIONMOVED | ZooKeeperCode.NOTREADONLY | ZooKeeperCode.EPHEMERALONLOCALSESSION | ZooKeeperCode.NOWATCHER | ZooKeeperCode.RECONFIGDISABLED
Returns GetChildrenCuratorEvent

Private createGetDataCuratorEvent

createGetDataCuratorEvent(path: string, stat: Stat | undefined, data: Buffer | undefined, returnCode: ZooKeeperCode.OK | ZooKeeperCode.SYSTEMERROR | ZooKeeperCode.RUNTIMEINCONSISTENCY | ZooKeeperCode.DATAINCONSISTENCY | ZooKeeperCode.CONNECTIONLOSS | ZooKeeperCode.MARSHALLINGERROR | ZooKeeperCode.UNIMPLEMENTED | ZooKeeperCode.OPERATIONTIMEOUT | ZooKeeperCode.BADARGUMENTS | ZooKeeperCode.NEWCONFIGNOQUORUM | ZooKeeperCode.RECONFIGINPROGRESS | ZooKeeperCode.UNKNOWNSESSION | ZooKeeperCode.APIERROR | ZooKeeperCode.NONODE | ZooKeeperCode.NOAUTH | ZooKeeperCode.BADVERSION | ZooKeeperCode.NOCHILDRENFOREPHEMERALS | ZooKeeperCode.NODEEXISTS | ZooKeeperCode.NOTEMPTY | ZooKeeperCode.SESSIONEXPIRED | ZooKeeperCode.INVALIDCALLBACK | ZooKeeperCode.INVALIDACL | ZooKeeperCode.AUTHFAILED | ZooKeeperCode.SESSIONMOVED | ZooKeeperCode.NOTREADONLY | ZooKeeperCode.EPHEMERALONLOCALSESSION | ZooKeeperCode.NOWATCHER | ZooKeeperCode.RECONFIGDISABLED): GetDataCuratorEvent

- Defined in CuratorEvent.ts:158
Parameters
- path: string
- stat: Stat | undefined
- data: Buffer | undefined
- returnCode: ZooKeeperCode.OK | ZooKeeperCode.SYSTEMERROR | ZooKeeperCode.RUNTIMEINCONSISTENCY | ZooKeeperCode.DATAINCONSISTENCY | ZooKeeperCode.CONNECTIONLOSS | ZooKeeperCode.MARSHALLINGERROR | ZooKeeperCode.UNIMPLEMENTED | ZooKeeperCode.OPERATIONTIMEOUT | ZooKeeperCode.BADARGUMENTS | ZooKeeperCode.NEWCONFIGNOQUORUM | ZooKeeperCode.RECONFIGINPROGRESS | ZooKeeperCode.UNKNOWNSESSION | ZooKeeperCode.APIERROR | ZooKeeperCode.NONODE | ZooKeeperCode.NOAUTH | ZooKeeperCode.BADVERSION | ZooKeeperCode.NOCHILDRENFOREPHEMERALS | ZooKeeperCode.NODEEXISTS | ZooKeeperCode.NOTEMPTY | ZooKeeperCode.SESSIONEXPIRED | ZooKeeperCode.INVALIDCALLBACK | ZooKeeperCode.INVALIDACL | ZooKeeperCode.AUTHFAILED | ZooKeeperCode.SESSIONMOVED | ZooKeeperCode.NOTREADONLY | ZooKeeperCode.EPHEMERALONLOCALSESSION | ZooKeeperCode.NOWATCHER | ZooKeeperCode.RECONFIGDISABLED
Returns GetDataCuratorEvent

createWatcher

createWatcher(w: ZooKeeperWatcher): function

- Defined in Builders.ts:57
Parameters
- w: ZooKeeperWatcher
Returns function
- - (e: Event): void
  - Parameters
    - e: Event
    Returns void

getCreateMode

getCreateMode(asContainers: boolean): number

- Defined in ZkPaths.ts:40
Parameters
- asContainers: boolean
Returns number

Private getNodeFromPath

getNodeFromPath(path: string): string

- Defined in ZkPaths.ts:90
Given a full path, return the node name. i.e. "/one/two/three" will return "three"

Parameters
- path: string
  
  the path
Returns string

the node

Private isConnected

isConnected(cs: ConnectionState.CONNECTED | ConnectionState.SUSPENDED | ConnectionState.RECONNECTED | ConnectionState.LOST | ConnectionState.READ_ONLY): boolean

- Defined in ConnectionState.ts:64
Check if this state indicates that Curator has a connection to ZooKeeper

Parameters
- cs: ConnectionState.CONNECTED | ConnectionState.SUSPENDED | ConnectionState.RECONNECTED | ConnectionState.LOST | ConnectionState.READ_ONLY
Returns boolean

True if connected, false otherwise

makePath

makePath(parent: string, child: string): string

- Defined in ZkPaths.ts:108
Given a parent path and a child node, create a combined full path

Parameters
- parent: string
  
  the parent
- child: string
  
  the child
Returns string

full path

Private mkdirs

mkdirs(zkClient: Client, path: string, makeLastNode: boolean, aclProvider: ACLProvider | null, asContainers: boolean, cb?: undefined | function): void

- Defined in ZkPaths.ts:56
Make sure all the nodes in the path are created. NOTE: Unlike File.mkdirs(), Zookeeper doesn't distinguish between directories and files. So, every node in the path is created. The data for each node is an empty blob

Parameters
- zkClient: Client
  
  the client
- path: string
  
  path to ensure
- makeLastNode: boolean
  
  if true, all nodes are created. If false, only the parent nodes are created
- aclProvider: ACLProvider | null
  
  if not null, the ACL provider to use when creating parent nodes
- asContainers: boolean
  
  if true, nodes are created as {@link CreateMode#CONTAINER} (need ZK > 3.5)
- Optional cb: undefined | function
  
  the callback to call after having created the path
Returns void

newCuratorFramework

newCuratorFramework(zkClient: Client): CuratorFramework

- Defined in CuratorFramework.ts:53
Parameters
- zkClient: Client
Returns CuratorFramework

normalizeZooKeeperEvent

normalizeZooKeeperEvent(e: Event): ZooKeeperEvent

- Defined in Builders.ts:39
Parameters
- e: Event
Returns ZooKeeperEvent

Private split

split(path: string): string[]

- Defined in ZkPaths.ts:28
Parameters
- path: string
  
  the path to split
Returns string[]

treeCacheBuilder

treeCacheBuilder(client: Client, path: string): TreeCacheBuilder

- Defined in node-zk-treecache.ts:16
Parameters
- client: Client
- path: string
Returns TreeCacheBuilder

validatePath

validatePath(path: string): string

- Defined in PathUtils.ts:14
Validate the provided znode path string

throws

Error if the path is invalid

Parameters
- path: string
  
  znode path string
Returns string

The given path if it was valid, for fluent chaining

Object literals

DEFAULT_ACL_PROVIDER

DEFAULT_ACL_PROVIDER: object

getAclForPath

getAclForPath(): null

- Defined in ZkPaths.ts:19
Returns null

getDefaultAcl

getDefaultAcl(): null

- Defined in ZkPaths.ts:16
Returns null

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

ConnectionStateListener

Type declaration

Parameters

client: CuratorFramework

state: ConnectionState.CONNECTED | ConnectionState.SUSPENDED | ConnectionState.RECONNECTED | ConnectionState.LOST | ConnectionState.READ_ONLY

Returns void

CuratorEvent

TreeCacheListener

Type declaration

Parameters

client: CuratorFramework

event: TreeCacheEvent

Returns void

UnhandledErrorListener

Type declaration

Parameters

message: string

error: Error

Returns void

Variables

ANYONE_ID_UNSAFE

OPEN_ACL_UNSAFE

PATH_SEPARATOR

Functions

EMPTY_CALLBACK

Returns void

Private checkNotNull

Type parameters

T

Parameters

ref: T

message: string

Returns T

compareChildData

Parameters

cd1: ChildData

cd2: ChildData

Returns boolean

consoleLogger

Parameters

id: number

console: ConsoleLike

Returns object

id: number

debug: function

Parameters

msg: string

Rest ...args: any[]

Returns void

error: function

Parameters

msg: string

Rest ...args: any[]

Returns void

info: function

Parameters

msg: string

Rest ...args: any[]

Returns void

warn: function

Parameters

msg: string

Rest ...args: any[]

Returns void

createExistsCuratorEvent

Parameters

path: string

stat: Stat | null

Returns ExistsCuratorEvent

Private createGetChildrenCuratorEvent

Parameters