⚠️ You are reading documentation for an OLD version (v2.0.0). The current released version is v2.173.1. View latest documentation →

Class NodeCrawler

class: NodeCrawler
param
constructor

Hierarchy

EventEmitter
- NodeCrawler

Implements

NodeCrawlerEvents

Index

Constructors

constructor

Properties

Constructors

constructor

new NodeCrawler(session: NodeCrawlerClientSession): NodeCrawler

- Defined in node-opcua-client-crawler/source/node_crawler.ts:409
Parameters
- session: NodeCrawlerClientSession
Returns NodeCrawler

Properties

browseCounter

browseCounter: number = 0

browseNextCounter

browseNextCounter: number = 0

maxNodesPerBrowse

maxNodesPerBrowse: number = 0

maxNodesPerRead

maxNodesPerRead: number = 0

readCounter

readCounter: number = 0

startTime

startTime: Date = new Date()

transactionCounter

transactionCounter: number = 0

Static defaultMaxListeners

defaultMaxListeners: number

Methods

_add_crawl_task

_add_crawl_task(cacheNode: CacheNode, userData: any): void

- Defined in node-opcua-client-crawler/source/node_crawler.ts:654
Parameters
- cacheNode: CacheNode
- userData: any
Returns void

Private _inner_crawl

_inner_crawl(nodeId: NodeId, userData: UserData, endCallback: ErrorCallback): void

- Defined in node-opcua-client-crawler/source/node_crawler.ts:556
Parameters
- nodeId: NodeId
- userData: UserData
- endCallback: ErrorCallback
Returns void

addListener

addListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:11
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

crawl

crawl(nodeId: NodeIdLike, userData: UserData): Promise<void>
crawl(nodeId: NodeIdLike, userData: UserData, endCallback: ErrorCallback): void

- Defined in node-opcua-client-crawler/source/node_crawler.ts:484
Parameters
- nodeId: NodeIdLike
- userData: UserData
Returns Promise<void>
- Defined in node-opcua-client-crawler/source/node_crawler.ts:485
Parameters
- nodeId: NodeIdLike
- userData: UserData
- endCallback: ErrorCallback
Returns void

dispose

dispose(): void

- Defined in node-opcua-client-crawler/source/node_crawler.ts:463
Returns void

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:23
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:24
Returns Array<string | symbol>

followReference

followReference(parentNode: CacheNode, reference: ReferenceDescription, userData: UserData): void

- Defined in node-opcua-client-crawler/source/node_crawler.ts:679
Parameters
- parentNode: CacheNode
- reference: ReferenceDescription
- userData: UserData
Returns void

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:20
Returns number

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:25
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:21
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: function): this

Inherited from EventEmitter.off

Overrides EventEmitter.off
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:17
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: string | symbol, listener: function): this

Inherited from EventEmitter.on

Overrides EventEmitter.on
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:12
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

once(event: string | symbol, listener: function): this

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:13
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependListener

prependListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:14
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:15
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from EventEmitter.rawListeners

Overrides EventEmitter.rawListeners
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:22
Parameters
- event: string | symbol
Returns Function[]

read

read(nodeId: NodeIdLike): Promise<any>
read(nodeId: NodeIdLike, callback: function): void

- Defined in node-opcua-client-crawler/source/node_crawler.ts:504
Parameters
- nodeId: NodeIdLike
Returns Promise<any>
- Defined in node-opcua-client-crawler/source/node_crawler.ts:505
Parameters
- nodeId: NodeIdLike
- callback: function
  - - (err: Error | null, obj?: any): void
    - Parameters
      - err: Error | null
      - Optional obj: any
      Returns void
Returns void

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:18
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:16
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:19
Parameters
- n: number
Returns this

toString

toString(): string

- Defined in node-opcua-client-crawler/source/node_crawler.ts:478
Returns string

Static follow

follow(crawler: NodeCrawler, cacheNode: CacheNode, userData: UserData, referenceType?: string | UAReferenceType, browseDirection?: BrowseDirection): void

- Defined in node-opcua-client-crawler/source/node_crawler.ts:362
Parameters
- crawler: NodeCrawler
- cacheNode: CacheNode
- userData: UserData
- Optional referenceType: string | UAReferenceType
- Optional browseDirection: BrowseDirection
Returns void

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:8
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Generated using TypeDoc