PseudoSession | NodeOPCUA reference documentation

Pseudo session is an helper object that exposes the same async methods than the ClientSession. It can be used on a server address space.

Code reused ! The primary benefit of this object is that its makes advanced OPCUA operations that uses browse, translate, read, write etc similar whether we work inside a server or through a client session.

Hierarchy

PseudoSession

Implements

IBasicSession

Index

Constructors

constructor

Properties

requestedMaxReferencesPerNode

Methods

Constructors

constructor

new PseudoSession(addressSpace: IAddressSpace, context?: ISessionContext): PseudoSession

- Defined in node-opcua-address-space/dist/source/pseudo_session.d.ts:27
Parameters
- addressSpace: IAddressSpace
- Optional context: ISessionContext
Returns PseudoSession

Properties

requestedMaxReferencesPerNode

requestedMaxReferencesPerNode: number

Methods

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

Implementation of IBasicSession.browse
- Defined in node-opcua-address-space/dist/source/pseudo_session.d.ts:29
Parameters
- nodeToBrowse: BrowseDescriptionLike
- callback: ResponseCallback<BrowseResult>
Returns void
Implementation of IBasicSession.browse
- Defined in node-opcua-address-space/dist/source/pseudo_session.d.ts:30
Parameters
- nodesToBrowse: BrowseDescriptionLike[]
- callback: ResponseCallback<BrowseResult[]>
Returns void
Implementation of IBasicSession.browse
- Defined in node-opcua-address-space/dist/source/pseudo_session.d.ts:31
Parameters
- nodeToBrowse: BrowseDescriptionLike
Returns Promise<BrowseResult>
Implementation of IBasicSession.browse
- Defined in node-opcua-address-space/dist/source/pseudo_session.d.ts:32
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 IBasicSession.browseNext
- Defined in node-opcua-address-space/dist/source/pseudo_session.d.ts:37
Parameters
- continuationPoint: Buffer
- releaseContinuationPoints: boolean
- callback: ResponseCallback<BrowseResult>
Returns void
Implementation of IBasicSession.browseNext
- Defined in node-opcua-address-space/dist/source/pseudo_session.d.ts:38
Parameters
- continuationPoints: Buffer[]
- releaseContinuationPoints: boolean
- callback: ResponseCallback<BrowseResult[]>
Returns void
Implementation of IBasicSession.browseNext
- Defined in node-opcua-address-space/dist/source/pseudo_session.d.ts:39
Parameters
- continuationPoint: Buffer
- releaseContinuationPoints: boolean
Returns Promise<BrowseResult>
Implementation of IBasicSession.browseNext
- Defined in node-opcua-address-space/dist/source/pseudo_session.d.ts:40
Parameters
- continuationPoints: Buffer[]
- releaseContinuationPoints: boolean
Returns Promise<BrowseResult[]>

call

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

Implementation of IBasicSession.call
- Defined in node-opcua-address-space/dist/source/pseudo_session.d.ts:41
Parameters
- methodToCall: CallMethodRequestOptions
- callback: ResponseCallback<CallMethodResult>
Returns void
Implementation of IBasicSession.call
- Defined in node-opcua-address-space/dist/source/pseudo_session.d.ts:42
Parameters
- methodsToCall: CallMethodRequestOptions[]
- callback: ResponseCallback<CallMethodResult[]>
Returns void
Implementation of IBasicSession.call
- Defined in node-opcua-address-space/dist/source/pseudo_session.d.ts:43
Parameters
- methodToCall: CallMethodRequestOptions
Returns Promise<CallMethodResult>
Implementation of IBasicSession.call
- Defined in node-opcua-address-space/dist/source/pseudo_session.d.ts:44
Parameters
- methodsToCall: CallMethodRequestOptions[]
Returns Promise<CallMethodResult[]>

getArgumentDefinition

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

Implementation of IBasicSession.getArgumentDefinition
- Defined in node-opcua-address-space/dist/source/pseudo_session.d.ts:45
Parameters
- methodId: NodeIdLike
Returns Promise<ArgumentDefinition>
Implementation of IBasicSession.getArgumentDefinition
- Defined in node-opcua-address-space/dist/source/pseudo_session.d.ts:46
Parameters
- methodId: NodeIdLike
- callback: ResponseCallback<ArgumentDefinition>
Returns void

getSessionId

getSessionId(): NodeId

- Defined in node-opcua-address-space/dist/source/pseudo_session.d.ts:28
Returns NodeId

read

read(nodeToRead: ReadValueIdOptions, callback: ResponseCallback<DataValue>): void
read(nodesToRead: ReadValueIdOptions[], callback: ResponseCallback<DataValue[]>): void
read(nodeToRead: ReadValueIdOptions): Promise<DataValue>
read(nodesToRead: ReadValueIdOptions[]): Promise<DataValue[]>

