Class NodeCrawler

subscribe now with sterfive to access the online-user manual

Hierarchy

NodeCrawlerBase
- NodeCrawler

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new NodeCrawler(session: NodeCrawlerClientSession): NodeCrawler

Inherited from NodeCrawlerBase.constructor
- Defined in node-opcua-client-crawler/dist/node_crawler_base.d.ts:57
Parameters
- session: NodeCrawlerClientSession
Returns NodeCrawler

Properties

browseCounter

browseCounter: number

browseNextCounter

browseNextCounter: number

maxNodesPerBrowse

maxNodesPerBrowse: number

maxNodesPerRead

maxNodesPerRead: number

readCounter

readCounter: number

startTime

startTime: Date

transactionCounter

transactionCounter: number

Methods

crawl

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

Inherited from NodeCrawlerBase.crawl
- Defined in node-opcua-client-crawler/dist/node_crawler_base.d.ts:60
Parameters
- nodeId: NodeIdLike
- userData: UserData
Returns Promise<void>
Inherited from NodeCrawlerBase.crawl
- Defined in node-opcua-client-crawler/dist/node_crawler_base.d.ts:61
Parameters
- nodeId: NodeIdLike
- userData: UserData
- endCallback: ErrorCallback
Returns void

dispose

dispose(): void

Inherited from NodeCrawlerBase.dispose
- Defined in node-opcua-client-crawler/dist/node_crawler_base.d.ts:58
Returns void

followReference

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

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

read

read(nodeId: NodeIdLike): Promise<Pojo>
read(nodeId: NodeIdLike, callback: (err: Error, obj?: Pojo) => void): void

- Defined in node-opcua-client-crawler/dist/node_crawler.d.ts:7
Parameters
- nodeId: NodeIdLike
Returns Promise<Pojo>
- Defined in node-opcua-client-crawler/dist/node_crawler.d.ts:8
Parameters
- nodeId: NodeIdLike
- callback: (err: Error, obj?: Pojo) => void
  - - (err: Error, obj?: Pojo): void
    - Parameters
      - err: Error
      - Optional obj: Pojo
      Returns void
Returns void

toString

toString(): string

Inherited from NodeCrawlerBase.toString
- Defined in node-opcua-client-crawler/dist/node_crawler_base.d.ts:59
Returns string

Static follow

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

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

Generated using TypeDoc