Options
All
  • Public
  • Public/Protected
  • All
Menu

Module node-opcua-client

  subscribe now with sterfive to access the online-user manual

Index

References

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

References

AcknowledgeMessage

Re-exports AcknowledgeMessage

ActivateSessionRequest

Re-exports ActivateSessionRequest

ActivateSessionResponse

Re-exports ActivateSessionResponse

AggregateConfiguration

Re-exports AggregateConfiguration

AggregateFilter

Re-exports AggregateFilter

Announcement

Re-exports Announcement

AnonymousIdentityToken

Re-exports AnonymousIdentityToken

ApplicationDescription

Re-exports ApplicationDescription

ApplicationDescriptionOptions

Re-exports ApplicationDescriptionOptions

ApplicationType

Re-exports ApplicationType

Argument

Re-exports Argument

ArgumentDefinition

Re-exports ArgumentDefinition

ArgumentOptions

Re-exports ArgumentOptions

AsymmetricAlgorithmSecurityHeader

Re-exports AsymmetricAlgorithmSecurityHeader

AttributeIds

Re-exports AttributeIds

AttributeOperand

Re-exports AttributeOperand

AttributeOperandOptions

Re-exports AttributeOperandOptions

BonjourHolder

Re-exports BonjourHolder

BrowseDescription

Re-exports BrowseDescription

BrowseDescriptionOptions

Re-exports BrowseDescriptionOptions

BrowseNextRequest

Re-exports BrowseNextRequest

BrowseNextRequestOptions

Re-exports BrowseNextRequestOptions

BrowseNextResponse

Re-exports BrowseNextResponse

BrowsePath

Re-exports BrowsePath

BrowsePathResult

Re-exports BrowsePathResult

BrowsePathTarget

Re-exports BrowsePathTarget

BrowseRequest

Re-exports BrowseRequest

BrowseRequestOptions

Re-exports BrowseRequestOptions

BrowseResponse

Re-exports BrowseResponse

BrowseResult

Re-exports BrowseResult

CallMethodRequest

Re-exports CallMethodRequest

CallMethodRequestLike

Re-exports CallMethodRequestLike

CallMethodRequestOptions

Re-exports CallMethodRequestOptions

CallMethodResult

Re-exports CallMethodResult

CallMethodResultOptions

Re-exports CallMethodResultOptions

CallRequest

Re-exports CallRequest

CallRequestOptions

Re-exports CallRequestOptions

CallResponse

Re-exports CallResponse

CancelRequest

Re-exports CancelRequest

CancelResponse

Re-exports CancelResponse

ChannelSecurityToken

Re-exports ChannelSecurityToken

ClientSecureChannelLayer

Re-exports ClientSecureChannelLayer

ClientSidePublishEngine

Re-exports ClientSidePublishEngine

CloseSecureChannelRequest

Re-exports CloseSecureChannelRequest

CloseSecureChannelResponse

Re-exports CloseSecureChannelResponse

CloseSessionRequest

Re-exports CloseSessionRequest

CloseSessionResponse

Re-exports CloseSessionResponse

ConnectionStrategyOptions

Re-exports ConnectionStrategyOptions

ContentFilter

Re-exports ContentFilter

ContentFilterElement

Re-exports ContentFilterElement

ContentFilterElementOptions

Re-exports ContentFilterElementOptions

ContentFilterElementResult

Re-exports ContentFilterElementResult

ContentFilterOptions

Re-exports ContentFilterOptions

ContentFilterResult

Re-exports ContentFilterResult

CreateMonitoredItemsRequest

Re-exports CreateMonitoredItemsRequest

CreateMonitoredItemsRequestOptions

Re-exports CreateMonitoredItemsRequestOptions

CreateMonitoredItemsResponse

Re-exports CreateMonitoredItemsResponse

CreateSessionRequest

Re-exports CreateSessionRequest

CreateSessionResponse

Re-exports CreateSessionResponse

CreateSubscriptionRequest

Re-exports CreateSubscriptionRequest

CreateSubscriptionRequestOptions

Re-exports CreateSubscriptionRequestOptions

CreateSubscriptionResponse

Re-exports CreateSubscriptionResponse

DataChangeFilter

Re-exports DataChangeFilter

DataChangeNotification

Re-exports DataChangeNotification

DataChangeTrigger

Re-exports DataChangeTrigger

