NM-1.0 ▶ NM ▶ IPRoutingRule

constructor

• new IPRoutingRule(addr_family: number): IPRoutingRule

  Parameters

  • addr_family: number

  Returns IPRoutingRule

Static$gtype

Since 1.18cmp

• cmp(other: IPRoutingRule): number

  Parameters

  • other: IPRoutingRule

    the other NM.IPRoutingRule instance to compare

  Returns number

  zero, a positive, or a negative integer to indicate equality or how the arguments compare.

  Since

  1.18

Since 1.18get_action

• get_action(): number

  Returns number

  the set action.

  Since

  1.18

Since 1.18get_addr_family

• get_addr_family(): number

  Returns number

  the address family of the rule. Either AF_INET or AF_INET6.

  Since

  1.18

Since 1.18get_destination_port_end

• get_destination_port_end(): number

  Returns number

  the destination port end setting.

  Since

  1.18

Since 1.18get_destination_port_start

• get_destination_port_start(): number

  Returns number

  the destination port start setting.

  Since

  1.18

Since 1.18get_from

• get_from(): string

  Returns string

  the set from/src parameter or null, if no value is set.

  Since

  1.18

Since 1.18get_from_len

• get_from_len(): number

  Returns number

  the set prefix length for the from/src parameter.

  Since

  1.18

Since 1.18get_fwmark

• get_fwmark(): number

  Returns number

  the fwmark setting.

  Since

  1.18

Since 1.18get_fwmask

• get_fwmask(): number

  Returns number

  the fwmask setting.

  Since

  1.18

Since 1.18get_iifname

• get_iifname(): string

  Returns string

  the set iifname or null if unset.

  Since

  1.18

Since 1.18get_invert

• get_invert(): boolean

  Returns boolean

  the "invert" setting of the rule.

  Since

  1.18

Since 1.18get_ipproto

• get_ipproto(): number

  Returns number

  the ipproto of the rule.

  Since

  1.18

Since 1.18get_oifname

• get_oifname(): string

  Returns string

  the set oifname or null if unset.

  Since

  1.18

Since 1.18get_priority

• get_priority(): number

  Returns number

  the priority. A valid priority is in the range from 0 to G_MAXUINT32. If unset, -1 is returned.

  Since

  1.18

Since 1.18get_source_port_end

• get_source_port_end(): number

  Returns number

  the source port end setting.

  Since

  1.18

Since 1.18get_source_port_start

• get_source_port_start(): number

  Returns number

  the source port start setting.

  Since

  1.18

Since 1.20get_suppress_prefixlength

• get_suppress_prefixlength(): number

  Returns number

  the suppress_prefixlength of the rule. -1 means that the value is unset.

  Since

  1.20

Since 1.18get_table

• get_table(): number

  Returns number

  the set table.

  Since

  1.18

Since 1.18get_to

• get_to(): string

  Returns string

  the set to/dst parameter or null, if no value is set.

  Since

  1.18

Since 1.18get_to_len

• get_to_len(): number

  Returns number

  the set prefix length for the to/dst parameter.

  Since

  1.18

Since 1.18get_tos

• get_tos(): number

  Returns number

  the tos of the rule.

  Since

  1.18

Since 1.34get_uid_range

• get_uid_range(): [boolean, number, number]

  Returns [boolean, number, number]

  true if a uid range is set. This API was wrongly introduced in the header files for 1.32, but the symbols were not exported. The API only works since 1.34 and newer.

  Since

  1.34

Since 1.18is_sealed

• is_sealed(): boolean

  Returns boolean

  whether self is sealed. Once sealed, an instance cannot be modified nor unsealed.

  Since

  1.18

Since 1.18new_clone

• new_clone(): IPRoutingRule

  Since 1.42, ref-counting of NM.IPRoutingRule is thread-safe.

  Returns IPRoutingRule

  a newly created rule instance with the same settings as rule. Note that the instance will always be unsealed.

  Since

  1.18

Since 1.18ref

• ref(): IPRoutingRule

  Increases the reference count of the instance.

  Returns IPRoutingRule

  the self argument with incremented reference count. Since 1.42, ref-counting of NM.IPRoutingRule is thread-safe.

  Since

  1.18

Since 1.18seal

• seal(): void

  Seals the routing rule. Afterwards, the instance can no longer be modified, and it is a bug to call any of the accessors that would modify the rule. If self was already sealed, this has no effect.

  Returns void

  Since

  1.18

Since 1.18set_action

• set_action(action: number): void

  Note that currently only certain actions are allowed. nm_ip_routing_rule_validate() will reject unsupported actions as invalid.

  Parameters

  • action: number

    the action to set

  Returns void

  Since

  1.18

Since 1.18set_destination_port

• set_destination_port(start: number, end: number): void

  Parameters

  • start: number

    the start port to set.

  • end: number

    the end port to set.

  Returns void

  Since

  1.18

Since 1.18set_from

