Class: Nl::Linux::RtRoute

Inherits:

Raw::Family

• Object
• Family
• Raw::Family
• Nl::Linux::RtRoute

Defined in:

nl-linux/generated/nl/linux/rt_route.rb

Overview

Route configuration over rtnetlink.

Defined Under Namespace

Modules: AttributeSets, Enums, Messages, Notifications, Structs Classes: AsyncOperations

Constant Summary

NAME =

"rt-route"

PROTONUM =

0

Class Method Summary

• .open(executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY) ⇒ Object

Instance Method Summary

• #async(stream_capacity: nil) ⇒ AsyncOperations

  Returns the asynchronous operation facade for this family.

• #do_delroute(**args) ⇒ void

  Delete an existing route.

• #do_getroute(**args) ⇒ Messages::DoGetrouteReply

  Dump route information.

• #do_newroute(**args) ⇒ void

  Create a new route.

• #dump_getroute(**args, &block) ⇒ Object

  Dump route information.

Class Method Details

.open(executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY) ⇒ RtRoute .open(executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY) {|family| ... } ⇒ Object

Overloads:

• .open(executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY) ⇒ RtRoute

  Parameters:

  • executor (Symbol, nil) (defaults to: nil)
  • notification_capacity (Integer, nil) (defaults to: DEFAULT_NOTIFICATION_CAPACITY)

  Returns:

  • (RtRoute)
• .open(executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY) {|family| ... } ⇒ Object

  Returns the result of the block.

  Parameters:

  • executor (Symbol, nil) (defaults to: nil)
  • notification_capacity (Integer, nil) (defaults to: DEFAULT_NOTIFICATION_CAPACITY)

  Yield Parameters:

  • family (RtRoute)

  Returns:

  • (Object) —

    the result of the block

# File 'nl-linux/generated/nl/linux/rt_route.rb', line 24

def self.open(executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY)
  super
end

Instance Method Details

#async(stream_capacity: nil) ⇒ AsyncOperations

Returns the asynchronous operation facade for this family.

Parameters:

• stream_capacity (::Integer, nil) (defaults to: nil)

Returns:

• (AsyncOperations)

# File 'nl-linux/generated/nl/linux/rt_route.rb', line 1750

def async(stream_capacity: nil)
  return @async_operations ||= build_async_facade(AsyncOperations) if stream_capacity.nil?
  build_async_facade(AsyncOperations, stream_capacity:)
end

#do_delroute(**args) ⇒ void

This method returns an undefined value.

Delete an existing route

Parameters:

• args (Hash)

Options Hash (**args):

• rtm_family (Integer)
• rtm_dst_len (Integer)
• rtm_src_len (Integer)
• rtm_tos (Integer)
• rtm_table (Integer)
• rtm_protocol (Integer)
• rtm_scope (Integer)
• rtm_type (Integer)
• rtm_flags (Integer)
• dst (String)
• src (String)
• iif (Integer)
• oif (Integer)
• gateway (String)
• priority (Integer)
• prefsrc (String)
• metrics (AttributeSets::Metrics, Hash<Symbol, Object>)
• multipath (String)
• flow (Integer)
• cacheinfo (Structs::RtaCacheinfo, Hash<Symbol, Object>)
• table (Integer)
• mark (Integer)
• mfc_stats (String)
• via (String)
• newdst (String)
• pref (Integer)
• encap_type (Integer)
• encap (String)
• expires (Integer)
• pad (String)
• uid (Integer)
• ttl_propagate (Integer)
• ip_proto (Integer)
• sport (Integer)
• dport (Integer)
• nh_id (Integer)
• flowlabel (Integer)

See Also:

• Nl::Linux::RtRoute::Messages::DoDelrouteRequest

# File 'nl-linux/generated/nl/linux/rt_route.rb', line 1603

def do_delroute(**args)
  exchange_message(:"do", Messages::DoDelrouteRequest, nil, args)
end

#do_getroute(**args) ⇒ Messages::DoGetrouteReply

Dump route information.

Parameters:

• args (Hash)

Options Hash (**args):