DeleteMonitoredItemsRequest

Re-exports DeleteMonitoredItemsRequest

DeleteMonitoredItemsRequestOptions

Re-exports DeleteMonitoredItemsRequestOptions

DeleteMonitoredItemsResponse

Re-exports DeleteMonitoredItemsResponse

DeleteSubscriptionsRequest

Re-exports DeleteSubscriptionsRequest

DeleteSubscriptionsRequestOptions

Re-exports DeleteSubscriptionsRequestOptions

DeleteSubscriptionsResponse

Re-exports DeleteSubscriptionsResponse

ElementOperand

Re-exports ElementOperand

ElementOperandOptions

Re-exports ElementOperandOptions

EndpointDescription

Re-exports EndpointDescription

EventFieldList

Re-exports EventFieldList

EventFilter

Re-exports EventFilter

EventFilterOptions

Re-exports EventFilterOptions

EventFilterResult

Re-exports EventFilterResult

EventNotificationList

Re-exports EventNotificationList

ExpandedNodeId

Re-exports ExpandedNodeId

ExtensionObject

Re-exports ExtensionObject

ExtraDataTypeManager

Re-exports ExtraDataTypeManager

FilterOperand

Re-exports FilterOperand

FilterOperandOptions

Re-exports FilterOperandOptions

FilterOperator

Re-exports FilterOperator

FindServersOnNetworkRequest

Re-exports FindServersOnNetworkRequest

FindServersOnNetworkRequestOptions

Re-exports FindServersOnNetworkRequestOptions

FindServersOnNetworkResponse

Re-exports FindServersOnNetworkResponse

FindServersRequest

Re-exports FindServersRequest

FindServersRequestOptions

Re-exports FindServersRequestOptions

FindServersResponse

Re-exports FindServersResponse

GetEndpointsRequest

Re-exports GetEndpointsRequest

GetEndpointsRequestOptions

Re-exports GetEndpointsRequestOptions

GetEndpointsResponse

Re-exports GetEndpointsResponse

HelloMessage

Re-exports HelloMessage

HistoryData

Re-exports HistoryData

HistoryModifiedData

Re-exports HistoryModifiedData

HistoryReadDetails

Re-exports HistoryReadDetails

HistoryReadRequest

Re-exports HistoryReadRequest

HistoryReadRequestOptions

Re-exports HistoryReadRequestOptions

HistoryReadResponse

Re-exports HistoryReadResponse

HistoryReadResult

Re-exports HistoryReadResult

HistoryReadValueId

Re-exports HistoryReadValueId

HistoryUpdateRequest

Re-exports HistoryUpdateRequest

HistoryUpdateResponse

Re-exports HistoryUpdateResponse

HistoryUpdateResult

Re-exports HistoryUpdateResult

HistoryUpdateType

Re-exports HistoryUpdateType

IBasicSession

Re-exports IBasicSession

ICertificateKeyPairProvider

Re-exports ICertificateKeyPairProvider

IssuedIdentityToken

Re-exports IssuedIdentityToken

LiteralOperand

Re-exports LiteralOperand

LiteralOperandOptions

Re-exports LiteralOperandOptions

MdnsDiscoveryConfiguration

Re-exports MdnsDiscoveryConfiguration

MessageChunker

Re-exports MessageChunker

MessageSecurityMode

Re-exports MessageSecurityMode

MethodId

Re-exports MethodId

ModificationInfo

Re-exports ModificationInfo

ModifyMonitoredItemsRequest

Re-exports ModifyMonitoredItemsRequest

ModifyMonitoredItemsRequestOptions

Re-exports ModifyMonitoredItemsRequestOptions

ModifyMonitoredItemsResponse

Re-exports ModifyMonitoredItemsResponse

ModifySubscriptionRequest

Re-exports ModifySubscriptionRequest

ModifySubscriptionRequestOptions

Re-exports ModifySubscriptionRequestOptions

ModifySubscriptionResponse

Re-exports ModifySubscriptionResponse

MonitoredItemCreateRequest

Re-exports MonitoredItemCreateRequest

MonitoredItemCreateRequestOptions

Re-exports MonitoredItemCreateRequestOptions

MonitoredItemCreateResult

Re-exports MonitoredItemCreateResult

MonitoredItemModifyRequest

Re-exports MonitoredItemModifyRequest

MonitoredItemModifyResult

