Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HandshakeMessage

Represents a HandshakeMessage.

Hierarchy

  • HandshakeMessage

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Optional clientFinish

clientFinish: IClientFinish

HandshakeMessage clientFinish.

Optional clientHello

clientHello: IClientHello

HandshakeMessage clientHello.

Optional serverHello

serverHello: IServerHello

HandshakeMessage serverHello.

Methods

toJSON

  • toJSON(): {}

  • Converts this HandshakeMessage to JSON.

    Returns {}

    JSON object

    • [k: string]: any

Static create

Static decode

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

    throws

    {Error} If the payload is not a reader or valid buffer

    throws

    {$protobuf.util.ProtocolError} If required fields are missing

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    • Optional length: number

    Returns HandshakeMessage

    HandshakeMessage

Static decodeDelimited

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

    throws

    {Error} If the payload is not a reader or valid buffer

    throws

    {$protobuf.util.ProtocolError} If required fields are missing

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns HandshakeMessage

    HandshakeMessage

Static encode

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

    Parameters

    • message: IHandshakeMessage

      HandshakeMessage message or plain object to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static encodeDelimited

  • 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

    Returns Writer

    Writer

Static fromObject

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

    Parameters

    • object: {}

      Plain object

      • [k: string]: any

    Returns HandshakeMessage

    HandshakeMessage

Static toObject

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

    Parameters

    • message: HandshakeMessage

      HandshakeMessage

    • Optional options: IConversionOptions

    Returns {}

    Plain object

    • [k: string]: any

Static verify

  • verify(message: {}): string

  • Verifies a HandshakeMessage message.

    Parameters

    • message: {}

      Plain object to verify

      • [k: string]: any

    Returns string

    null if valid, otherwise the reason why it is not

Generated using TypeDoc