ClientSessionImpl | node-opcua-client

class: ClientSession
param
constructor

Hierarchy

EventEmitter
- ClientSessionImpl

Implements

ClientSession

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ClientSessionImpl(client: any): ClientSessionImpl

- Defined in node-opcua-client/source/private/client_session_impl.ts:327
Parameters
- client: any
Returns ClientSessionImpl

Properties

_client

_client: any

_closeEventHasBeenEmitted

_closeEventHasBeenEmitted: boolean

_closed

_closed: boolean

Optional authenticationToken

authenticationToken: NodeId

lastRequestSentTime

lastRequestSentTime: Date

lastResponseReceivedTime

lastResponseReceivedTime: Date

name

name: string = ""

requestedMaxReferencesPerNode

requestedMaxReferencesPerNode: number

serverCertificate

serverCertificate: Certificate

serverEndpoints

serverEndpoints: any[] = []

Optional serverNonce

serverNonce: Nonce

Optional serverSignature

serverSignature: SignatureData

sessionId

sessionId: NodeId

timeout

timeout: number

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

endpoint

get endpoint(): EndpointDescription

- Defined in node-opcua-client/source/private/client_session_impl.ts:353
the endpoint on which this session is operating

property

endpoint

type

{EndpointDescription}

Returns EndpointDescription

isReconnecting

get isReconnecting(): any

- Defined in node-opcua-client/source/private/client_session_impl.ts:361
Returns any

subscriptionCount

get subscriptionCount(): number

- Defined in node-opcua-client/source/private/client_session_impl.ts:357
Returns number

Methods

_callMethodCondition

_callMethodCondition(methodName: string, conditionId: NodeIdLike, eventId: Buffer, comment: LocalizedTextLike, callback: function): void

- Defined in node-opcua-client/source/private/client_session_impl.ts:2019
Parameters
- methodName: string
- conditionId: NodeIdLike
- eventId: Buffer
- comment: LocalizedTextLike
- callback: function
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

_terminatePublishEngine

_terminatePublishEngine(): void

- Defined in node-opcua-client/source/private/client_session_impl.ts:1564
Returns void

acknowledgeCondition

acknowledgeCondition(conditionId: NodeId, eventId: Buffer, comment: LocalizedTextLike, callback?: ErrorCallback): any

Implementation of ClientSession.acknowledgeCondition
- Defined in node-opcua-client/source/private/client_session_impl.ts:2004
Parameters
- conditionId: NodeId
- eventId: Buffer
- comment: LocalizedTextLike
- Optional callback: ErrorCallback
Returns any

addCommentCondition

addCommentCondition(conditionId: NodeIdLike, eventId: Buffer, comment: LocalizedTextLike, callback?: ErrorCallback): any

Implementation of ClientSession.addCommentCondition
- Defined in node-opcua-client/source/private/client_session_impl.ts:1988
Parameters
- conditionId: NodeIdLike
- eventId: Buffer
- comment: LocalizedTextLike
- Optional callback: ErrorCallback
Returns any

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

browse

browse(nodeToBrowse: BrowseDescriptionLike, callback: ResponseCallback<BrowseResult>): void
browse(nodesToBrowse: BrowseDescriptionLike[], callback: ResponseCallback<BrowseResult[]>): void
browse(nodeToBrowse: BrowseDescriptionLike): Promise<BrowseResult>
browse(nodesToBrowse: BrowseDescriptionLike[]): Promise<BrowseResult[]>

method

browse

async

example

   session.browse("RootFolder",function(err,browseResult) {
     if(err) return callback(err);
     console.log(browseResult.toString());
     callback();
   } );

example

   const browseDescription = {
      nodeId: "ObjectsFolder",
      referenceTypeId: "Organizes",
      browseDirection: BrowseDirection.Inverse,
      includeSubtypes: true,
      nodeClassMask: 0,
      resultMask: 63
   }
   session.browse(browseDescription,function(err, browseResult) {
      if(err) return callback(err);
      console.log(browseResult.toString());
      callback();
   });

example

session.browse([ "RootFolder", "ObjectsFolder"],function(err, browseResults) {
      assert(browseResults.length === 2);
});

example

const browseDescriptions = [
{
  nodeId: "ObjectsFolder",
  referenceTypeId: "Organizes",
  browseDirection: BrowseDirection.Inverse,
  includeSubtypes: true,
  nodeClassMask: 0,
  resultMask: 63
},
// {...}
]
 session.browse(browseDescriptions,function(err, browseResults) {

  });

Parameters

nodeToBrowse: BrowseDescriptionLike
callback: ResponseCallback<BrowseResult>

Returns void

Implementation of ClientSession.browse
- Defined in node-opcua-client/source/private/client_session_impl.ts:436
Parameters
- nodesToBrowse: BrowseDescriptionLike[]
- callback: ResponseCallback<BrowseResult[]>
Returns void
Implementation of ClientSession.browse
- Defined in node-opcua-client/source/private/client_session_impl.ts:438
Parameters
- nodeToBrowse: BrowseDescriptionLike
Returns Promise<BrowseResult>
Implementation of ClientSession.browse
- Defined in node-opcua-client/source/private/client_session_impl.ts:440
Parameters
- nodesToBrowse: BrowseDescriptionLike[]
Returns Promise<BrowseResult[]>

