API Docs for: 0.0.57
Show:

CreateSessionRequest Class

Creates a new session with the server.

Constructor

CreateSessionRequest

(
  • options
)

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
Calculate the required size to store this object in a binary stream.

Returns:

Number:

decode_debug

()

encode

(
  • stream
)

encode the object into a binary stream

Parameters:

isValid

() Boolean
verify that all object attributes values are valid according to schema

Returns:

Boolean:

toString

() String

Returns:

String:

Properties

clientCertificate

ByteString

The application certificate for the client.

clientDescription

ApplicationDescription

Describes the client application.

clientNonce

ByteString

A random number generated by the client.

endpointUrl

String

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

maxResponseMessageSize

UInt32

The maximum message size accepted by the client.

requestedSessionTimeout

Duration

The requested session timeout in milliseconds.

serverUri

String

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

sessionName

String

A name for the session provided by the client.