Re-exports MonitoredItemModifyResult

MonitoredItemNotification

Re-exports MonitoredItemNotification

MonitoringFilter

Re-exports MonitoringFilter

MonitoringFilterOptions

Re-exports MonitoringFilterOptions

MonitoringMode

Re-exports MonitoringMode

MonitoringParameters

Re-exports MonitoringParameters

MonitoringParametersOptions

Re-exports MonitoringParametersOptions

NodeId

Re-exports NodeId

NodeTypeDescription

Re-exports NodeTypeDescription

NotificationData

Re-exports NotificationData

NotificationMessage

Re-exports NotificationMessage

OpenSecureChannelRequest

Re-exports OpenSecureChannelRequest

OpenSecureChannelResponse

Re-exports OpenSecureChannelResponse

ParsingResult

Re-exports ParsingResult

PublishRequest

Re-exports PublishRequest

PublishResponse

Re-exports PublishResponse

QueryDataDescription

Re-exports QueryDataDescription

QueryDataSet

Re-exports QueryDataSet

QueryFirstRequest

Re-exports QueryFirstRequest

QueryFirstRequestOptions

Re-exports QueryFirstRequestOptions

QueryFirstResponse

Re-exports QueryFirstResponse

QueryNextRequest

Re-exports QueryNextRequest

QueryNextRequestOptions

Re-exports QueryNextRequestOptions

QueryNextResponse

Re-exports QueryNextResponse

ReadAtTimeDetails

Re-exports ReadAtTimeDetails

ReadEventDetails

Re-exports ReadEventDetails

ReadProcessedDetails

Re-exports ReadProcessedDetails

ReadRawModifiedDetails

Re-exports ReadRawModifiedDetails

ReadRequest

Re-exports ReadRequest

ReadRequestOptions

Re-exports ReadRequestOptions

ReadResponse

Re-exports ReadResponse

ReadResponseOptions

Re-exports ReadResponseOptions

ReadValueId

Re-exports ReadValueId

ReadValueIdOptions

Re-exports ReadValueIdOptions

ReferenceDescription

Re-exports ReferenceDescription

RegisterServer2Request

Re-exports RegisterServer2Request

RegisterServer2RequestOptions

Re-exports RegisterServer2RequestOptions

RegisterServer2Response

Re-exports RegisterServer2Response

RegisterServerRequest

Re-exports RegisterServerRequest

RegisterServerRequestOptions

Re-exports RegisterServerRequestOptions

RegisterServerResponse

Re-exports RegisterServerResponse

RegisteredServer

Re-exports RegisteredServer

RelativePath

Re-exports RelativePath

RelativePathElement

Re-exports RelativePathElement

RepublishRequest

Re-exports RepublishRequest

RepublishResponse

Re-exports RepublishResponse

RequestHeader

Re-exports RequestHeader

ResponseHeader

Re-exports ResponseHeader

SecurityPolicy

Re-exports SecurityPolicy

SecurityTokenRequestType

Re-exports SecurityTokenRequestType

ServerOnNetwork

Re-exports ServerOnNetwork

ServerState

Re-exports ServerState

ServiceCounterDataType

Re-exports ServiceCounterDataType

ServiceFault

Re-exports ServiceFault

SetMonitoringModeRequest

Re-exports SetMonitoringModeRequest

SetMonitoringModeRequestOptions

Re-exports SetMonitoringModeRequestOptions

SetMonitoringModeResponse

Re-exports SetMonitoringModeResponse

SetPublishingModeRequest

Re-exports SetPublishingModeRequest

SetPublishingModeRequestOptions

Re-exports SetPublishingModeRequestOptions

SetPublishingModeResponse

Re-exports SetPublishingModeResponse

SetTriggeringRequest

Re-exports SetTriggeringRequest

SetTriggeringRequestOptions

Re-exports SetTriggeringRequestOptions

SetTriggeringResponse

Re-exports SetTriggeringResponse

SignatureData

Re-exports SignatureData

SignedSoftwareCertificate

Re-exports SignedSoftwareCertificate

SimpleAttributeOperand

Re-exports SimpleAttributeOperand

SimpleAttributeOperandOptions

Re-exports SimpleAttributeOperandOptions

StatusChangeNotification

Re-exports StatusChangeNotification

StatusCode

Re-exports StatusCode

StatusCodes