browseNext

browseNext(continuationPoint: Buffer, releaseContinuationPoints: boolean, callback: ResponseCallback<BrowseResult>): void
browseNext(continuationPoints: Buffer[], releaseContinuationPoints: boolean, callback: ResponseCallback<BrowseResult[]>): void
browseNext(continuationPoint: Buffer, releaseContinuationPoints: boolean): Promise<BrowseResult>
browseNext(continuationPoints: Buffer[], releaseContinuationPoints: boolean): Promise<BrowseResult[]>

Implementation of ClientSession.browseNext
- Defined in node-opcua-client/source/private/client_session_impl.ts:512
Parameters
- continuationPoint: Buffer
- releaseContinuationPoints: boolean
- callback: ResponseCallback<BrowseResult>
Returns void
Implementation of ClientSession.browseNext
- Defined in node-opcua-client/source/private/client_session_impl.ts:517
Parameters
- continuationPoints: Buffer[]
- releaseContinuationPoints: boolean
- callback: ResponseCallback<BrowseResult[]>
Returns void
Implementation of ClientSession.browseNext
- Defined in node-opcua-client/source/private/client_session_impl.ts:522
Parameters
- continuationPoint: Buffer
- releaseContinuationPoints: boolean
Returns Promise<BrowseResult>
Implementation of ClientSession.browseNext
- Defined in node-opcua-client/source/private/client_session_impl.ts:527
Parameters
- continuationPoints: Buffer[]
- releaseContinuationPoints: boolean
Returns Promise<BrowseResult[]>

call

call(methodToCall: CallMethodRequestLike): Promise<CallMethodResult>
call(methodToCall: CallMethodRequestLike[]): Promise<CallMethodResult[]>
call(methodToCall: CallMethodRequestLike, callback: ResponseCallback<CallMethodResult>): void
call(methodsToCall: CallMethodRequestLike[], callback: ResponseCallback<CallMethodResult[]>): void

Implementation of ClientSession.call
- Defined in node-opcua-client/source/private/client_session_impl.ts:1619
Parameters
- methodToCall: CallMethodRequestLike
Returns Promise<CallMethodResult>
Implementation of ClientSession.call
- Defined in node-opcua-client/source/private/client_session_impl.ts:1621
Parameters
- methodToCall: CallMethodRequestLike[]
Returns Promise<CallMethodResult[]>
- Defined in node-opcua-client/source/private/client_session_impl.ts:1623
Parameters
- methodToCall: CallMethodRequestLike
- callback: ResponseCallback<CallMethodResult>
Returns void
- Defined in node-opcua-client/source/private/client_session_impl.ts:1627
Parameters
- methodsToCall: CallMethodRequestLike[]
- callback: ResponseCallback<CallMethodResult[]>
Returns void

close

close(callback: ErrorCallback): void
close(deleteSubscription: boolean, callback: ErrorCallback): void
close(deleteSubscription?: boolean): Promise<void>

Implementation of ClientSession.close
- Defined in node-opcua-client/source/private/client_session_impl.ts:1578
method

close

async

Parameters
- callback: ErrorCallback
Returns void
Implementation of ClientSession.close
- Defined in node-opcua-client/source/private/client_session_impl.ts:1580
Parameters
- deleteSubscription: boolean
- callback: ErrorCallback
Returns void
Implementation of ClientSession.close
- Defined in node-opcua-client/source/private/client_session_impl.ts:1582
Parameters
- Optional deleteSubscription: boolean
Returns Promise<void>

confirmCondition

confirmCondition(conditionId: NodeIdLike, eventId: Buffer, comment: LocalizedTextLike, callback?: ErrorCallback): any

- Defined in node-opcua-client/source/private/client_session_impl.ts:1996
Parameters
- conditionId: NodeIdLike
- eventId: Buffer
- comment: LocalizedTextLike
- Optional callback: ErrorCallback
Returns any

constructExtensionObject

constructExtensionObject(dataType: NodeId, pojo: any): Promise<ExtensionObject>

Implementation of ClientSession.constructExtensionObject
- Defined in node-opcua-client/source/private/client_session_impl.ts:2062
async

Parameters
- dataType: NodeId
- pojo: any
Returns Promise<ExtensionObject>

createMonitoredItems

createMonitoredItems(options: CreateMonitoredItemsRequestLike, callback?: ResponseCallback<CreateMonitoredItemsResponse>): any

Implementation of ClientSession.createMonitoredItems
- Defined in node-opcua-client/source/private/client_session_impl.ts:1250
Parameters
- options: CreateMonitoredItemsRequestLike
- Optional callback: ResponseCallback<CreateMonitoredItemsResponse>
Returns any

