Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents a PortOpen.

Hierarchy

  • PortOpen

Implements

Index

Constructors

constructor

  • Constructs a new PortOpen.

    Parameters

    Returns PortOpen

Properties

address

address: string

PortOpen address.

forwarded

forwarded: boolean

PortOpen forwarded.

port

port: number

PortOpen port.

Methods

toJSON

  • toJSON(): object
  • Converts this PortOpen to JSON.

    Returns object

    JSON object

    • [k: string]: any

Static create

  • Creates a new PortOpen instance using the specified properties.

    Parameters

    Returns PortOpen

    PortOpen instance

Static decode

  • decode(reader: Reader | Uint8Array, length?: undefined | number): PortOpen
  • Decodes a PortOpen 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: Reader | Uint8Array

      Reader or buffer to decode from

    • Optional length: undefined | number

    Returns PortOpen

    PortOpen

Static decodeDelimited

  • decodeDelimited(reader: Reader | Uint8Array): PortOpen
  • Decodes a PortOpen 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: Reader | Uint8Array

      Reader or buffer to decode from

    Returns PortOpen

    PortOpen

Static encode

  • encode(message: IPortOpen, writer?: $protobuf.Writer): Writer
  • Encodes the specified PortOpen message. Does not implicitly verify messages.

    Parameters

    • message: IPortOpen

      PortOpen message or plain object to encode

    • Optional writer: $protobuf.Writer

    Returns Writer

    Writer

Static encodeDelimited

  • encodeDelimited(message: IPortOpen, writer?: $protobuf.Writer): Writer
  • Encodes the specified PortOpen message, length delimited. Does not implicitly verify messages.

    Parameters

    • message: IPortOpen

      PortOpen message or plain object to encode

    • Optional writer: $protobuf.Writer

    Returns Writer

    Writer

Static fromObject

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

    Parameters

    • object: object

      Plain object

      • [k: string]: any

    Returns PortOpen

    PortOpen

Static toObject

  • toObject(message: PortOpen, options?: $protobuf.IConversionOptions): object
  • Creates a plain object from a PortOpen message. Also converts values to other types if specified.

    Parameters

    • message: PortOpen

      PortOpen

    • Optional options: $protobuf.IConversionOptions

    Returns object

    Plain object

    • [k: string]: any

Static verify

  • verify(message: object): null | string
  • Verifies a PortOpen message.

    Parameters

    • message: object

      Plain object to verify

      • [k: string]: any

    Returns null | string

    null if valid, otherwise the reason why it is not

Generated using TypeDoc