Class: Nl::Linux::RtLink

Inherits:

Raw::Family

• Object
• Family
• Raw::Family
• Nl::Linux::RtLink

Defined in:

nl-linux/generated/nl/linux/rt_link.rb

Overview

Link configuration over rtnetlink.

Defined Under Namespace

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

Constant Summary

NAME =

"rt-link"

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_dellink(**args) ⇒ void

  Delete an existing link.

• #do_getlink(**args) ⇒ Messages::DoGetlinkReply

  Get / dump information about a link.

• #do_getstats(**args) ⇒ Messages::DoGetstatsReply

  Get / dump link stats.

• #do_newlink(**args) ⇒ void

  Create a new link.

• #do_setlink(**args) ⇒ void

  Set information about a link.

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

  Get / dump information about a link.

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

  Get / dump link stats.

• #subscribe(*groups) ⇒ self
• #unsubscribe(*groups) ⇒ self

Class Method Details

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

Overloads:

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

  Parameters:

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

  Returns:

  • (RtLink)
• .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 (RtLink)

  Returns:

  • (Object) —

    the result of the block

# File 'nl-linux/generated/nl/linux/rt_link.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_link.rb', line 10198

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

#do_dellink(**args) ⇒ void

This method returns an undefined value.

Delete an existing link.

Parameters:

• args (Hash)

Options Hash (**args):

• ifi_family (Integer)
• ifi_type (Integer)
• ifi_index (Integer)
• ifi_flags (Integer)
• ifi_change (Integer)
• ifname (String)

See Also:

• Nl::Linux::RtLink::Messages::DoDellinkRequest

# File 'nl-linux/generated/nl/linux/rt_link.rb', line 9851

def do_dellink(**args)
  exchange_message(:"do", Messages::DoDellinkRequest, nil, args)
end

#do_getlink(**args) ⇒ Messages::DoGetlinkReply

Get / dump information about a link.

Parameters:

• args (Hash)

Options Hash (**args):

• ifi_family (Integer)
• ifi_type (Integer)
• ifi_index (Integer)
• ifi_flags (Integer)
• ifi_change (Integer)
• ifname (String)
• ext_mask (Integer) —

  Known flags are defined in Nl::Linux::RtLink::Flags::RtextFilter.

• target_netnsid (Integer)
• alt_ifname (String)

Returns:

• (Messages::DoGetlinkReply)

See Also:

• Nl::Linux::RtLink::Messages::DoGetlinkRequest

# File 'nl-linux/generated/nl/linux/rt_link.rb', line 9868

def do_getlink(**args)
  exchange_message(:"do", Messages::DoGetlinkRequest, Messages::DoGetlinkReply, args)
end

#do_getstats(**args) ⇒ Messages::DoGetstatsReply

Get / dump link stats.

Parameters:

• args (Hash)

Options Hash (**args):

• family (Integer)
• ifindex (Integer)
• filter_mask (Integer)

Returns:

• (Messages::DoGetstatsReply)

See Also:

• Nl::Linux::RtLink::Messages::DoGetstatsRequest

# File 'nl-linux/generated/nl/linux/rt_link.rb', line 9986

def do_getstats(**args)
  exchange_message(:"do", Messages::DoGetstatsRequest, Messages::DoGetstatsReply, args)
end

#do_newlink(**args) ⇒ void

This method returns an undefined value.

Create a new link.

Parameters:

• args (Hash)

Options Hash (**args):

• ifi_family (Integer)
• ifi_type (Integer)
• ifi_index (Integer)
• ifi_flags (Integer)
• ifi_change (Integer)
• address (String)
• broadcast (String)
• ifname (String)
• mtu (Integer)
• txqlen (Integer)
• operstate (Integer)
• linkmode (Integer)
• linkinfo (AttributeSets::LinkinfoAttrs, Hash<Symbol, Object>)
• net_ns_pid (Integer)
• af_spec (AttributeSets::AfSpecAttrs, Hash<Symbol, Object>)
• group (Integer)
• net_ns_fd (Integer)
• num_tx_queues (Integer)
• num_rx_queues (Integer)
• link_netnsid (Integer)
• gso_max_segs (Integer)
• gso_max_size (Integer)
• target_netnsid (Integer)
• gro_max_size (Integer)
• gso_ipv4_max_size (Integer)
• gro_ipv4_max_size (Integer)

See Also:

• Nl::Linux::RtLink::Messages::DoNewlinkRequest

# File 'nl-linux/generated/nl/linux/rt_link.rb', line 9837

def do_newlink(**args)
  exchange_message(:"do", Messages::DoNewlinkRequest, nil, args)
end

#do_setlink(**args) ⇒ void

This method returns an undefined value.

Set information about a link.

Parameters:

• args (Hash)

Options Hash (**args):

• ifi_family (Integer)
• ifi_type (Integer)
• ifi_index (Integer)
• ifi_flags (Integer)
• ifi_change (Integer)
• address (String)
• broadcast (String)
• ifname (String)
• mtu (Integer)
• link (Integer)
• qdisc (String)
• stats (Structs::RtnlLinkStats, Hash<Symbol, Object>)
• master (Integer)
• wireless (String) —

  struct iw_event

• protinfo (String) —

  A nest of ifla6-attrs or linkinfo-brport-attrs