createSubscription

createSubscription(options: CreateSubscriptionRequestLike, callback?: ResponseCallback<CreateSubscriptionResponse>): any

Implementation of ClientSession.createSubscription
- Defined in node-opcua-client/source/private/client_session_impl.ts:1181
Parameters
- options: CreateSubscriptionRequestLike
- Optional callback: ResponseCallback<CreateSubscriptionResponse>
Returns any

createSubscription2

createSubscription2(createSubscriptionRequest: CreateSubscriptionRequestLike): Promise<ClientSubscription>
createSubscription2(createSubscriptionRequest: CreateSubscriptionRequestLike, callback: function): void

Implementation of ClientSession.createSubscription2
- Defined in node-opcua-client/source/private/client_session_impl.ts:1200
method

createSubscription2

Parameters
- createSubscriptionRequest: CreateSubscriptionRequestLike
Returns Promise<ClientSubscription>
- Defined in node-opcua-client/source/private/client_session_impl.ts:1202
Parameters
- createSubscriptionRequest: CreateSubscriptionRequestLike
- callback: function
  - - (err: Error | null, subscription?: ClientSubscription): void
    - Parameters
      - err: Error | null
      - Optional subscription: ClientSubscription
      Returns void
Returns void

deleteMonitoredItems

deleteMonitoredItems(options: DeleteMonitoredItemsRequestLike, callback: function): void

- Defined in node-opcua-client/source/private/client_session_impl.ts:1343
method

deleteMonitoredItems

async

Parameters
- options: DeleteMonitoredItemsRequestLike
- callback: function
  - - (err: Error | null, response?: DeleteMonitoredItemsResponse): void
    - Parameters
      - err: Error | null
        
        the Error if the async method has failed
      - Optional response: DeleteMonitoredItemsResponse
      Returns void
Returns void

deleteSubscriptions

deleteSubscriptions(options: DeleteSubscriptionsRequestLike, callback?: ResponseCallback<DeleteSubscriptionsResponse>): any

Implementation of ClientSession.deleteSubscriptions
- Defined in node-opcua-client/source/private/client_session_impl.ts:1229
method

deleteSubscriptions

async

example:
```
session.deleteSubscriptions(request,function(err,response) {} );
```
Parameters
- options: DeleteSubscriptionsRequestLike
- Optional callback: ResponseCallback<DeleteSubscriptionsResponse>
Returns any

disableCondition

disableCondition(): void

Implementation of ClientSession.disableCondition
- Defined in node-opcua-client/source/private/client_session_impl.ts:1982
Returns void

dispose

dispose(): void

- Defined in node-opcua-client/source/private/client_session_impl.ts:1883
Returns void

emit

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

Implementation of ClientSession.emit

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

emitCloseEvent

emitCloseEvent(statusCode: StatusCode): void

- Defined in node-opcua-client/source/private/client_session_impl.ts:1172
Parameters
- statusCode: StatusCode
Returns void

enableCondition

enableCondition(): void

Implementation of ClientSession.enableCondition
- Defined in node-opcua-client/source/private/client_session_impl.ts:1985
Returns void

evaluateRemainingLifetime

evaluateRemainingLifetime(): number

- Defined in node-opcua-client/source/private/client_session_impl.ts:1558
evaluate the remaining time for the session

evaluate the time in milliseconds that the session will live on the server end from now. The remaining live time is calculated based on when the last message was sent to the server and the session timeout.
- In normal operation , when server and client communicates on a regular basis, evaluateRemainingLifetime will return a number slightly below session.timeout
- when the client and server cannot communicate due to a network issue (or a server crash), evaluateRemainingLifetime returns the estimated number of milliseconds before the server (if not crash) will keep the session alive on its end to allow a automatic reconnection with session.
- When evaluateRemainingLifetime returns zero , this mean that the session has probably ended on the server side and will have to be recreated from scratch in case of a reconnection.
Returns number

the number of milliseconds before session expires

eventNames

eventNames(): Array<string | symbol>

Implementation of ClientSession.eventNames

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>

extractNamespaceDataType

extractNamespaceDataType(): Promise<ExtraDataTypeManager>

Implementation of ClientSession.extractNamespaceDataType
- Defined in node-opcua-client/source/private/client_session_impl.ts:2028
Returns Promise<ExtraDataTypeManager>

findMethodId

findMethodId(nodeId: NodeIdLike, methodName: string, callback?: ResponseCallback<NodeId>): any

Implementation of ClientSession.findMethodId
- Defined in node-opcua-client/source/private/client_session_impl.ts:2012
Parameters
- nodeId: NodeIdLike
- methodName: string
- Optional callback: ResponseCallback<NodeId>
Returns any

getArgumentDefinition

getArgumentDefinition(methodId: MethodId): Promise<ArgumentDefinition>
getArgumentDefinition(methodId: MethodId, callback: ResponseCallback<ArgumentDefinition>): void

