The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.1.0-pre

    • APIs

    Show:

    CreateSessionResponse Class

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

    Creates a new session with the server.

    Constructor

    CreateSessionResponse

    (
    • options
    )

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

    Parameters:

    • options Object
      • [responseHeader] ResponseHeader optional

        A standard header included in all responses returned by servers.

      • [sessionId] NodeId optional

        A identifier which uniquely identifies the session.

      • [authenticationToken] SessionAuthenticationToken optional

        The token used to authenticate the client in subsequent requests.

      • [revisedSessionTimeout] Duration optional

        The session timeout in milliseconds.

      • [serverNonce] ByteString optional

        A random number generated by the server.

      • [serverCertificate] ByteString optional

        The application certificate for the server.

      • [serverEndpoints] EndpointDescription[] optional

        The endpoints provided by the server.

      • [serverSoftwareCertificates] SignedSoftwareCertificate[] optional

        The software certificates owned by the server.

      • [serverSignature] SignatureData optional

        A signature created with the server certificate.

      • [maxRequestMessageSize] UInt32 optional

        The maximum message size accepted by the server.

    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_CreateSessionResponse.js:175

    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_CreateSessionResponse.js:155

    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

    authenticationToken

    SessionAuthenticationToken

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-session\_generated_\_auto_generated_CreateSessionResponse.js:74

    The token used to authenticate the client in subsequent requests.

    maxRequestMessageSize

    UInt32

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-session\_generated_\_auto_generated_CreateSessionResponse.js:131

    The maximum message size accepted by the server.

    responseHeader

    ResponseHeader

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-session\_generated_\_auto_generated_CreateSessionResponse.js:60

    A standard header included in all responses returned by servers.

    revisedSessionTimeout

    Duration

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-session\_generated_\_auto_generated_CreateSessionResponse.js:81

    The session timeout in milliseconds.

    serverCertificate

    ByteString

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-session\_generated_\_auto_generated_CreateSessionResponse.js:95

    The application certificate for the server.

    serverEndpoints

    EndpointDescription[]

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-session\_generated_\_auto_generated_CreateSessionResponse.js:102

    The endpoints provided by the server.

    serverNonce

    ByteString

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-session\_generated_\_auto_generated_CreateSessionResponse.js:88

    A random number generated by the server.

    serverSignature

    SignatureData

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-session\_generated_\_auto_generated_CreateSessionResponse.js:124

    A signature created with the server certificate.

    serverSoftwareCertificates

    SignedSoftwareCertificate[]

    Provided by the opcua.address_space.types module.

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

    The software certificates owned by the server.

    sessionId

    NodeId

    Provided by the opcua.address_space.types module.

    Defined in packages\node-opcua-service-session\_generated_\_auto_generated_CreateSessionResponse.js:67

    A identifier which uniquely identifies the session.