Re-exports StatusCodes

SubscriptionAcknowledgement

Re-exports SubscriptionAcknowledgement

SymmetricAlgorithmSecurityHeader

Re-exports SymmetricAlgorithmSecurityHeader

TransferResult

Re-exports TransferResult

TransferSubscriptionsRequest

Re-exports TransferSubscriptionsRequest

TransferSubscriptionsRequestOptions

Re-exports TransferSubscriptionsRequestOptions

TransferSubscriptionsResponse

Re-exports TransferSubscriptionsResponse

TranslateBrowsePathsToNodeIdsRequest

Re-exports TranslateBrowsePathsToNodeIdsRequest

TranslateBrowsePathsToNodeIdsResponse

Re-exports TranslateBrowsePathsToNodeIdsResponse

UserIdentityToken

Re-exports UserIdentityToken

UserNameIdentityToken

Re-exports UserNameIdentityToken

UserTokenPolicy

Re-exports UserTokenPolicy

UserTokenType

Re-exports UserTokenType

ViewDescription

Re-exports ViewDescription

WriteRequest

Re-exports WriteRequest

WriteRequestOptions

Re-exports WriteRequestOptions

WriteResponse

Re-exports WriteResponse

WriteValue

Re-exports WriteValue

WriteValueOptions

Re-exports WriteValueOptions

X509IdentityToken

Re-exports X509IdentityToken

_announceServerOnMulticastSubnet

Re-exports _announceServerOnMulticastSubnet

_enumerationMessageSecurityMode

Re-exports _enumerationMessageSecurityMode

acquireBonjour

Re-exports acquireBonjour

assert

Re-exports assert

attributeNameById

Re-exports attributeNameById

browseAll

Re-exports browseAll

buffer_ellipsis

Re-exports buffer_ellipsis

capitalizeFirstLetter

Re-exports capitalizeFirstLetter

chooseSecurityHeader

Re-exports chooseSecurityHeader

coerceExpandedNodeId

Re-exports coerceExpandedNodeId

coerceNodeId

Re-exports coerceNodeId

compare_buffers

Re-exports compare_buffers

getFunctionParameterNames

Re-exports getFunctionParameterNames

getObjectClassName

Re-exports getObjectClassName

get_clock_tick

Re-exports get_clock_tick

hexDump

Re-exports hexDump

isValidAttributeId

Re-exports isValidAttributeId

lowerFirstLetter

Re-exports lowerFirstLetter

makeApplicationUrn

Re-exports makeApplicationUrn

makeExpandedNodeId

Re-exports makeExpandedNodeId

makeNodeId

Re-exports makeNodeId

releaseBonjour

Re-exports releaseBonjour

replaceBufferWithHexDump

Re-exports replaceBufferWithHexDump

resolveNodeId

Re-exports resolveNodeId

sameAnnouncement

Re-exports sameAnnouncement

sameNodeId

Re-exports sameNodeId

serverCapabilities

Re-exports serverCapabilities

setDeprecated

Re-exports setDeprecated

Type aliases

BrowseDescriptionLike

BrowseDescriptionLike: string | BrowseDescriptionOptions

ClientHandle

ClientHandle: number

CreateMonitoredItemsRequestLike

CreateMonitoredItemsRequestLike: CreateMonitoredItemsRequestOptions

CreateSecureChannelCallbackFunc

CreateSecureChannelCallbackFunc: (err: Error | null, secureChannel?: ClientSecureChannelLayer) => void

Type declaration

CreateSubscriptionRequestLike

CreateSubscriptionRequestLike: CreateSubscriptionRequestOptions

DataValueLike

DataValueLike: DataValueOptions | DataValue

DeleteMonitoredItemsRequestLike

DeleteMonitoredItemsRequestLike: DeleteMonitoredItemsRequestOptions

DeleteSubscriptionsRequestLike

DeleteSubscriptionsRequestLike: DeleteSubscriptionsRequestOptions

FindEndpointCallback

FindEndpointCallback: (err: Error | null, result?: FindEndpointResult) => void

Type declaration

FindServersOnNetworkRequestLike

FindServersOnNetworkRequestLike: FindServersOnNetworkRequestOptions

FindServersRequestLike

FindServersRequestLike: FindServersRequestOptions

LocalizedTextLike

LocalizedTextLike: LocalizedTextOptions | string