• set_from(from: string, len: number): void

  Setting invalid values is accepted, but will later fail during nm_ip_routing_rule_validate().

  Parameters

  • from: string

    the from/src address to set. The address family must match.

  • len: number

    the corresponding prefix length of the address.

  Returns void

  Since

  1.18

Since 1.18set_fwmark

• set_fwmark(fwmark: number, fwmask: number): void

  Parameters

  • fwmark: number

    the fwmark

  • fwmask: number

    the fwmask

  Returns void

  Since

  1.18

Since 1.18set_iifname

• set_iifname(iifname: string): void

  The name supports C backslash escaping for non-UTF-8 characters. Note that nm_ip_routing_rule_from_string() too uses backslash escaping when tokenizing the words by whitespace. So, in string representation you'd get double backslashes.

  Parameters

  • iifname: string

    the iifname to set or null to unset.

  Returns void

  Since

  1.18

Since 1.18set_invert

• set_invert(invert: boolean): void

  Parameters

  • invert: boolean

    the new value to set

  Returns void

  Since

  1.18

Since 1.18set_ipproto

• set_ipproto(ipproto: number): void

  Parameters

  • ipproto: number

    the ipproto to set

  Returns void

  Since

  1.18

Since 1.18set_oifname

• set_oifname(oifname: string): void

  The name supports C backslash escaping for non-UTF-8 characters. Note that nm_ip_routing_rule_from_string() too uses backslash escaping when tokenizing the words by whitespace. So, in string representation you'd get double backslashes.

  Parameters

  • oifname: string

    the oifname to set or null to unset.

  Returns void

  Since

  1.18

Since 1.18set_priority

• set_priority(priority: number | bigint): void

  A valid priority ranges from 0 to G_MAXUINT32. "-1" is also allowed to reset the priority. It is a bug calling this function with any other value.

  Parameters

  • priority: number | bigint

    the priority to set

  Returns void

  Since

  1.18

Since 1.18set_source_port

• set_source_port(start: number, end: number): void

  Parameters

  • start: number

    the start port to set.

  • end: number

    the end port to set.

  Returns void

  Since

  1.18

Since 1.20set_suppress_prefixlength

• set_suppress_prefixlength(suppress_prefixlength: number): void

  Parameters

  • suppress_prefixlength: number

    the suppress_prefixlength to set. The value -1 means unset.

  Returns void

  Since

  1.20

Since 1.18set_table

• set_table(table: number): void

  Parameters

  • table: number

    the table to set

  Returns void

  Since

  1.18

Since 1.18set_to

• set_to(to: string, len: number): void

  Setting invalid values is accepted, but will later fail during nm_ip_routing_rule_validate().

  Parameters

  • to: string

    the to/dst address to set. The address family must match.

  • len: number

    the corresponding prefix length of the address. If to is null, this valid is ignored.

  Returns void

  Since

  1.18

Since 1.18set_tos

• set_tos(tos: number): void

  Parameters

  • tos: number

    the tos to set

  Returns void

  Since

  1.18

Since 1.34set_uid_range

• set_uid_range(uid_range_start: number, uid_range_end: number): void

  For a valid range, start must be less or equal to end. If set to an invalid range, the range gets unset.

  This API was wrongly introduced in the header files for 1.32, but the symbols were not exported. The API only works since 1.34 and newer.

  Parameters

  • uid_range_start: number

    the uid_range start to set.

  • uid_range_end: number

    the uid_range start to set.

  Returns void

  Since

  1.34

Since 1.18to_string

• to_string(
      to_string_flags: NM.IPRoutingRuleAsStringFlags,
      extra_args: null,
  ): string

  Parameters

  • to_string_flags: NM.IPRoutingRuleAsStringFlags

    NM.IPRoutingRuleAsStringFlags for controlling the string conversion.

  • extra_args: null

    extra arguments for controlling the string conversion. Currently, not extra arguments are supported.

  Returns string

  the string representation or null on error.

  Since

  1.18

  Throws

  GLib.Error

Since 1.18unref

• unref(): void

  Decreases the reference count of the instance and destroys the instance if the reference count reaches zero.

  Since 1.42, ref-counting of NM.IPRoutingRule is thread-safe.

  Returns void

  Since

  1.18

Since 1.18validate

• validate(): boolean

  Returns boolean

  true if the rule validates.

  Since

  1.18

  Throws

  GLib.Error

StaticSince 1.18from_string

• from_string(
      str: string,
      to_string_flags: NM.IPRoutingRuleAsStringFlags,
      extra_args: null,
  ): IPRoutingRule

  Parameters

  • str: string

    the string representation to convert to an NM.IPRoutingRule

  • to_string_flags: NM.IPRoutingRuleAsStringFlags

    NM.IPRoutingRuleAsStringFlags for controlling the string conversion.

  • extra_args: null

    extra arguments for controlling the string conversion. Currently, not extra arguments are supported.

  Returns IPRoutingRule

  Since

  1.18

Staticnew

• new(addr_family: number): IPRoutingRule

  Parameters

  • addr_family: number

  Returns IPRoutingRule