Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ClientSession

  subscribe now with sterfive to access the online-user manual

Hierarchy

Index

Properties

Methods

Properties

Optional authenticationToken

authenticationToken: NodeId

endpoint

endpoint: EndpointDescription

isReconnecting

isReconnecting: boolean

lastRequestSentTime

lastRequestSentTime: Date

the time of the latest request sent by the client to the server

lastResponseReceivedTime

lastResponseReceivedTime: Date

the time of the latest response received by the client

name

name: string

the session name

requestedMaxReferencesPerNode

requestedMaxReferencesPerNode: number

the maximum number of reference that the server should return per browseResult Continuous points will be return by server to allow retrieving remaining references with browseNext

serverCertificate

serverCertificate: Buffer

the server certificate as provided by the server

sessionId

sessionId: NodeId

subscriptionCount

subscriptionCount: number

timeout

timeout: number

the session Id

Methods

acknowledgeCondition

  • helper to acknowledge a condition

    from Spec 1.03 Part 9 : page 27

    The Acknowledge Method is used to acknowledge an Event Notification for a Condition instance state where AckedState is false.

    Normally, the NodeId of the object instance as the ObjectId is passed to the Call Service.

    However, some Servers do not expose Condition instances in the AddressSpace.

    Therefore all Servers shall also allow Clients to call the Acknowledge Method by specifying ConditionId as the ObjectId.

    The Method cannot be called with an ObjectId of the AcknowledgeableConditionType Node.

    A Condition instance may be an Object that appears in the Server Address Space. If this is the case the ConditionId is the NodeId for the Object.

    The EventId identifies a specific Event Notification where a state to be acknowledged was reported.

    Acknowledgement and the optional comment will be applied to the state identified with the EventId. If the comment field is NULL (both locale and text are empty) it will be ignored and any existing comments will remain unchanged. If the comment is to be reset, an empty text with a locale shall be provided.

    A valid EventId will result in an Event Notification where AckedState/Id is set to TRUE and the Comment Property contains the text of the optional comment argument. If a previous state is acknowledged, the BranchId and all Condition values of this branch will be reported.

    Parameters

    Returns void

  • Parameters

    Returns Promise<StatusCode>

addCommentCondition

  • helper to add a comment to a condition

    The AddComment Method is used to apply a comment to a specific state of a Condition instance.

    Normally, the NodeId of the object instance as the ObjectId is passed to the Call Service.

    However, some Servers do not expose Condition instances in the AddressSpace. Therefore all Servers shall also allow Clients to call the AddComment Method by specifying ConditionId as the ObjectId.

    The Method cannot be called with an ObjectId of the ConditionType Node.

    Notes:
    • Comments are added to Event occurrences identified via an EventId. EventIds where the related EventType is not a ConditionType (or subtype of it) and thus does not support Comments are rejected.
    • A ConditionEvent – where the Comment Variable contains this text – will be sent for the identified state. If a comment is added to a previous state (i.e. a state for which the Server has created a branch), the BranchId and all Condition values of this branch will be reported/.

    Parameters

    Returns void

  • Parameters

    Returns Promise<StatusCode>

browse

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

call

  • method

    call

    example

    :

    const methodToCall = {
    objectId: "ns=2;i=12",
    methodId: "ns=2;i=13",
    inputArguments: [
        new Variant({...}),
        new Variant({...}),
    ]
}
session.call(methodToCall,function(err,callResult) {
   if (!err) {
        console.log(" statusCode = ",callResult.statusCode);
        console.log(" inputArgumentResults[0] = ",callResult.inputArgumentResults[0].toString());
        console.log(" inputArgumentResults[1] = ",callResult.inputArgumentResults[1].toString());
        console.log(" outputArgument[0]       = ",callResult.outputArgument[0].toString()); // array of variant
   }
});
    method

    call

    example

    :

    const methodsToCall = [ {
    objectId: "ns=2;i=12",
    methodId: "ns=2;i=13",
    inputArguments: [
        new Variant({...}),
        new Variant({...}),
    ]
}];
session.call(methodsToCall,function(err,callResults) {
   if (!err) {
        const callResult = callResults[0];
        console.log(" statusCode = ",rep.statusCode);
        console.log(" inputArgumentResults[0] = ",callResult.inputArgumentResults[0].toString());
        console.log(" inputArgumentResults[1] = ",callResult.inputArgumentResults[1].toString());
        console.log(" outputArgument[0]       = ",callResult.outputArgument[0].toString()); // array of variant
   }
});

    Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns Promise<CallMethodResult>

  • Parameters

    Returns Promise<CallMethodResult[]>