ModifyMonitoredItemsRequestLike

ModifyMonitoredItemsRequestLike: ModifyMonitoredItemsRequestOptions

ModifySubscriptionRequestLike

ModifySubscriptionRequestLike: ModifySubscriptionRequestOptions

NodeIdLikeOrWithNodeId

NodeIdLikeOrWithNodeId: NodeIdLike | { nodeId: NodeId }

NumberType

NumberType: number | number[]

QualifiedNameLike

QualifiedNameLike: QualifiedNameOptions | string

QueryFirstRequestLike

QueryFirstRequestLike: QueryFirstRequestOptions

Request

Request: RequestB | CloseSecureChannelRequest

Response

Response: ResponseB | ServiceFault

ResponseCallback

ResponseCallback<T>: (err: Error | null, response?: T) => void

Type parameters

  • T

Type declaration

    • (err: Error | null, response?: T): void

    • Parameters

      • err: Error | null
      • Optional response: T

      Returns void

SecurityHeader

SecurityHeader: AsymmetricAlgorithmSecurityHeader | SymmetricAlgorithmSecurityHeader

SetMonitoringModeRequestLike

SetMonitoringModeRequestLike: SetMonitoringModeRequestOptions

SubscriptionId

SubscriptionId: number

TransferSubscriptionsRequestLike

TransferSubscriptionsRequestLike: TransferSubscriptionsRequestOptions

UserIdentityInfo

UserIdentityInfo: AnonymousIdentity | UserIdentityInfoX509 | UserIdentityInfoUserName

VariantByteString

VariantByteString: VariantT<Buffer, ByteString>

VariantDouble

VariantDouble: VariantT<number, Double>

VariantLike

VariantLike: VariantOptions

VerifyBufferFunc

VerifyBufferFunc: (chunk: Buffer) => boolean

Type declaration

    • (chunk: Buffer): boolean

    • Parameters

      • chunk: Buffer

      Returns boolean

WithSessionFunc

WithSessionFunc: (session: ClientSession) => Promise<void>

Type declaration

WithSessionFuncP

WithSessionFuncP<T>: (session: ClientSession) => Promise<T>

Type parameters

  • T

Type declaration

WithSubscriptionFunc

WithSubscriptionFunc: (session: ClientSession, subscription: ClientSubscription) => Promise<void>

Type declaration

WithSubscriptionFuncP

WithSubscriptionFuncP<T>: (session: ClientSession, subscription: ClientSubscription) => Promise<T>

Type parameters

  • T

Type declaration

Variables

Const _enumerationBrowseDirection

_enumerationBrowseDirection: Enum

Const _enumerationDataType

_enumerationDataType: Enum

Const _enumerationResultMask

_enumerationResultMask: Enum

Const _enumerationTimestampsToReturn

_enumerationTimestampsToReturn: Enum

Const crypto_utils

crypto_utils: __module = ...

Const requestHandleNotSetValue

requestHandleNotSetValue: 3735928559 = 3735928559

Const schemaBrowseDirection

schemaBrowseDirection: { enumValues: typeof BrowseDirection; name: string }

Type declaration

Const schemaDiagnosticInfo

schemaDiagnosticInfo: StructuredTypeSchema

Const schemaEnumNodeClass

schemaEnumNodeClass: { documentation: string; enumValues: typeof NodeClass; name: string }

Type declaration

  • documentation: string
  • enumValues: typeof NodeClass
  • name: string

Const schemaQualifiedName

schemaQualifiedName: StructuredTypeSchema

Const schemaResultMask

schemaResultMask: { enumValues: typeof ResultMask; name: string }

Type declaration

Const schemaSessionAuthenticationToken

schemaSessionAuthenticationToken: { name: string; subType: string }

Type declaration

  • name: string
  • subType: string

Const schemaTimestampsToReturn

schemaTimestampsToReturn: { enumValues: typeof TimestampsToReturn; name: string }

Type declaration

Const utils

utils: __module = ...

Functions

accessLevelFlagToString

  • Parameters

    Returns string

acknowledgeCondition

  • Parameters

    Returns Promise<StatusCode>

acknwoledgeAllConditions

  • acknwoledgeAllConditions(session: ClientSession, message: string): Promise<void>

  • Parameters

    Returns Promise<void>

adjustVariant

  • Parameters

    Returns Variant

apply_timestamps

apply_timestamps_no_copy