• txqlen (Integer)
• map (Structs::RtnlLinkIfmap, Hash<Symbol, Object>)
• weight (Integer)
• operstate (Integer)
• linkmode (Integer)
• linkinfo (AttributeSets::LinkinfoAttrs, Hash<Symbol, Object>)
• net_ns_pid (Integer)
• ifalias (String)
• num_vf (Integer)
• vfinfo_list (AttributeSets::VfinfoListAttrs, Hash<Symbol, Object>)
• stats64 (Structs::RtnlLinkStats64, Hash<Symbol, Object>)
• vf_ports (AttributeSets::VfPortsAttrs, Hash<Symbol, Object>)
• port_self (AttributeSets::PortSelfAttrs, Hash<Symbol, Object>)
• af_spec (AttributeSets::AfSpecAttrs, Hash<Symbol, Object>)
• group (Integer)
• net_ns_fd (Integer)
• ext_mask (Integer) —

  Known flags are defined in Nl::Linux::RtLink::Flags::RtextFilter.

• promiscuity (Integer)
• num_tx_queues (Integer)
• num_rx_queues (Integer)
• carrier (Integer)
• phys_port_id (String)
• carrier_changes (Integer)
• phys_switch_id (String)
• link_netnsid (Integer)
• phys_port_name (String)
• proto_down (Integer)
• gso_max_segs (Integer)
• gso_max_size (Integer)
• xdp (AttributeSets::XdpAttrs, Hash<Symbol, Object>)
• event (Integer)
• new_netnsid (Integer)
• target_netnsid (Integer)
• carrier_up_count (Integer)
• carrier_down_count (Integer)
• new_ifindex (Integer)
• min_mtu (Integer)
• max_mtu (Integer)
• prop_list (AttributeSets::PropListLinkAttrs, Hash<Symbol, Object>)
• perm_address (String)
• proto_down_reason (String)
• parent_dev_name (String)
• parent_dev_bus_name (String)
• gro_max_size (Integer)
• tso_max_size (Integer)
• tso_max_segs (Integer)
• allmulti (Integer)
• devlink_port (String)
• gso_ipv4_max_size (Integer)
• gro_ipv4_max_size (Integer)

See Also:

• Nl::Linux::RtLink::Messages::DoSetlinkRequest

# File 'nl-linux/generated/nl/linux/rt_link.rb', line 9975

def do_setlink(**args)
  exchange_message(:"do", Messages::DoSetlinkRequest, nil, args)
end

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

Get / dump information about a link.

Overloads:

• #dump_getlink(**args) ⇒ Array<Messages::DumpGetlinkReply>

  Returns an array when no block is given.

  Parameters:

  • args (Hash)

  Options Hash (**args):

  • ifi_family (Integer)
  • ifi_type (Integer)
  • ifi_index (Integer)
  • ifi_flags (Integer)
  • ifi_change (Integer)
  • master (Integer)
  • linkinfo (AttributeSets::LinkinfoAttrs, Hash<Symbol, Object>)
  • ext_mask (Integer) —

    Known flags are defined in Nl::Linux::RtLink::Flags::RtextFilter.

  • target_netnsid (Integer)

  Returns:

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

  This method returns an undefined value.

  Yields each reply when a block is given.

  Parameters:

  • args (Hash)

  Options Hash (**args):

  • ifi_family (Integer)
  • ifi_type (Integer)
  • ifi_index (Integer)
  • ifi_flags (Integer)
  • ifi_change (Integer)
  • master (Integer)
  • linkinfo (AttributeSets::LinkinfoAttrs, Hash<Symbol, Object>)
  • ext_mask (Integer) —

    Known flags are defined in Nl::Linux::RtLink::Flags::RtextFilter.

  • target_netnsid (Integer)

  Yield Parameters:

  • reply (Messages::DumpGetlinkReply)

See Also:

• Nl::Linux::RtLink::Messages::DumpGetlinkRequest

# File 'nl-linux/generated/nl/linux/rt_link.rb', line 9902

def dump_getlink(**args, &block)
  exchange_message(:"dump", Messages::DumpGetlinkRequest, Messages::DumpGetlinkReply, args, &block)
end

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

Get / dump link stats.

Overloads:

• #dump_getstats(**args) ⇒ Array<Messages::DumpGetstatsReply>

  Returns an array when no block is given.

  Parameters:

  • args (Hash)

  Options Hash (**args):

  • family (Integer)
  • ifindex (Integer)
  • filter_mask (Integer)

  Returns:

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

  This method returns an undefined value.

  Yields each reply when a block is given.

  Parameters:

  • args (Hash)

  Options Hash (**args):

  • family (Integer)
  • ifindex (Integer)
  • filter_mask (Integer)

  Yield Parameters:

  • reply (Messages::DumpGetstatsReply)

See Also:

• Nl::Linux::RtLink::Messages::DumpGetstatsRequest

# File 'nl-linux/generated/nl/linux/rt_link.rb', line 10008

def dump_getstats(**args, &block)
  exchange_message(:"dump", Messages::DumpGetstatsRequest, Messages::DumpGetstatsReply, args, &block)
end

#subscribe(*groups) ⇒ self

Parameters:

• groups (Array<:rtnlgrp_link, :rtnlgrp_stats>)

Returns:

• (self)

# File 'nl-linux/generated/nl/linux/rt_link.rb', line 10205

def subscribe(*groups) = super
# @rbs (*(:rtnlgrp_link | :rtnlgrp_stats) groups) -> self
# @param [Array<:rtnlgrp_link, :rtnlgrp_stats>] groups
# @return [self]

#unsubscribe(*groups) ⇒ self

Parameters:

• groups (Array<:rtnlgrp_link, :rtnlgrp_stats>)

Returns:

• (self)

# File 'nl-linux/generated/nl/linux/rt_link.rb', line 10209

def unsubscribe(*groups) = super