• rtm_family (Integer)
• rtm_dst_len (Integer)
• rtm_src_len (Integer)
• rtm_tos (Integer)
• rtm_table (Integer)
• rtm_protocol (Integer)
• rtm_scope (Integer)
• rtm_type (Integer)
• rtm_flags (Integer)
• dst (String)
• src (String)
• iif (Integer)
• oif (Integer)
• mark (Integer)
• uid (Integer)
• ip_proto (Integer)
• sport (Integer)
• dport (Integer)
• flowlabel (Integer)

Returns:

• (Messages::DoGetrouteReply)

See Also:

• Nl::Linux::RtRoute::Messages::DoGetrouteRequest

# File 'nl-linux/generated/nl/linux/rt_route.rb', line 1479

def do_getroute(**args)
  exchange_message(:"do", Messages::DoGetrouteRequest, Messages::DoGetrouteReply, args)
end

#do_newroute(**args) ⇒ void

This method returns an undefined value.

Create a new route

Parameters:

• args (Hash)

Options Hash (**args):

• rtm_family (Integer)
• rtm_dst_len (Integer)
• rtm_src_len (Integer)
• rtm_tos (Integer)
• rtm_table (Integer)
• rtm_protocol (Integer)
• rtm_scope (Integer)
• rtm_type (Integer)
• rtm_flags (Integer)
• dst (String)
• src (String)
• iif (Integer)
• oif (Integer)
• gateway (String)
• priority (Integer)
• prefsrc (String)
• metrics (AttributeSets::Metrics, Hash<Symbol, Object>)
• multipath (String)
• flow (Integer)
• cacheinfo (Structs::RtaCacheinfo, Hash<Symbol, Object>)
• table (Integer)
• mark (Integer)
• mfc_stats (String)
• via (String)
• newdst (String)
• pref (Integer)
• encap_type (Integer)
• encap (String)
• expires (Integer)
• pad (String)
• uid (Integer)
• ttl_propagate (Integer)
• ip_proto (Integer)
• sport (Integer)
• dport (Integer)
• nh_id (Integer)
• flowlabel (Integer)

See Also:

• Nl::Linux::RtRoute::Messages::DoNewrouteRequest

# File 'nl-linux/generated/nl/linux/rt_route.rb', line 1558

def do_newroute(**args)
  exchange_message(:"do", Messages::DoNewrouteRequest, nil, args)
end

#dump_getroute(**args) ⇒ Array<Messages::DumpGetrouteReply> #dump_getroute(**args) {|reply| ... } ⇒ void

Dump route information.

Overloads:

• #dump_getroute(**args) ⇒ Array<Messages::DumpGetrouteReply>

  Returns an array when no block is given.

  Parameters:

  • args (Hash)

  Options Hash (**args):

  • rtm_family (Integer)
  • rtm_dst_len (Integer)
  • rtm_src_len (Integer)
  • rtm_tos (Integer)
  • rtm_table (Integer)
  • rtm_protocol (Integer)
  • rtm_scope (Integer)
  • rtm_type (Integer)
  • rtm_flags (Integer)

  Returns:

  • (Array<Messages::DumpGetrouteReply>)
• #dump_getroute(**args) {|reply| ... } ⇒ void

  This method returns an undefined value.

  Yields each reply when a block is given.

  Parameters:

  • args (Hash)

  Options Hash (**args):

  • rtm_family (Integer)
  • rtm_dst_len (Integer)
  • rtm_src_len (Integer)
  • rtm_tos (Integer)
  • rtm_table (Integer)
  • rtm_protocol (Integer)
  • rtm_scope (Integer)
  • rtm_type (Integer)
  • rtm_flags (Integer)

  Yield Parameters:

  • reply (Messages::DumpGetrouteReply)

See Also:

• Nl::Linux::RtRoute::Messages::DumpGetrouteRequest

# File 'nl-linux/generated/nl/linux/rt_route.rb', line 1513

def dump_getroute(**args, &block)
  exchange_message(:"dump", Messages::DumpGetrouteRequest, Messages::DumpGetrouteReply, args, &block)
end