The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.1.0-pre

    • APIs

    Show:

    OpenSecureChannelRequest Class

    Extends BaseUAObject
    Defined in: packages\node-opcua-service-secure-channel\_generated_\_auto_generated_OpenSecureChannelRequest.js:28
    Module: opcua.address_space.types

    Constructor

    OpenSecureChannelRequest

    (
    • options
    )

    Defined in packages\node-opcua-service-secure-channel\_generated_\_auto_generated_OpenSecureChannelRequest.js:28

    Parameters:

    • options Object
      • [requestHeader] RequestHeader optional
      • [clientProtocolVersion] UInt32 optional

        The version of protocol used by the client

      • [requestType] SecurityTokenRequestType optional

        Whether the channel is being created or renewed

      • [securityMode] MessageSecurityMode optional

        The security mode to use with the channel.

      • [clientNonce] ByteString optional

        A random number generated by the client.

      • [requestedLifetime] UInt32 optional

        The channel lifetime in milliseconds.

    Methods

    binaryStoreSize

    () Number

    Inherited from BaseUAObject: packages\node-opcua-factory\src\factories_baseobject.js:49

    Calculate the required size to store this object in a binary stream.

    Returns:

    Number:

    decode

    (
    • stream
    • [option]
    )

    Defined in packages\node-opcua-service-secure-channel\_generated_\_auto_generated_OpenSecureChannelRequest.js:143

    decode the object from a binary stream

    Parameters:

    encode

    (
    • stream
    )

    Defined in packages\node-opcua-service-secure-channel\_generated_\_auto_generated_OpenSecureChannelRequest.js:127

    encode the object into a binary stream

    Parameters:

    isValid

    () Boolean

    Inherited from BaseUAObject: packages\node-opcua-factory\src\factories_baseobject.js:83

    verify that all object attributes values are valid according to schema

    Returns:

    Boolean:

    toString

    () String

    Inherited from BaseUAObject: packages\node-opcua-factory\src\factories_baseobject.js:61

    Returns:

    String:

    Properties

    clientNonce

    ByteString

    Defined in packages\node-opcua-service-secure-channel\_generated_\_auto_generated_OpenSecureChannelRequest.js:80

    A random number generated by the client.

    clientProtocolVersion

    UInt32

    Defined in packages\node-opcua-service-secure-channel\_generated_\_auto_generated_OpenSecureChannelRequest.js:59

    The version of protocol used by the client

    requestedLifetime

    UInt32

    Defined in packages\node-opcua-service-secure-channel\_generated_\_auto_generated_OpenSecureChannelRequest.js:87

    The channel lifetime in milliseconds.

    requestType

    SecurityTokenRequestType

    Defined in packages\node-opcua-service-secure-channel\_generated_\_auto_generated_OpenSecureChannelRequest.js:66

    Whether the channel is being created or renewed

    securityMode

    MessageSecurityMode

    Defined in packages\node-opcua-service-secure-channel\_generated_\_auto_generated_OpenSecureChannelRequest.js:73

    The security mode to use with the channel.