Class: Nl::Linux::Fou

Inherits:

Genl::Family

• Object
• Family
• Genl::Family
• Nl::Linux::Fou

Defined in:

nl-linux/generated/nl/linux/fou.rb

Overview

Foo-over-UDP.

Defined Under Namespace

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

Constant Summary

NAME =

"fou"

VERSION =

1

Class Method Summary

• .open(resolver: ::Nl::Linux::DEFAULT_RESOLVER, 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_add(**args) ⇒ void

  Add port.

• #do_del(**args) ⇒ void

  Delete port.

• #do_get(**args) ⇒ Messages::DoGetReply

  Get tunnel info.

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

  Get tunnel info.

Methods inherited from Genl::Family

version

Class Method Details

.open(resolver: ::Nl::Linux::DEFAULT_RESOLVER, executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY) ⇒ Fou .open(resolver: ::Nl::Linux::DEFAULT_RESOLVER, executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY) {|family| ... } ⇒ Object

Overloads:

• .open(resolver: ::Nl::Linux::DEFAULT_RESOLVER, executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY) ⇒ Fou

  Parameters:

  • resolver (#call) (defaults to: ::Nl::Linux::DEFAULT_RESOLVER)
  • executor (Symbol, nil) (defaults to: nil)
  • notification_capacity (Integer, nil) (defaults to: DEFAULT_NOTIFICATION_CAPACITY)

  Returns:

  • (Fou)
• .open(resolver: ::Nl::Linux::DEFAULT_RESOLVER, executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY) {|family| ... } ⇒ Object

  Returns the result of the block.

  Parameters:

  • resolver (#call) (defaults to: ::Nl::Linux::DEFAULT_RESOLVER)
  • executor (Symbol, nil) (defaults to: nil)
  • notification_capacity (Integer, nil) (defaults to: DEFAULT_NOTIFICATION_CAPACITY)

  Yield Parameters:

  • family (Fou)

  Returns:

  • (Object) —

    the result of the block

# File 'nl-linux/generated/nl/linux/fou.rb', line 26

def self.open(resolver: ::Nl::Linux::DEFAULT_RESOLVER, 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/fou.rb', line 575

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

#do_add(**args) ⇒ void

This method returns an undefined value.

Add port.

Requires CAP_NET_ADMIN in the initial user namespace.

Parameters:

• args (Hash)

Options Hash (**args):

• port (Integer)
• ipproto (Integer)
• type (Integer)
• remcsum_nopartial (Integer)
• local_v4 (Integer)
• local_v6 (String)
• peer_v4 (Integer)
• peer_v6 (String)
• peer_port (Integer)
• ifindex (Integer)

See Also:

• Nl::Linux::Fou::Messages::DoAddRequest

# File 'nl-linux/generated/nl/linux/fou.rb', line 450

def do_add(**args)
  exchange_message(:"do", Messages::DoAddRequest, nil, args)
end

#do_del(**args) ⇒ void

This method returns an undefined value.

Delete port.

Requires CAP_NET_ADMIN in the initial user namespace.

Parameters:

• args (Hash)

Options Hash (**args):

• port (Integer)
• af (Integer)
• local_v4 (Integer)
• local_v6 (String)
• peer_v4 (Integer)
• peer_v6 (String)
• peer_port (Integer)
• ifindex (Integer)

See Also:

• Nl::Linux::Fou::Messages::DoDelRequest

# File 'nl-linux/generated/nl/linux/fou.rb', line 468

def do_del(**args)
  exchange_message(:"do", Messages::DoDelRequest, nil, args)
end

#do_get(**args) ⇒ Messages::DoGetReply

Get tunnel info.

Parameters:

• args (Hash)

Options Hash (**args):

• port (Integer)
• af (Integer)
• local_v4 (Integer)
• local_v6 (String)
• peer_v4 (Integer)
• peer_v6 (String)
• peer_port (Integer)
• ifindex (Integer)

Returns:

• (Messages::DoGetReply)

See Also:

• Nl::Linux::Fou::Messages::DoGetRequest

# File 'nl-linux/generated/nl/linux/fou.rb', line 484

def do_get(**args)
  exchange_message(:"do", Messages::DoGetRequest, Messages::DoGetReply, args)
end

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

Get tunnel info.

Overloads:

• #dump_get(**args) ⇒ Array<Messages::DumpGetReply>

  Returns an array when no block is given.

  Parameters:

  • args (Hash)

  Returns:

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

  This method returns an undefined value.

  Yields each reply when a block is given.

  Parameters:

  • args (Hash)

  Yield Parameters:

  • reply (Messages::DumpGetReply)

See Also:

• Nl::Linux::Fou::Messages::DumpGetRequest

# File 'nl-linux/generated/nl/linux/fou.rb', line 500

def dump_get(**args, &block)
  exchange_message(:"dump", Messages::DumpGetRequest, Messages::DumpGetReply, args, &block)
end