asymmetricVerifyChunk

  • asymmetricVerifyChunk(self: CryptoFactory, chunk: Buffer, certificate: Certificate): boolean

  • Parameters

    Returns boolean

buildVariantArray

  • buildVariantArray(dataType: DataType, nbElements: number, defaultValue: any): any[] | Uint8Array | Uint16Array | Uint32Array | Int8Array | Int16Array | Int32Array | Float32Array | Float64Array

  • Parameters

    • dataType: DataType
    • nbElements: number
    • defaultValue: any

    Returns any[] | Uint8Array | Uint16Array | Uint32Array | Int8Array | Int16Array | Int32Array | Float32Array | Float64Array

callConditionRefresh

  • Parameters

    Returns Promise<void>

  • Parameters

    Returns void

check_flag

  • check_flag(value: number, mask: number | { value: number }): boolean

  • check if a set of bits are set in the values

    method

    check_flag

    Parameters

    • value: number
    • mask: number | { value: number }

    Returns boolean

Const coerceAccessLevelFlag

  • Parameters

    • str: string | number | null

    Returns AccessLevelFlag

coerceConnectionStrategy

coerceLocalizedText

coerceMessageSecurityMode

  • Parameters

    • Optional value: number | string

    Returns MessageSecurityMode

coerceQualifiedName

  • Parameters

    • value: null

    Returns null

  • Parameters

    Returns QualifiedName

  • Parameters

    • value: string

    Returns QualifiedName

coerceSecurityPolicy

  • Parameters

    • Optional value: any

    Returns SecurityPolicy

coerceTimestampsToReturn

  • Parameters

    • value: number | null | undefined

    Returns TimestampsToReturn

coerceVariantType

  • coerceVariantType(dataType: DataType, value: any): any

  • Parameters

    Returns any

computeDerivedKeys

  • Parameters

    Returns DerivedKeys1

computeSignature

  • computeSignature(senderCertificate: Buffer | null, senderNonce: Nonce | null, receiverPrivateKey: PrivateKeyPEM | null, securityPolicy: SecurityPolicy): SignatureData | undefined

  • Parameters

    • senderCertificate: Buffer | null
    • senderNonce: Nonce | null
    • receiverPrivateKey: PrivateKeyPEM | null
    • securityPolicy: SecurityPolicy

    Returns SignatureData | undefined

confirmAllConditions

  • confirmAllConditions(session: ClientSession, message: string): Promise<void>

  • Parameters

    Returns Promise<void>

confirmCondition

  • Parameters

    Returns Promise<StatusCode>

constructBrowsePathFromQualifiedName

  • method

    constructBrowsePathFromQualifiedName

    Parameters

    Returns BrowsePath

constructEventFilter

  • helper to construct event filters: construct a simple event filter

    example
    constructEventFilter(["SourceName","Message","ReceiveTime"]);

constructEventFilter(["SourceName",{namespaceIndex:2 , "MyData"}]);
constructEventFilter(["SourceName","2:MyData" ]);

constructEventFilter(["SourceName" ,["EnabledState","EffectiveDisplayName"] ]);
constructEventFilter(["SourceName" ,"EnabledState.EffectiveDisplayName" ]);

    Parameters

    • arrayOfNames: string[] | string
    • Optional conditionTypes: NodeId[] | NodeId

    Returns EventFilter

convertAccessLevelFlagToByte

  • Parameters

    Returns number

convertDataTypeDefinitionToStructureTypeSchema

  • convertDataTypeDefinitionToStructureTypeSchema(session: IBasicSession, dataTypeNodeId: NodeId, name: string, definition: DataTypeDefinition, dataTypeFactory: DataTypeFactory, cache: {}): Promise<StructuredTypeSchema>

  • Parameters

    Returns Promise<StructuredTypeSchema>

decodeAccessLevelFlag

decodeBrowseDirection

decodeDataValue

decodeDiagnosticInfo

decodeLocalizedText

decodeQualifiedName

decodeTimestampsToReturn

dumpEvent

  • Parameters

    Returns Promise<void>

encodeAccessLevelFlag

  • encodeAccessLevelFlag(value: AccessLevelFlag, stream: OutputBinaryStream): void

  • Parameters

    Returns void

encodeBrowseDirection

  • encodeBrowseDirection(value: BrowseDirection, stream: OutputBinaryStream): void

  • Parameters

    Returns void

