APIs

Show:

Closes a session with the server.

Constructor

CancelResponse

(
  • options
)

Parameters:

  • options Object
    • [responseHeader] ResponseHeader optional

      A standard header included in all responses returned by servers.

    • [CancelCount] UInt32 optional

      The number of requests successfully cancelled.

Methods

binaryStoreSize

() Number

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

Returns:

Number:

decode

(
  • stream
  • [option]
)

decode the object from a binary stream

Parameters:

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

CancelCount

UInt32

The number of requests successfully cancelled.

responseHeader

ResponseHeader

A standard header included in all responses returned by servers.