Class TCPErrorMessage

Hierarchy

  • BaseUAObject
    • TCPErrorMessage

Constructors

constructor

Properties

reason schema statusCode possibleFields

Methods

applyOnAllFields binaryStoreSize clone decode decodeDebug encode explore isValid toJSON toString

Constructors

constructor

  • new TCPErrorMessage(options?): TCPErrorMessage

  • Parameters

    • Optionaloptions: {
          reason?: string;
          statusCode?: StatusCode;
      }
      • Optionalreason?: string
      • OptionalstatusCode?: StatusCode

    Returns TCPErrorMessage

Properties

reason

reason: UAString

schema

schema: IStructuredTypeSchema

statusCode

statusCode: StatusCode

StaticpossibleFields

possibleFields: string[]

Methods

applyOnAllFields

  • applyOnAllFields<T>(func, data): void

  • Type Parameters

    • T

    Parameters

    • func: Func1<T>
    • data: T

    Returns void

binaryStoreSize

  • binaryStoreSize(): number

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

    Returns number

clone

  • clone(): any

  • Returns any

decode

  • decode(stream): void

  • Decode the object from the binary stream.

    Parameters

    Returns void

decodeDebug

  • decodeDebug(stream, options): void

  • Parameters

    Returns void

encode

  • encode(stream): void

  • Encode the object to the binary stream.

    Parameters

    • stream: OutputBinaryStream

    Returns void

explore

  • explore(): string

  • Returns string

isValid

  • isValid(): boolean

  • verify that all object attributes values are valid according to schema

    Returns boolean

toJSON

  • toJSON(): any

  • Returns any

toString

  • toString(...args): string

  • Parameters

    • Rest...args: any[]

    Returns string

Settings

Member Visibility

On This Page

Constructors
Properties
Methods