encodeDataValue

  • encodeDataValue(dataValue: DataValue, stream: OutputBinaryStream): void

  • Parameters

    • dataValue: DataValue
    • stream: OutputBinaryStream

    Returns void

encodeDiagnosticInfo

  • encodeDiagnosticInfo(value: DiagnosticInfo | null, stream: OutputBinaryStream): void

  • Parameters

    Returns void

encodeLocalizedText

  • encodeLocalizedText(value: LocalizedText, stream: OutputBinaryStream): void

  • Parameters

    Returns void

encodeQualifiedName

  • encodeQualifiedName(value: QualifiedName, stream: OutputBinaryStream): void

  • Parameters

    Returns void

encodeTimestampsToReturn

  • Parameters

    Returns void

extractConditionFields

  • Parameters

    Returns Promise<string[]>

extractFirstCertificateInChain

  • extractFirstCertificateInChain(certificateChain?: Buffer | null): Buffer | null

  • Parameters

    • Optional certificateChain: Buffer | null

    Returns Buffer | null

extractRange

  • return a deep copy of the dataValue by applying indexRange if necessary on Array/Matrix

    Parameters

    • dataValue: DataValue
    • indexRange: NumericalRange

    Returns DataValue

fieldsToJson

  • Parameters

    • fields: string[]
    • eventFields: Variant[]

    Returns EventStuff

findActiveConditions

  • Enumerate all events

    Parameters

    Returns Promise<EventStuff[]>

findServers

  • findServers(discoveryServerEndpointUri: string, callback: (err: Error | null, result?: FindServerResults) => void): void
  • findServers(discoveryServerEndpointUri: string): Promise<FindServerResults>

  • extract the server endpoints exposed by a discovery server

    method

    findServers

    async

    Parameters

    Returns void

  • Parameters

    • discoveryServerEndpointUri: string

    Returns Promise<FindServerResults>

findServersOnNetwork

  • findServersOnNetwork(discoveryServerEndpointUri: string): Promise<ServerOnNetwork[]>
  • findServersOnNetwork(discoveryServerEndpointUri: string, callback: (err: Error | null, servers?: ServerOnNetwork[]) => void): void

  • extract the server endpoints exposed by a discovery server

    Parameters

    • discoveryServerEndpointUri: string

    Returns Promise<ServerOnNetwork[]>

  • Parameters

    • discoveryServerEndpointUri: string
    • callback: (err: Error | null, servers?: ServerOnNetwork[]) => void

    Returns void

fromURI

  • Parameters

    • uri: string | null

    Returns SecurityPolicy

getCryptoFactory

  • Parameters

    Returns CryptoFactory | null

getDataTypeDefinition

  • Parameters

    Returns Promise<StructuredTypeSchema>

getExtraDataTypeManager

  • Parameters

    Returns Promise<any>

getOptionsForSymmetricSignAndEncrypt

getThumbprint

  • getThumbprint(certificateChain: Buffer | null): Buffer | null

  • Parameters

    • certificateChain: Buffer | null

    Returns Buffer | null

hasTokenExpired

  • Parameters

    Returns boolean

installAlarmMonitoring

  • Parameters

    Returns Promise<ClientAlarmList>

isDataEncoding

  • isDataEncoding(dataEncoding: any): boolean

  • Parameters

    • dataEncoding: any

    Returns boolean

isEmptyNonce

  • isEmptyNonce(nonce: Buffer): boolean

  • returns true if the nonce is null or zero (all bytes set to 0)

    Parameters

    • nonce: Buffer

    Returns boolean

isNullOrUndefined

  • isNullOrUndefined(value: any): boolean

  • Parameters

    • value: any

    Returns boolean

isOutsideDeadbandAbsolute

  • isOutsideDeadbandAbsolute(variant1: Variant, variant2: Variant, deadbandValue: number): boolean
  • method

    isOutsideDeadbandAbsolute

    Parameters

    Returns boolean

    true if the element is in deadBand

isOutsideDeadbandNone

  • isOutsideDeadbandNone(variant1: Variant, variant2: Variant): boolean
  • method

    isOutsideDeadbandNone

    Parameters

    Returns boolean

    true if the element is in deadBand

isOutsideDeadbandPercent

  • method

    isOutsideDeadband

    Parameters

    Returns boolean

    true if the element is outside deadBand