close

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

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    • Optional deleteSubscription: boolean

    Returns Promise<void>

confirmCondition

  • helper to confirm a condition

    from Spec 1.03 Part 9 : page 27 The Confirm Method is used to confirm an Event Notifications for a Condition instance state where ConfirmedState is FALSE.

    Normally, the NodeId of the object instance as the ObjectId is passed to the Call Service.

    However, some Servers do not expose Condition instances in the AddressSpace.

    Therefore all Servers shall also allow Clients to call the Confirm Method by specifying ConditionId as the ObjectId.

    The Method cannot be called with an ObjectId of the AcknowledgeableConditionType Node.

    Parameters

    Returns void

  • Parameters

    Returns Promise<StatusCode>

constructExtensionObject

createSubscription2

disableCondition

  • disableCondition(): void

enableCondition

  • enableCondition(): void

findMethodId

getArgumentDefinition

getBuiltInDataType

  • getBuiltInDataType(nodeId: NodeId): Promise<DataType>
  • getBuiltInDataType(nodeId: NodeId, callback: (err: Error, dataType?: DataType) => void): void

  • retrieve the built-in DataType of a Variable, from its DataType attribute.

    this method is useful to determine which DataType to use when constructing a Variant

    async
    example
    const session = ...; // ClientSession
const nodeId = opcua.VariableIds.Server_ServerStatus_CurrentTime;
session.getBuiltInDataType(nodeId,function(err,dataType) {
  assert(dataType === opcua.DataType.DateTime);
});
// or
nodeId = opcua.coerceNodeId("ns=2;s=Static_Scalar_ImagePNG");
const dataType: await session.getBuiltInDataType(nodeId);
assert(dataType === opcua.DataType.ByteString);

    Parameters

    • nodeId: NodeId

      the node id of the variable to query

    Returns Promise<DataType>

  • Parameters

    • nodeId: NodeId
    • callback: (err: Error, dataType?: DataType) => void
        • (err: Error, dataType?: DataType): void

        • Parameters

          • err: Error
          • Optional dataType: DataType

          Returns void

    Returns void

getNamespaceIndex

  • getNamespaceIndex(namespaceUri: string): number

historyRead

on

  • Parameters

    • event: "keepalive"
    • eventHandler: (lastKnownServerState: ServerState) => void

    Returns ClientSession

  • Parameters

    • event: "keepalive_failure"
    • eventHandler: (state: any) => void
        • (state: any): void

        • Parameters

          • state: any

          Returns void

    Returns ClientSession

  • Parameters

    • event: "session_closed"
    • eventHandler: (statusCode: StatusCode) => void

    Returns ClientSession

  • session_restored is raised when the session and related subscription have been fully repaired after a reconnection.

    Parameters

    • event: "session_restored"
    • eventHandler: () => void
        • (): void

        • Returns void

    Returns ClientSession

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ClientSession

queryFirst

read

readAggregateValue

readHistoryValue

readNamespaceArray

  • readNamespaceArray(): Promise<string[]>
  • readNamespaceArray(callback: (err: Error, namespaceArray?: string[]) => void): void

readVariableValue

registerNodes

  • registerNodes(nodesToRegister: NodeIdLike[]): Promise<NodeId[]>
  • registerNodes(nodesToRegister: NodeIdLike[], callback: (err: Error, registeredNodeIds?: NodeId[]) => void): void

translateBrowsePath

unregisterNodes

  • unregisterNodes(nodesToRegister: NodeIdLike[]): Promise<void>
  • unregisterNodes(nodesToRegister: NodeIdLike[], callback: (err?: Error) => void): void

write

Generated using TypeDoc