Class Routing

A Routing control Data packet handled by the routing module

Generated

from message meshtastic.Routing

Hierarchy

Constructors

constructor

Properties

variant fields runtime typeName

Methods

clone equals fromBinary fromJson fromJsonString getType toBinary toJSON toJson toJsonString equals fromBinary fromJson fromJsonString

Constructors

constructor

  • new Routing(data?): Routing

  • Parameters

    • Optional data: PartialMessage<Routing>

    Returns Routing

Properties

variant

variant: {
    case: "routeRequest";
    value: RouteDiscovery;
} | {
    case: "routeReply";
    value: RouteDiscovery;
} | {
    case: "errorReason";
    value: Routing_Error;
} | {
    case: undefined;
    value?: undefined;
}

Type declaration

  • case: "routeRequest"
  • value: RouteDiscovery

    A route request going from the requester

    Generated

    from field: meshtastic.RouteDiscovery route_request = 1;

Type declaration

  • case: "routeReply"
  • value: RouteDiscovery

    A route reply

    Generated

    from field: meshtastic.RouteDiscovery route_reply = 2;

Type declaration

  • case: "errorReason"
  • value: Routing_Error

    A failure in delivering a message (usually used for routing control messages, but might be provided in addition to ack.fail_id to provide details on the type of failure).

    Generated

    from field: meshtastic.Routing.Error error_reason = 3;

Type declaration

  • case: undefined
  • Optional value?: undefined

Generated

from oneof meshtastic.Routing.variant

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "meshtastic.Routing" = "meshtastic.Routing"

Methods

clone

  • clone(): Routing

  • Create a deep copy.

    Returns Routing

equals

  • equals(other): boolean

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • fromBinary(bytes, options?): this

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting existing keys.

    If a message field is already present, it will be merged with the new data.

    Parameters

    • bytes: Uint8Array
    • Optional options: Partial<BinaryReadOptions>

    Returns this

fromJson

  • fromJson(jsonValue, options?): this

  • Parse a message from a JSON value.

    Parameters

    • jsonValue: JsonValue
    • Optional options: Partial<JsonReadOptions>

    Returns this

fromJsonString

  • fromJsonString(jsonString, options?): this

  • Parse a message from a JSON string.

    Parameters

    • jsonString: string
    • Optional options: Partial<JsonReadOptions>

    Returns this

getType

  • getType(): MessageType<Routing>

  • Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.

    Returns MessageType<Routing>

toBinary

  • toBinary(options?): Uint8Array

  • Serialize the message to binary data.

    Parameters

    • Optional options: Partial<BinaryWriteOptions>

    Returns Uint8Array

Protected toJSON

  • toJSON(): JsonValue

  • Override for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).

    Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.

    This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.

    Returns JsonValue

toJson

  • toJson(options?): JsonValue

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • toJsonString(options?): string

  • Serialize the message to a JSON string.

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

  • equals(a, b): boolean

  • Parameters

    Returns boolean

Static fromBinary

  • fromBinary(bytes, options?): Routing

  • Parameters

    • bytes: Uint8Array
    • Optional options: Partial<BinaryReadOptions>

    Returns Routing

Static fromJson

  • fromJson(jsonValue, options?): Routing

  • Parameters

    • jsonValue: JsonValue
    • Optional options: Partial<JsonReadOptions>

    Returns Routing

Static fromJsonString

  • fromJsonString(jsonString, options?): Routing

  • Parameters

    • jsonString: string
    • Optional options: Partial<JsonReadOptions>

    Returns Routing

Settings

Member Visibility

Theme

On This Page

constructorvariantfieldsruntimetypeNamecloneequalsfromBinaryfromJsonfromJsonStringgetTypetoBinarytoJSONtoJsontoJsonStringequalsfromBinaryfromJsonfromJsonString

Generated using TypeDoc