The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.1.0-pre

    • APIs

    Show:

    CreateSessionRequest Class

    Extends BaseUAObject
    Defined in: packages\node-opcua-service-session\index.js:7
    Module: services.session

    Creates a new session with the server.

    Constructor

    CreateSessionRequest

    (
    • options
    )

    Defined in packages\node-opcua-service-session\index.js:7

    Parameters:

    • options Object
      • [requestHeader] RequestHeader optional
      • [clientDescription] ApplicationDescription optional

        Describes the client application.

      • [serverUri] String optional

        The URI of the server that the client wants to create a session with.

      • [endpointUrl] String optional

        The URL that the client used to connect to the server.

      • [sessionName] String optional

        A name for the session provided by the client.

      • [clientNonce] ByteString optional

        A random number generated by the client.

      • [clientCertificate] ByteString optional

        The application certificate for the client.

      • [requestedSessionTimeout] Duration optional

        The requested session timeout in milliseconds.

      • [maxResponseMessageSize] UInt32 optional

        The maximum message size accepted by the client.

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

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-session\_generated_\_auto_generated_CreateSessionRequest.js:154

    decode the object from a binary stream

    Parameters:

    encode

    (
    • stream
    )

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-session\_generated_\_auto_generated_CreateSessionRequest.js:135

    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

    clientCertificate

    ByteString

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-session\_generated_\_auto_generated_CreateSessionRequest.js:99

    The application certificate for the client.

    clientNonce

    ByteString

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-session\_generated_\_auto_generated_CreateSessionRequest.js:92

    A random number generated by the client.

    endpointUrl

    String

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-session\_generated_\_auto_generated_CreateSessionRequest.js:78

    The URL that the client used to connect to the server.

    maxResponseMessageSize

    UInt32

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-session\_generated_\_auto_generated_CreateSessionRequest.js:113

    The maximum message size accepted by the client.

    requestedSessionTimeout

    Duration

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-session\_generated_\_auto_generated_CreateSessionRequest.js:106

    The requested session timeout in milliseconds.

    serverUri

    String

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-session\_generated_\_auto_generated_CreateSessionRequest.js:71

    The URI of the server that the client wants to create a session with.

    sessionName

    String

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-session\_generated_\_auto_generated_CreateSessionRequest.js:85

    A name for the session provided by the client.