Implementation of ClientSession.getArgumentDefinition
- Defined in node-opcua-client/source/private/client_session_impl.ts:1749
method

getArgumentDefinition extract the argument definition of a method

async

Parameters
- methodId: MethodId
  
  the method nodeId to get argument definition from
Returns Promise<ArgumentDefinition>
- Defined in node-opcua-client/source/private/client_session_impl.ts:1750
Parameters
- methodId: MethodId
- callback: ResponseCallback<ArgumentDefinition>
Returns void

getBuiltInDataType

getBuiltInDataType(...args: any[]): any

- Defined in node-opcua-client/source/private/client_session_impl.ts:1909
Parameters
- Rest ...args: any[]
Returns any

getExtensionObjectConstructor

getExtensionObjectConstructor(dataTypeNodeId: NodeId): Promise<AnyConstructorFunc>

- Defined in node-opcua-client/source/private/client_session_impl.ts:2038
Parameters
- dataTypeNodeId: NodeId
Returns Promise<AnyConstructorFunc>

getMaxListeners

getMaxListeners(): number

Implementation of ClientSession.getMaxListeners

Inherited from EventEmitter.getMaxListeners

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

getMonitoredItems

getMonitoredItems(subscriptionId: SubscriptionId): Promise<MonitoredItemData>
getMonitoredItems(subscriptionId: SubscriptionId, callback: ResponseCallback<MonitoredItemData>): void

Implementation of ClientSession.getMonitoredItems
- Defined in node-opcua-client/source/private/client_session_impl.ts:1679
method

getMonitoredItems

Parameters
- subscriptionId: SubscriptionId
  
  the subscription Id to return
Returns Promise<MonitoredItemData>
Implementation of ClientSession.getMonitoredItems
- Defined in node-opcua-client/source/private/client_session_impl.ts:1681
Parameters
- subscriptionId: SubscriptionId
- callback: ResponseCallback<MonitoredItemData>
Returns void

getNamespaceIndex

getNamespaceIndex(namespaceUri: string): number

Implementation of ClientSession.getNamespaceIndex
- Defined in node-opcua-client/source/private/client_session_impl.ts:1975
Parameters
- namespaceUri: string
Returns number

getPublishEngine

getPublishEngine(): ClientSidePublishEngine

- Defined in node-opcua-client/source/private/client_session_impl.ts:365
Returns ClientSidePublishEngine

hasBeenClosed

hasBeenClosed(): boolean

- Defined in node-opcua-client/source/private/client_session_impl.ts:1615
method

hasBeenClosed

Returns boolean

isChannelValid

isChannelValid(): boolean

- Defined in node-opcua-client/source/private/client_session_impl.ts:1459
Returns boolean

listenerCount

listenerCount(type: string | symbol): number

Implementation of ClientSession.listenerCount

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[]

Implementation of ClientSession.listeners

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[]

modifyMonitoredItems

modifyMonitoredItems(options: ModifyMonitoredItemsRequestLike, callback?: ResponseCallback<ModifyMonitoredItemsResponse>): any

Implementation of ClientSession.modifyMonitoredItems
- Defined in node-opcua-client/source/private/client_session_impl.ts:1260
Parameters
- options: ModifyMonitoredItemsRequestLike
- Optional callback: ResponseCallback<ModifyMonitoredItemsResponse>
Returns any

modifySubscription

modifySubscription(options: ModifySubscriptionRequestLike, callback?: ResponseCallback<ModifySubscriptionResponse>): any

Implementation of ClientSession.modifySubscription
- Defined in node-opcua-client/source/private/client_session_impl.ts:1279
method

modifySubscription

async

Parameters
- options: ModifySubscriptionRequestLike
- Optional callback: ResponseCallback<ModifySubscriptionResponse>
Returns any

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

performMessageTransaction

performMessageTransaction(request: Request, callback: function): void

- Defined in node-opcua-client/source/private/client_session_impl.ts:1471
Parameters
- request: Request
- callback: function
  - - (err: Error | null, response?: Response): void
    - Parameters
      - err: Error | null
      - Optional response: Response
      Returns void
Returns void

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

publish

publish(options: PublishRequest, callback: function): void

- Defined in node-opcua-client/source/private/client_session_impl.ts:1308
method

publish

async

Parameters
- options: PublishRequest
- callback: function
  - - (err: Error | null, response?: PublishResponse): void
    - Parameters
      - err: Error | null
        
        the Error if the async method has failed
      - Optional response: PublishResponse
        
        the response
      Returns void
Returns void

queryFirst

queryFirst(queryFirstRequest: QueryFirstRequestLike): Promise<QueryFirstResponse>
queryFirst(queryFirstRequest: QueryFirstRequestLike, callback: ResponseCallback<QueryFirstResponse>): void

Implementation of ClientSession.queryFirst
- Defined in node-opcua-client/source/private/client_session_impl.ts:1825
Parameters
- queryFirstRequest: QueryFirstRequestLike
Returns Promise<QueryFirstResponse>
Implementation of ClientSession.queryFirst
- Defined in node-opcua-client/source/private/client_session_impl.ts:1829
Parameters
- queryFirstRequest: QueryFirstRequestLike
- callback: ResponseCallback<QueryFirstResponse>
Returns void

