Class: Nl::Linux::Tc

Inherits:
Raw::Family show all
Defined in:
nl-linux/generated/nl/linux/tc.rb

Overview

Netlink raw family for tc qdisc, chain, class and filter configuration over rtnetlink.

Defined Under Namespace

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

Constant Summary collapse

NAME = 
"tc"
PROTONUM = 
0

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

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

Overloads:

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

    Parameters:

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

    Returns:

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

    Returns:

    • (Object) —

      the result of the block



24
25
26
 
# File 'nl-linux/generated/nl/linux/tc.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:



15376
15377
15378
15379
 
# File 'nl-linux/generated/nl/linux/tc.rb', line 15376

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

#do_delchain(**args) ⇒ void

This method returns an undefined value.

Get / dump tc chain information.

Parameters:

  • args (Hash)

Options Hash (**args):

  • family (Integer)
  • ifindex (Integer)
  • handle (Integer)
  • parent (Integer)
  • info (Integer)
  • chain (Integer)

See Also:



15133
15134
15135
 
# File 'nl-linux/generated/nl/linux/tc.rb', line 15133

def do_delchain(**args)
  exchange_message(:"do", Messages::DoDelchainRequest, nil, args)
end

#do_delqdisc(**args) ⇒ void

This method returns an undefined value.

Delete existing tc qdisc.

Parameters:

  • args (Hash)

Options Hash (**args):

  • family (Integer)
  • ifindex (Integer)
  • handle (Integer)
  • parent (Integer)
  • info (Integer)

See Also:



14934
14935
14936
 
# File 'nl-linux/generated/nl/linux/tc.rb', line 14934

def do_delqdisc(**args)
  exchange_message(:"do", Messages::DoDelqdiscRequest, nil, args)
end

#do_deltclass(**args) ⇒ void

This method returns an undefined value.

Get / dump tc traffic class information.

Parameters:

  • args (Hash)

Options Hash (**args):

  • family (Integer)
  • ifindex (Integer)
  • handle (Integer)
  • parent (Integer)
  • info (Integer)

See Also:



15008
15009
15010
 
# File 'nl-linux/generated/nl/linux/tc.rb', line 15008

def do_deltclass(**args)
  exchange_message(:"do", Messages::DoDeltclassRequest, nil, args)
end

#do_deltfilter(**args) ⇒ void

This method returns an undefined value.

Get / dump tc filter information.

Parameters:

  • args (Hash)

Options Hash (**args):

  • family (Integer)
  • ifindex (Integer)
  • handle (Integer)
  • parent (Integer)
  • info (Integer)
  • kind (String)
  • chain (Integer)

See Also:



15055
15056
15057
 
# File 'nl-linux/generated/nl/linux/tc.rb', line 15055

def do_deltfilter(**args)
  exchange_message(:"do", Messages::DoDeltfilterRequest, nil, args)
end

#do_getchain(**args) ⇒ Messages::DoGetchainReply

Get / dump tc chain information.

Parameters:

  • args (Hash)

Options Hash (**args):

  • family (Integer)
  • ifindex (Integer)
  • handle (Integer)
  • parent (Integer)
  • info (Integer)
  • chain (Integer)

Returns:

See Also:



15147
15148
15149
 
# File 'nl-linux/generated/nl/linux/tc.rb', line 15147

def do_getchain(**args)
  exchange_message(:"do", Messages::DoGetchainRequest, Messages::DoGetchainReply, args)
end

#do_getqdisc(**args) ⇒ Messages::DoGetqdiscReply

Get / dump tc qdisc information.

Parameters:

  • args (Hash)

Options Hash (**args):

  • family (Integer)
  • ifindex (Integer)
  • handle (Integer)
  • parent (Integer)
  • info (Integer)
  • dump_invisible (Integer)

Returns:

See Also:



14948
14949
14950
 
# File 'nl-linux/generated/nl/linux/tc.rb', line 14948

def do_getqdisc(**args)
  exchange_message(:"do", Messages::DoGetqdiscRequest, Messages::DoGetqdiscReply, args)
end

#do_gettclass(**args) ⇒ Messages::DoGettclassReply

Get / dump tc traffic class information.

Parameters:

  • args (Hash)

Options Hash (**args):

  • family (Integer)
  • ifindex (Integer)
  • handle (Integer)
  • parent (Integer)
  • info (Integer)

Returns:

See Also:



15021
15022
15023
 
# File 'nl-linux/generated/nl/linux/tc.rb', line 15021

def do_gettclass(**args)
  exchange_message(:"do", Messages::DoGettclassRequest, Messages::DoGettclassReply, args)
end

