Class: Nl::Linux::OvsDatapath

Inherits:

Genl::Family

• Object
• Family
• Genl::Family
• Nl::Linux::OvsDatapath

Defined in:

nl-linux/generated/nl/linux/ovs_datapath.rb

Overview

OVS datapath configuration over generic netlink.

Defined Under Namespace

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

Constant Summary

NAME =

"ovs_datapath"

VERSION =

2

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

  Delete existing OVS data path.

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

  Get / dump OVS data path configuration and state.

• #do_new(**args) ⇒ void

  Create new OVS data path.

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

  Get / dump OVS data path configuration and state.

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

Methods inherited from Genl::Family

version

Class Method Details

.open(resolver: ::Nl::Linux::DEFAULT_RESOLVER, executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY) ⇒ OvsDatapath .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) ⇒ OvsDatapath

  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:

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

  Returns:

  • (Object) —

    the result of the block

# File 'nl-linux/generated/nl/linux/ovs_datapath.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/ovs_datapath.rb', line 522

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

#do_del(**args) ⇒ void

This method returns an undefined value.

Delete existing OVS data path

Parameters:

• args (Hash)

Options Hash (**args):

• dp_ifindex (Integer)
• name (String)

See Also:

• Nl::Linux::OvsDatapath::Messages::DoDelRequest

# File 'nl-linux/generated/nl/linux/ovs_datapath.rb', line 467

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

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

Get / dump OVS data path configuration and state

Parameters:

• args (Hash)

Options Hash (**args):

• dp_ifindex (Integer)
• name (String)

Returns:

• (Messages::DoGetReply)

See Also:

• Nl::Linux::OvsDatapath::Messages::DoGetRequest

# File 'nl-linux/generated/nl/linux/ovs_datapath.rb', line 425

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

#do_new(**args) ⇒ void

This method returns an undefined value.

Create new OVS data path

Parameters:

• args (Hash)

Options Hash (**args):

• dp_ifindex (Integer)
• name (String)
• upcall_pid (Integer) —

  upcall pid

• user_features (Integer) —

  Known flags are defined in Nl::Linux::OvsDatapath::Flags::UserFeatures.

See Also:

• Nl::Linux::OvsDatapath::Messages::DoNewRequest

# File 'nl-linux/generated/nl/linux/ovs_datapath.rb', line 457

def do_new(**args)
  exchange_message(:"do", Messages::DoNewRequest, nil, args)
end

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

Get / dump OVS data path configuration and state

Overloads:

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

  Returns an array when no block is given.

  Parameters:

  • args (Hash)

  Options Hash (**args):

  • dp_ifindex (Integer)
  • name (String)

  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)

  Options Hash (**args):

  • dp_ifindex (Integer)
  • name (String)

  Yield Parameters:

  • reply (Messages::DumpGetReply)

See Also:

• Nl::Linux::OvsDatapath::Messages::DumpGetRequest

# File 'nl-linux/generated/nl/linux/ovs_datapath.rb', line 445

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

#subscribe(*groups) ⇒ self

Parameters:

• groups (Array<:ovs_datapath>)

Returns:

• (self)

# File 'nl-linux/generated/nl/linux/ovs_datapath.rb', line 529

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

#unsubscribe(*groups) ⇒ self

Parameters:

• groups (Array<:ovs_datapath>)

Returns:

• (self)

# File 'nl-linux/generated/nl/linux/ovs_datapath.rb', line 533

def unsubscribe(*groups) = super