rawListeners

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

Implementation of ClientSession.rawListeners

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(nodeToRead: ReadValueIdLike, maxAge: number, callback: ResponseCallback<DataValue>): void
read(nodesToRead: ReadValueIdLike[], maxAge: number, callback: ResponseCallback<DataValue[]>): void
read(nodeToRead: ReadValueIdLike, callback: ResponseCallback<DataValue>): void
read(nodesToRead: ReadValueIdLike[], callback: ResponseCallback<DataValue[]>): void
read(nodeToRead: ReadValueIdLike, maxAge?: number): Promise<DataValue>
read(nodeToRead: ReadValueIdLike[], maxAge?: number): Promise<DataValue[]>

method

read (form1)

async

example

```javascript
```

form1: reading a single node

   const nodeToRead = {
            nodeId:      "ns=2;s=Furnace_1.Temperature",
            attributeId: AttributeIds.BrowseName
   };

   session.read(nodeToRead,function(err,dataValue) {
       if (!err) {
          console.log(dataValue.toString());
       }
   });

method

read (form2)

async

example

  const nodesToRead = [
       {
            nodeId:      "ns=2;s=Furnace_1.Temperature",
            attributeId: AttributeIds.BrowseName
       }
  ];
  session.read(nodesToRead,function(err,dataValues) {
    if (!err) {
      dataValues.forEach(dataValue=>console.log(dataValue.toString()));
    }
  });

Parameters

nodeToRead: ReadValueIdLike
maxAge: number
callback: ResponseCallback<DataValue>

the callback function

Returns void

Implementation of ClientSession.read
- Defined in node-opcua-client/source/private/client_session_impl.ts:1089
Parameters
- nodesToRead: ReadValueIdLike[]
- maxAge: number
- callback: ResponseCallback<DataValue[]>
Returns void
Implementation of ClientSession.read
- Defined in node-opcua-client/source/private/client_session_impl.ts:1091
Parameters
- nodeToRead: ReadValueIdLike
- callback: ResponseCallback<DataValue>
Returns void
Implementation of ClientSession.read
- Defined in node-opcua-client/source/private/client_session_impl.ts:1093
Parameters
- nodesToRead: ReadValueIdLike[]
- callback: ResponseCallback<DataValue[]>
Returns void
Implementation of ClientSession.read
- Defined in node-opcua-client/source/private/client_session_impl.ts:1095
Parameters
- nodeToRead: ReadValueIdLike
- Optional maxAge: number
Returns Promise<DataValue>
Implementation of ClientSession.read
- Defined in node-opcua-client/source/private/client_session_impl.ts:1097
Parameters
- nodeToRead: ReadValueIdLike[]
- Optional maxAge: number
Returns Promise<DataValue[]>

readAllAttributes

readAllAttributes(node: NodeIdLike, callback: function): void
readAllAttributes(nodes: NodeIdLike[], callback: function): void

method

readAllAttributes

example

 session.readAllAttributes("ns=2;s=Furnace_1.Temperature",function(err,data) {
   if(data.statusCode === StatusCodes.Good) {
     console.log(" nodeId      = ",data.nodeId.toString());
     console.log(" browseName  = ",data.browseName.toString());
     console.log(" description = ",data.description.toString());
     console.log(" value       = ",data.value.toString()));
   }
 });

async

Parameters

node: NodeIdLike

nodeId to read
callback: function
- - (err: Error | null, data?: NodeAttributes): void
  - Parameters
    - err: Error | null
    - Optional data: NodeAttributes
    Returns void

Returns void

- Defined in node-opcua-client/source/private/client_session_impl.ts:986
Parameters
- nodes: NodeIdLike[]
- callback: function
  - - (err: Error | null, data?: NodeAttributes[]): void
    - Parameters
      - err: Error | null
      - Optional data: NodeAttributes[]
      Returns void
Returns void

readHistoryValue

readHistoryValue(nodes: ReadValueIdLike[], start: DateTime, end: DateTime, callback: function): void
readHistoryValue(nodes: ReadValueIdLike[], start: DateTime, end: DateTime): Promise<HistoryReadResult[]>
readHistoryValue(node: ReadValueIdLike, start: DateTime, end: DateTime, callback: function): void
readHistoryValue(nodes: ReadValueIdLike, start: DateTime, end: DateTime): Promise<HistoryReadResult>

- Defined in node-opcua-client/source/private/client_session_impl.ts:684
method

readHistoryValue

async

example
```
//  es5
session.readHistoryValue(
  "ns=5;s=Simulation Examples.Functions.Sine1",
  "2015-06-10T09:00:00.000Z",
  "2015-06-10T09:01:00.000Z", function(err,dataValues) {

});
```
```
//  es6
const dataValues = await session.readHistoryValue(
  "ns=5;s=Simulation Examples.Functions.Sine1",
  "2015-06-10T09:00:00.000Z",
  "2015-06-10T09:01:00.000Z");
```
Parameters
- nodes: ReadValueIdLike[]
  
  the read value id
