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

Class NodeCrawler

Hierarchy

NodeCrawlerBase
- NodeCrawler

Implements

NodeCrawlerEvents

Constructors

constructor

Properties

Constructors

constructor

new NodeCrawler(session: NodeCrawlerClientSession): NodeCrawler

Inherited from NodeCrawlerBase.constructor
- Defined in packages/node-opcua-client-crawler/source/node_crawler_base.ts:213
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

Methods

addListener

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

Inherited from UAStateVariable.addListener
- Defined in node_modules/@types/node/events.d.ts:62
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

Inherited from NodeCrawlerBase.crawl
- Defined in packages/node-opcua-client-crawler/source/node_crawler_base.ts:309
Parameters
- nodeId: NodeIdLike
- userData: UserData
Returns Promise<void>
Inherited from NodeCrawlerBase.crawl
- Defined in packages/node-opcua-client-crawler/source/node_crawler_base.ts:310
Parameters
- nodeId: NodeIdLike
- userData: UserData
- endCallback: ErrorCallback
Returns void

dispose

dispose(): void

Inherited from NodeCrawlerBase.dispose
- Defined in packages/node-opcua-client-crawler/source/node_crawler_base.ts:266
Returns void

emit

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

Inherited from UAStateVariable.emit
- Defined in node_modules/@types/node/events.d.ts:72
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from UAStateVariable.eventNames
- Defined in node_modules/@types/node/events.d.ts:77
Returns Array<string | symbol>

followReference

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

Inherited from NodeCrawlerBase.followReference
- Defined in packages/node-opcua-client-crawler/source/node_crawler_base.ts:444
Parameters
- parentNode: CacheNode
- reference: ReferenceDescription
- userData: UserData
Returns void

getMaxListeners

getMaxListeners(): number

Inherited from UAStateVariable.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:69
Returns number

listenerCount

listenerCount(event: string | symbol): number

Inherited from UAStateVariable.listenerCount
- Defined in node_modules/@types/node/events.d.ts:73
Parameters
- event: string | symbol
Returns number

listeners

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

Inherited from UAStateVariable.listeners
- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
Returns Function[]

off

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

Inherited from UAStateVariable.off
- Defined in node_modules/@types/node/events.d.ts:66
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 NonHierarchicalReferences.on
- Defined in node_modules/@types/node/events.d.ts:63
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 NonHierarchicalReferences.once
- Defined in node_modules/@types/node/events.d.ts:64
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 UAStateVariable.prependListener
- Defined in node_modules/@types/node/events.d.ts:75
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 UAStateVariable.prependOnceListener
- Defined in node_modules/@types/node/events.d.ts:76
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 UAStateVariable.rawListeners
- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
Returns Function[]

read

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

- Defined in packages/node-opcua-client-crawler/source/node_crawler.ts:22
Parameters
- nodeId: NodeIdLike
Returns Promise<any>
- Defined in packages/node-opcua-client-crawler/source/node_crawler.ts:23
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 UAStateVariable.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- Optional event: string | symbol
Returns this

removeListener

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

Inherited from UAStateVariable.removeListener
- Defined in node_modules/@types/node/events.d.ts:65
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from UAStateVariable.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- n: number
Returns this

toString

toString(): string

Inherited from NodeCrawlerBase.toString
- Defined in packages/node-opcua-client-crawler/source/node_crawler_base.ts:300
Returns string

Static follow

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

Inherited from NodeCrawlerBase.follow
- Defined in packages/node-opcua-client-crawler/source/node_crawler_base.ts:168
Parameters
- crawler: NodeCrawlerBase
- cacheNode: CacheNode
- userData: UserData
- Optional referenceType: string | UAReferenceType
- Optional browseDirection: BrowseDirection
Returns void

Generated using TypeDoc