isValidDataEncoding

  • Parameters

    Returns boolean

isValidVariant

  • Parameters

    Returns boolean

makeAccessLevelFlag

  • Parameters

    • str: string | number | null

    Returns AccessLevelFlag

makeBrowsePath

  • Parameters

    Returns BrowsePath

makeNodeClassMask

  • Parameters

    • str: string

    Returns NodeClassMask

makeRelativePath

  • makeRelativePath(str: string, addressSpace?: any): RelativePath

  • construct a RelativePath from a string containing the relative path description. The string must comply to the OPCUA BNF for RelativePath ( see part 4 - Annexe A)

    method

    makeRelativePath

    example:
     var relativePath = makeRelativePath("/Server.ServerStatus.CurrentTime");

    Parameters

    • str: string
    • Optional addressSpace: any

    Returns RelativePath

makeResultMask

  • Parameters

    • str: string

    Returns ResultMask

matchUri

  • matchUri(endpointUri1: string | null, endpointUri2: string | null): boolean

  • returns true if two endpoint matches the same address:

    see

    https://www.dnscheck.co/faq

    see

    https://tools.ietf.org/html/rfc4343 : Domain Name System (DNS) Case Insensitivity Clarification

    Parameters

    • endpointUri1: string | null
    • endpointUri2: string | null

    Returns boolean

messageHeaderToString

  • messageHeaderToString(messageChunk: Buffer): string

  • convert the messageChunk header to a string

    method

    messageHeaderToString

    Parameters

    • messageChunk: Buffer

    Returns string

nonceAlreadyBeenUsed

  • nonceAlreadyBeenUsed(nonce?: Buffer): boolean

  • Parameters

    • Optional nonce: Buffer

    Returns boolean

performCertificateSanityCheck

  • performCertificateSanityCheck(serverOrClient: "server" | "client", certificateManager: OPCUACertificateManager, applicationUri: string): Promise<void>

  • Parameters

    Returns Promise<void>

populateDataTypeManager

  • Extract all custom dataType

    async

    Parameters

    Returns Promise<void>

promoteOpaqueStructure

  • Parameters

    Returns Promise<void>

randomAccessLevel

  • Returns AccessLevelFlag

readHistoryServerCapabilities

readUAAnalogItem

resolveDynamicExtensionObject

  • Parameters

    Returns void

sameDataValue

  • method

    sameDataValue

    Parameters

    Returns boolean

    true if data values are identical

sameStatusCode

  • Parameters

    Returns boolean

sameVariant

  • returns true if the two variant represent the same value

    Parameters

    • v1: Variant

      the first variant to compare

    • v2: Variant

      the variant to compare with

    Returns boolean

serverTimestampHasChanged

  • Parameters

    Returns boolean

set_flag

  • set_flag(value: number, mask: number | { value: number }): number

  • set a flag

    method

    set_flag

    Parameters

    • value: number
    • mask: number | { value: number }

    Returns number

simpleAttributeOperandToShortString

  • method

    toShortString

    example:

    Parameters

    Returns string

sourceTimestampHasChanged

  • Parameters

    Returns boolean

stringToQualifiedName

  • method

    stringToQualifiedName

    example

    stringToQualifiedName("Hello") => {namespaceIndex: 0, name: "Hello"} stringToQualifiedName("3:Hello") => {namespaceIndex: 3, name: "Hello"}

    Parameters

    • value: string

    Returns QualifiedName

timestamp

  • timestamp(): string

  • Returns string

timestampHasChanged

  • Parameters

    Returns boolean

toURI

  • Parameters

    Returns string

uninstallAlarmMonitoring

  • uninstallAlarmMonitoring(session: ClientSession): Promise<void>

  • Parameters

    Returns Promise<void>

verifyIsOPCUAValidCertificate

  • verifyIsOPCUAValidCertificate(certificate: Certificate, certificateFile: string, type: "client" | "server", applicationUri: string): void

  • Parameters

    • certificate: Certificate
    • certificateFile: string
    • type: "client" | "server"
    • applicationUri: string

    Returns void

verifySignature

  • verifySignature(receiverCertificate: Buffer, receiverNonce: Buffer, signature: SignatureData, senderCertificate: Buffer, securityPolicy: SecurityPolicy): boolean

  • Parameters

    Returns boolean

Generated using TypeDoc