- start: DateTime
  
  the start time in UTC format
- end: DateTime
  
  the end time in UTC format
- callback: function
  - - (err: Error | null, results?: HistoryReadResult[]): void
    - Parameters
      - err: Error | null
      - Optional results: HistoryReadResult[]
      Returns void
Returns void
Implementation of ClientSession.readHistoryValue
- Defined in node-opcua-client/source/private/client_session_impl.ts:689
Parameters
- nodes: ReadValueIdLike[]
- start: DateTime
- end: DateTime
Returns Promise<HistoryReadResult[]>
- Defined in node-opcua-client/source/private/client_session_impl.ts:695
Parameters
- node: ReadValueIdLike
- start: DateTime
- end: DateTime
- callback: function
  - - (err: Error | null, results?: HistoryReadResult): void
    - Parameters
      - err: Error | null
      - Optional results: HistoryReadResult
      Returns void
Returns void
Implementation of ClientSession.readHistoryValue
- Defined in node-opcua-client/source/private/client_session_impl.ts:700
Parameters
- nodes: ReadValueIdLike
- start: DateTime
- end: DateTime
Returns Promise<HistoryReadResult>

readNamespaceArray

readNamespaceArray(): Promise<string[]>
readNamespaceArray(callback: function): void

Implementation of ClientSession.readNamespaceArray
- Defined in node-opcua-client/source/private/client_session_impl.ts:1945
Returns Promise<string[]>
- Defined in node-opcua-client/source/private/client_session_impl.ts:1946
Parameters
- callback: function
  - - (err: Error | null, namespaceArray?: string[]): void
    - Parameters
      - err: Error | null
      - Optional namespaceArray: string[]
      Returns void
Returns void

readVariableValue

readVariableValue(nodeId: NodeIdLike, callback: ResponseCallback<DataValue>): void
readVariableValue(nodeIds: NodeIdLike[], callback: ResponseCallback<DataValue[]>): void
readVariableValue(nodeId: NodeIdLike): Promise<DataValue>
readVariableValue(nodeIds: NodeIdLike[]): Promise<DataValue[]>

method

readVariableValue

async

example

    session.readVariableValue("ns=2;s=Furnace_1.Temperature",function(err,dataValue) {
       if(err) { return callback(err); }
       if (dataValue.statusCode === opcua.StatusCodes.Good) {
       }
       console.log(dataValue.toString());
       callback();
    });

example

  session.readVariableValue(["ns=0;i=2257","ns=0;i=2258"],function(err,dataValues) {
     if (!err) {
        console.log(dataValues[0].toString());
        console.log(dataValues[1].toString());
     }
  });

example

    const dataValues = await session.readVariableValue(["ns=1;s=Temperature","ns=1;s=Pressure"]);

Parameters

nodeId: NodeIdLike
callback: ResponseCallback<DataValue>

Returns void

Implementation of ClientSession.readVariableValue
- Defined in node-opcua-client/source/private/client_session_impl.ts:603
Parameters
- nodeIds: NodeIdLike[]
- callback: ResponseCallback<DataValue[]>
Returns void
Implementation of ClientSession.readVariableValue
- Defined in node-opcua-client/source/private/client_session_impl.ts:605
Parameters
- nodeId: NodeIdLike
Returns Promise<DataValue>
Implementation of ClientSession.readVariableValue
- Defined in node-opcua-client/source/private/client_session_impl.ts:607
Parameters
- nodeIds: NodeIdLike[]
Returns Promise<DataValue[]>

registerNodes

registerNodes(nodesToRegister: NodeIdLike[]): Promise<NodeId[]>
registerNodes(nodesToRegister: NodeIdLike[], callback: function): void

Implementation of ClientSession.registerNodes
- Defined in node-opcua-client/source/private/client_session_impl.ts:1764
Parameters
- nodesToRegister: NodeIdLike[]
Returns Promise<NodeId[]>
- Defined in node-opcua-client/source/private/client_session_impl.ts:1765
Parameters
- nodesToRegister: NodeIdLike[]
- callback: function
  - - (err: Error | null, registeredNodeIds?: NodeId[]): void
    - Parameters
      - err: Error | null
      - Optional registeredNodeIds: NodeId[]
      Returns void
Returns void

removeAllListeners

removeAllListeners(event?: string | symbol): this

Implementation of ClientSession.removeAllListeners

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

republish

republish(options: RepublishRequest, callback: function): void

- Defined in node-opcua-client/source/private/client_session_impl.ts:1325
method

republish

async

Parameters
- options: RepublishRequest
- callback: function
  
  the callback
  - - (err: Error | null, response?: RepublishResponse): void
    - Parameters
      - err: Error | null
      - Optional response: RepublishResponse
      Returns void
