Class HandshakeMessage

Represents a HandshakeMessage.

Hierarchy

  • HandshakeMessage

Implements

Constructors

Properties

clientFinish?: null | IClientFinish

HandshakeMessage clientFinish.

clientHello?: null | IClientHello

HandshakeMessage clientHello.

serverHello?: null | IServerHello

HandshakeMessage serverHello.

Methods

  • Converts this HandshakeMessage to JSON.

    Returns {
        [k: string]: any;
    }

    JSON object

    • [k: string]: any
  • Decodes a HandshakeMessage message from the specified reader or buffer.

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    • Optional length: number

      Message length if known beforehand

    Returns HandshakeMessage

    HandshakeMessage

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

  • Decodes a HandshakeMessage message from the specified reader or buffer, length delimited.

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns HandshakeMessage

    HandshakeMessage

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

  • Encodes the specified HandshakeMessage message. Does not implicitly verify messages.

    Parameters

    • message: IHandshakeMessage

      HandshakeMessage message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

  • Encodes the specified HandshakeMessage message, length delimited. Does not implicitly verify messages.

    Parameters

    • message: IHandshakeMessage

      HandshakeMessage message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

  • Creates a HandshakeMessage message from a plain object. Also converts values to their respective internal types.

    Parameters

    • object: {
          [k: string]: any;
      }

      Plain object

      • [k: string]: any

    Returns HandshakeMessage

    HandshakeMessage

  • Creates a plain object from a HandshakeMessage message. Also converts values to other types if specified.

    Parameters

    • message: HandshakeMessage

      HandshakeMessage

    • Optional options: IConversionOptions

      Conversion options

    Returns {
        [k: string]: any;
    }

    Plain object

    • [k: string]: any
  • Verifies a HandshakeMessage message.

    Parameters

    • message: {
          [k: string]: any;
      }

      Plain object to verify

      • [k: string]: any

    Returns null | string

    null if valid, otherwise the reason why it is not

Generated using TypeDoc