#do_gettfilter(**args) ⇒ Messages::DoGettfilterReply

Get / dump tc filter information.

Parameters:

  • args (Hash)

Options Hash (**args):

  • family (Integer)
  • ifindex (Integer)
  • handle (Integer)
  • parent (Integer)
  • info (Integer)
  • kind (String)
  • chain (Integer)

Returns:

See Also:



15070
15071
15072
 
# File 'nl-linux/generated/nl/linux/tc.rb', line 15070

def do_gettfilter(**args)
  exchange_message(:"do", Messages::DoGettfilterRequest, Messages::DoGettfilterReply, args)
end

#do_newchain(**args) ⇒ void

This method returns an undefined value.

Get / dump tc chain information.

Parameters:

  • args (Hash)

Options Hash (**args):

See Also:



15119
15120
15121
 
# File 'nl-linux/generated/nl/linux/tc.rb', line 15119

def do_newchain(**args)
  exchange_message(:"do", Messages::DoNewchainRequest, nil, args)
end

#do_newqdisc(**args) ⇒ void

This method returns an undefined value.

Create new tc qdisc.

Parameters:

  • args (Hash)

Options Hash (**args):

See Also:



14921
14922
14923
 
# File 'nl-linux/generated/nl/linux/tc.rb', line 14921

def do_newqdisc(**args)
  exchange_message(:"do", Messages::DoNewqdiscRequest, nil, args)
end

#do_newtclass(**args) ⇒ void

This method returns an undefined value.

Get / dump tc traffic class information.

Parameters:

  • args (Hash)

Options Hash (**args):

See Also:



14995
14996
14997
 
# File 'nl-linux/generated/nl/linux/tc.rb', line 14995

def do_newtclass(**args)
  exchange_message(:"do", Messages::DoNewtclassRequest, nil, args)
end

#do_newtfilter(**args) ⇒ void

This method returns an undefined value.

Get / dump tc filter information.

Parameters:

  • args (Hash)

Options Hash (**args):

See Also:



15040
15041
15042
 
# File 'nl-linux/generated/nl/linux/tc.rb', line 15040

def do_newtfilter(**args)
  exchange_message(:"do", Messages::DoNewtfilterRequest, nil, args)
end

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

Get / dump tc qdisc information.

Overloads:

  • #dump_getqdisc(**args) ⇒ Array<Messages::DumpGetqdiscReply>

    Returns an array when no block is given.

    Parameters:

    • args (Hash)

    Options Hash (**args):

    • family (Integer)
    • ifindex (Integer)
    • handle (Integer)
    • parent (Integer)
    • info (Integer)
    • dump_invisible (Integer)

    Returns:

  • #dump_getqdisc(**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)
    • handle (Integer)
    • parent (Integer)
    • info (Integer)
    • dump_invisible (Integer)

    Yield Parameters:

See Also:



14976
14977
14978
 
# File 'nl-linux/generated/nl/linux/tc.rb', line 14976

def dump_getqdisc(**args, &block)
  exchange_message(:"dump", Messages::DumpGetqdiscRequest, Messages::DumpGetqdiscReply, args, &block)
end

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

Get / dump tc filter information.

Overloads:

  • #dump_gettfilter(**args) ⇒ Array<Messages::DumpGettfilterReply>

    Returns an array when no block is given.

    Parameters:

    • args (Hash)

    Options Hash (**args):

    • family (Integer)
    • ifindex (Integer)
    • handle (Integer)
    • parent (Integer)
    • info (Integer)
    • chain (Integer)
    • dump_flags (Nl::Bitfield32)

    Returns:

  • #dump_gettfilter(**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)
    • handle (Integer)
    • parent (Integer)
    • info (Integer)
    • chain (Integer)
    • dump_flags (Nl::Bitfield32)

    Yield Parameters:

See Also:



15100
15101
15102
 
# File 'nl-linux/generated/nl/linux/tc.rb', line 15100

def dump_gettfilter(**args, &block)
  exchange_message(:"dump", Messages::DumpGettfilterRequest, Messages::DumpGettfilterReply, args, &block)
end

#subscribe(*groups) ⇒ self

Parameters:

  • groups (Array<:rtnlgrp_tc>)

Returns:

  • (self) 


15383
15384
15385
15386
 
# File 'nl-linux/generated/nl/linux/tc.rb', line 15383

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

#unsubscribe(*groups) ⇒ self

Parameters:

  • groups (Array<:rtnlgrp_tc>)

Returns:

  • (self) 


15387
 
# File 'nl-linux/generated/nl/linux/tc.rb', line 15387

def unsubscribe(*groups) = super