Returns void

resumePublishEngine

resumePublishEngine(): void

- Defined in node-opcua-client/source/private/client_session_impl.ts:1938
Returns void

setMaxListeners

setMaxListeners(n: number): this

Implementation of ClientSession.setMaxListeners

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

setMonitoringMode

setMonitoringMode(options: SetMonitoringModeRequestLike, callback?: ResponseCallback<SetMonitoringModeResponse>): any

Implementation of ClientSession.setMonitoringMode
- Defined in node-opcua-client/source/private/client_session_impl.ts:1289
Parameters
- options: SetMonitoringModeRequestLike
- Optional callback: ResponseCallback<SetMonitoringModeResponse>
Returns any

setPublishingMode

setPublishingMode(publishingEnabled: boolean, subscriptionId: SubscriptionId): Promise<StatusCode>
setPublishingMode(publishingEnabled: boolean, subscriptionIds: SubscriptionId[]): Promise<StatusCode[]>
setPublishingMode(publishingEnabled: boolean, subscriptionId: SubscriptionId, callback: function): void
setPublishingMode(publishingEnabled: boolean, subscriptionIds: SubscriptionId[], callback: function): void

- Defined in node-opcua-client/source/private/client_session_impl.ts:1357
method

setPublishingMode

async

Parameters
- publishingEnabled: boolean
- subscriptionId: SubscriptionId
Returns Promise<StatusCode>
- Defined in node-opcua-client/source/private/client_session_impl.ts:1361
Parameters
- publishingEnabled: boolean
- subscriptionIds: SubscriptionId[]
Returns Promise<StatusCode[]>
- Defined in node-opcua-client/source/private/client_session_impl.ts:1365
Parameters
- publishingEnabled: boolean
- subscriptionId: SubscriptionId
- callback: function
  - - (err: Error | null, statusCode?: StatusCode): void
    - Parameters
      - err: Error | null
      - Optional statusCode: StatusCode
      Returns void
Returns void
- Defined in node-opcua-client/source/private/client_session_impl.ts:1370
Parameters
- publishingEnabled: boolean
- subscriptionIds: SubscriptionId[]
- callback: function
  - - (err: Error | null, statusCodes?: StatusCode[]): void
    - Parameters
      - err: Error | null
      - Optional statusCodes: StatusCode[]
      Returns void
Returns void

startKeepAliveManager

startKeepAliveManager(): void

- Defined in node-opcua-client/source/private/client_session_impl.ts:1854
Returns void

stopKeepAliveManager

stopKeepAliveManager(): void

- Defined in node-opcua-client/source/private/client_session_impl.ts:1876
Returns void

toString

toString(): string

- Defined in node-opcua-client/source/private/client_session_impl.ts:1890
Returns string

transferSubscriptions

transferSubscriptions(options: TransferSubscriptionsRequestLike, callback?: ResponseCallback<TransferSubscriptionsResponse>): any

Implementation of ClientSession.transferSubscriptions
- Defined in node-opcua-client/source/private/client_session_impl.ts:1240
method

transferSubscriptions

async

Parameters
- options: TransferSubscriptionsRequestLike
- Optional callback: ResponseCallback<TransferSubscriptionsResponse>
Returns any

translateBrowsePath

translateBrowsePath(browsePath: BrowsePath, callback: ResponseCallback<BrowsePathResult>): void
translateBrowsePath(browsesPath: BrowsePath[], callback: ResponseCallback<BrowsePathResult[]>): void
translateBrowsePath(browsePath: BrowsePath): Promise<BrowsePathResult>
translateBrowsePath(browsePaths: BrowsePath[]): Promise<BrowsePathResult[]>

Implementation of ClientSession.translateBrowsePath
- Defined in node-opcua-client/source/private/client_session_impl.ts:1422
method

translateBrowsePath

async

Parameters
- browsePath: BrowsePath
- callback: ResponseCallback<BrowsePathResult>
Returns void
Implementation of ClientSession.translateBrowsePath
- Defined in node-opcua-client/source/private/client_session_impl.ts:1423
Parameters
- browsesPath: BrowsePath[]
- callback: ResponseCallback<BrowsePathResult[]>
Returns void
Implementation of ClientSession.translateBrowsePath
- Defined in node-opcua-client/source/private/client_session_impl.ts:1424
Parameters
- browsePath: BrowsePath
Returns Promise<BrowsePathResult>
Implementation of ClientSession.translateBrowsePath
- Defined in node-opcua-client/source/private/client_session_impl.ts:1425
Parameters
- browsePaths: BrowsePath[]
Returns Promise<BrowsePathResult[]>

unregisterNodes

unregisterNodes(nodesToUnregister: NodeIdLike[]): Promise<void>
unregisterNodes(nodesToUnregister: NodeIdLike[], callback: function): void