Implementation of IBasicSession.read
- Defined in node-opcua-address-space/dist/source/pseudo_session.d.ts:33
Parameters
- nodeToRead: ReadValueIdOptions
- callback: ResponseCallback<DataValue>
Returns void
Implementation of IBasicSession.read
- Defined in node-opcua-address-space/dist/source/pseudo_session.d.ts:34
Parameters
- nodesToRead: ReadValueIdOptions[]
- callback: ResponseCallback<DataValue[]>
Returns void
Implementation of IBasicSession.read
- Defined in node-opcua-address-space/dist/source/pseudo_session.d.ts:35
Parameters
- nodeToRead: ReadValueIdOptions
Returns Promise<DataValue>
Implementation of IBasicSession.read
- Defined in node-opcua-address-space/dist/source/pseudo_session.d.ts:36
Parameters
- nodesToRead: ReadValueIdOptions[]
Returns Promise<DataValue[]>

translateBrowsePath

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

Implementation of IBasicSession.translateBrowsePath
- Defined in node-opcua-address-space/dist/source/pseudo_session.d.ts:47
Parameters
- browsePaths: BrowsePath[]
- callback: ResponseCallback<BrowsePathResult[]>
Returns void
Implementation of IBasicSession.translateBrowsePath
- Defined in node-opcua-address-space/dist/source/pseudo_session.d.ts:48
Parameters
- browsePath: BrowsePath
- callback: ResponseCallback<BrowsePathResult>
Returns void
Implementation of IBasicSession.translateBrowsePath
- Defined in node-opcua-address-space/dist/source/pseudo_session.d.ts:49
Parameters
- browsePath: BrowsePath
Returns Promise<BrowsePathResult>
Implementation of IBasicSession.translateBrowsePath
- Defined in node-opcua-address-space/dist/source/pseudo_session.d.ts:50
Parameters
- browsePaths: BrowsePath[]
Returns Promise<BrowsePathResult[]>

write

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

Implementation of IBasicSession.write
- Defined in node-opcua-address-space/dist/source/pseudo_session.d.ts:51
Parameters
- nodeToWrite: WriteValueOptions
- callback: ResponseCallback<StatusCode>
Returns void
Implementation of IBasicSession.write
- Defined in node-opcua-address-space/dist/source/pseudo_session.d.ts:52
Parameters
- nodesToWrite: WriteValueOptions[]
- callback: ResponseCallback<StatusCode[]>
Returns void
Implementation of IBasicSession.write
- Defined in node-opcua-address-space/dist/source/pseudo_session.d.ts:53
Parameters
- nodeToWrite: WriteValueOptions
Returns Promise<StatusCode>
Implementation of IBasicSession.write
- Defined in node-opcua-address-space/dist/source/pseudo_session.d.ts:54
Parameters
- nodesToWrite: WriteValueOptions[]
Returns Promise<StatusCode[]>

subscribe now with sterfive to access the online-user manual

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

addressSpace: IAddressSpace

Optional context: ISessionContext

Returns PseudoSession

Properties

requestedMaxReferencesPerNode

Methods

browse

Parameters

nodeToBrowse: BrowseDescriptionLike

callback: ResponseCallback<BrowseResult>

Returns void

Parameters

nodesToBrowse: BrowseDescriptionLike[]

callback: ResponseCallback<BrowseResult[]>

Returns void

Parameters

nodeToBrowse: BrowseDescriptionLike

Returns Promise<BrowseResult>

Parameters

nodesToBrowse: BrowseDescriptionLike[]

Returns Promise<BrowseResult[]>

browseNext

Parameters

continuationPoint: Buffer

releaseContinuationPoints: boolean

callback: ResponseCallback<BrowseResult>

Returns void

Parameters

continuationPoints: Buffer[]

releaseContinuationPoints: boolean

callback: ResponseCallback<BrowseResult[]>

Returns void

Parameters

continuationPoint: Buffer

releaseContinuationPoints: boolean

Returns Promise<BrowseResult>

Parameters

continuationPoints: Buffer[]

releaseContinuationPoints: boolean

Returns Promise<BrowseResult[]>

call

Parameters

methodToCall: CallMethodRequestOptions

callback: ResponseCallback<CallMethodResult>

Returns void

Parameters

methodsToCall: CallMethodRequestOptions[]

callback: ResponseCallback<CallMethodResult[]>

Returns void

Parameters

methodToCall: CallMethodRequestOptions

Returns Promise<CallMethodResult>

Parameters

methodsToCall: CallMethodRequestOptions[]

Returns Promise<CallMethodResult[]>

getArgumentDefinition

Parameters

methodId: NodeIdLike

Returns Promise<ArgumentDefinition>

Parameters

methodId: NodeIdLike

callback: ResponseCallback<ArgumentDefinition>

Returns void

getSessionId

Returns NodeId

read

Parameters

nodeToRead: ReadValueIdOptions

callback: ResponseCallback<DataValue>

Returns void