Implementation of ClientSession.unregisterNodes
- Defined in node-opcua-client/source/private/client_session_impl.ts:1798
Parameters
- nodesToUnregister: NodeIdLike[]
Returns Promise<void>
- Defined in node-opcua-client/source/private/client_session_impl.ts:1799
Parameters
- nodesToUnregister: NodeIdLike[]
- callback: function
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

write

write(nodeToWrite: WriteValueLike, callback: ResponseCallback<StatusCode>): void
write(nodesToWrite: WriteValueLike[], callback: ResponseCallback<StatusCode[]>): void
write(nodesToWrite: WriteValueLike[]): Promise<StatusCode[]>
write(nodeToWrite: WriteValueLike): Promise<StatusCode>

method

write

async

example

const nodesToWrite = [
{
     nodeId: "ns=1;s=SetPoint1",
     attributeId: opcua.AttributeIds.Value,
     value: {
        statusCode: Good,
        value: {
          dataType: opcua.DataType.Double,
          value: 100.0
        }
     }
},
{
     nodeId: "ns=1;s=SetPoint2",
     attributeIds opcua.AttributeIds.Value,
     value: {
        statusCode: Good,
        value: {
          dataType: opcua.DataType.Double,
          value: 45.0
        }
     }
}
];
session.write(nodesToWrite,function (err,statusCodes) {
  if(err) { return callback(err);}
  //
});

method

write

async

example

const nodeToWrite = {
     nodeId: "ns=1;s=SetPoint",
     attributeId: opcua.AttributeIds.Value,
     value: {
        statusCode: Good,
        value: {
          dataType: opcua.DataType.Double,
          value: 100.0
        }
     }
};
session.write(nodeToWrite,function (err,statusCode) {
  if(err) { return callback(err);}
  //
});

method

write

async

example

  session.write(nodeToWrite).then(function(statusCode) { });

example

  const statusCode = await session.write(nodeToWrite);

method

write

async

example

session.write(nodesToWrite).then(function(statusCodes) { });

example

  const statusCodes = await session.write(nodesToWrite);

Parameters

nodeToWrite: WriteValueLike

the value to write
callback: ResponseCallback<StatusCode>

the callback function

Returns void

Implementation of ClientSession.write
- Defined in node-opcua-client/source/private/client_session_impl.ts:872
Parameters
- nodesToWrite: WriteValueLike[]
- callback: ResponseCallback<StatusCode[]>
Returns void
Implementation of ClientSession.write
- Defined in node-opcua-client/source/private/client_session_impl.ts:874
Parameters
- nodesToWrite: WriteValueLike[]
Returns Promise<StatusCode[]>
Implementation of ClientSession.write
- Defined in node-opcua-client/source/private/client_session_impl.ts:876
Parameters
- nodeToWrite: WriteValueLike
Returns Promise<StatusCode>

writeSingleNode

writeSingleNode(nodeId: NodeIdLike, value: VariantLike, callback: ResponseCallback<StatusCode>): void
writeSingleNode(nodeId: NodeIdLike, value: VariantLike): Promise<StatusCode>

Implementation of ClientSession.writeSingleNode
- Defined in node-opcua-client/source/private/client_session_impl.ts:932
method

writeSingleNode

async

method

writeSingleNode

async

Parameters
- nodeId: NodeIdLike
  
  the node id of the node to write
- value: VariantLike
  
  the value to write
- callback: ResponseCallback<StatusCode>
Returns void
- the status code of the write
Implementation of ClientSession.writeSingleNode
- Defined in node-opcua-client/source/private/client_session_impl.ts:934
Parameters
- nodeId: NodeIdLike
- value: VariantLike
Returns Promise<StatusCode>

Static listenerCount

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

Implementation of ClientSession.listenerCount

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

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: any

Returns ClientSessionImpl

Properties

_client

_closeEventHasBeenEmitted

_closed

Optional authenticationToken

lastRequestSentTime

lastResponseReceivedTime

name

requestedMaxReferencesPerNode

serverCertificate

serverEndpoints

Optional serverNonce

Optional serverSignature

sessionId

timeout

Static defaultMaxListeners

Accessors

endpoint

Returns EndpointDescription

isReconnecting

Returns any

subscriptionCount

Returns number

Methods

_callMethodCondition

Parameters

methodName: string

conditionId: NodeIdLike

eventId: Buffer

comment: LocalizedTextLike

callback: function

Parameters

Optional err: Error

Returns void

Returns void

_terminatePublishEngine

Returns void

acknowledgeCondition

Parameters

conditionId: NodeId

eventId: Buffer

comment: LocalizedTextLike

Optional callback: ErrorCallback

Returns any

addCommentCondition

Parameters

conditionId: NodeIdLike

eventId: Buffer

comment: LocalizedTextLike

Optional callback: ErrorCallback

Returns any

addListener

Parameters

event: string | symbol

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

browse

Parameters

nodeToBrowse: BrowseDescriptionLike

callback: ResponseCallback<BrowseResult>

Returns void

Parameters

nodesToBrowse: BrowseDescriptionLike[]

callback: ResponseCallback<BrowseResult[]>

Returns void