Class: Nl::Linux::MptcpPm

Inherits:

Genl::Family

• Object
• Family
• Genl::Family
• Nl::Linux::MptcpPm

Defined in:

nl-linux/generated/nl/linux/mptcp_pm.rb

Overview

Multipath TCP.

Defined Under Namespace

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

Constant Summary

NAME =

"mptcp_pm"

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

  Add endpoint.

• #do_announce(**args) ⇒ void

  Announce new address.

• #do_del_addr(**args) ⇒ void

  Delete endpoint.

• #do_flush_addrs(**args) ⇒ void

  Flush addresses.

• #do_get_addr(**args) ⇒ Messages::DoGetAddrReply

  Get endpoint information.

• #do_get_limits(**args) ⇒ Messages::DoGetLimitsReply

  Get protocol limits.

• #do_remove(**args) ⇒ void

  Announce removal.

• #do_set_flags(**args) ⇒ void

  Change endpoint flags.

• #do_set_limits(**args) ⇒ void

  Set protocol limits.

• #do_subflow_create(**args) ⇒ void

  Create subflow.

• #do_subflow_destroy(**args) ⇒ void

  Destroy subflow.

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

  Get endpoint information.

Methods inherited from Genl::Family

version

Class Method Details

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

  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:

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

  Returns:

  • (Object) —

    the result of the block

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

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

This method returns an undefined value.

Add endpoint

Requires CAP_NET_ADMIN in the user namespace owning the network namespace.

Parameters:

• args (Hash)

Options Hash (**args):

• addr (AttributeSets::Address, Hash<Symbol, Object>)

See Also:

• Nl::Linux::MptcpPm::Messages::DoAddAddrRequest

# File 'nl-linux/generated/nl/linux/mptcp_pm.rb', line 932

def do_add_addr(**args)
  exchange_message(:"do", Messages::DoAddAddrRequest, nil, args)
end

#do_announce(**args) ⇒ void

This method returns an undefined value.

Announce new address

Requires CAP_NET_ADMIN in the user namespace owning the network namespace.

Parameters:

• args (Hash)

Options Hash (**args):

• addr (AttributeSets::Address, Hash<Symbol, Object>)
• token (Integer)

See Also:

• Nl::Linux::MptcpPm::Messages::DoAnnounceRequest

# File 'nl-linux/generated/nl/linux/mptcp_pm.rb', line 1027

def do_announce(**args)
  exchange_message(:"do", Messages::DoAnnounceRequest, nil, args)
end

#do_del_addr(**args) ⇒ void

This method returns an undefined value.

Delete endpoint

Requires CAP_NET_ADMIN in the user namespace owning the network namespace.

Parameters:

• args (Hash)

Options Hash (**args):

• addr (AttributeSets::Address, Hash<Symbol, Object>)

See Also:

• Nl::Linux::MptcpPm::Messages::DoDelAddrRequest

# File 'nl-linux/generated/nl/linux/mptcp_pm.rb', line 943

def do_del_addr(**args)
  exchange_message(:"do", Messages::DoDelAddrRequest, nil, args)
end

#do_flush_addrs(**args) ⇒ void

This method returns an undefined value.

Flush addresses

Requires CAP_NET_ADMIN in the user namespace owning the network namespace.

Parameters:

• args (Hash)

Options Hash (**args):

• addr (AttributeSets::Address, Hash<Symbol, Object>)

See Also:

• Nl::Linux::MptcpPm::Messages::DoFlushAddrsRequest

# File 'nl-linux/generated/nl/linux/mptcp_pm.rb', line 980

def do_flush_addrs(**args)
  exchange_message(:"do", Messages::DoFlushAddrsRequest, nil, args)
end

#do_get_addr(**args) ⇒ Messages::DoGetAddrReply

Get endpoint information

Parameters:

• args (Hash)

Options Hash (**args):

• addr (AttributeSets::Address, Hash<Symbol, Object>)
• token (Integer)

Returns:

• (Messages::DoGetAddrReply)

See Also:

• Nl::Linux::MptcpPm::Messages::DoGetAddrRequest

# File 'nl-linux/generated/nl/linux/mptcp_pm.rb', line 953

def do_get_addr(**args)
  exchange_message(:"do", Messages::DoGetAddrRequest, Messages::DoGetAddrReply, args)
end

#do_get_limits(**args) ⇒ Messages::DoGetLimitsReply

Get protocol limits

Parameters:

• args (Hash)

Options Hash (**args):

• rcv_add_addrs (Integer)
• subflows (Integer)

Returns:

• (Messages::DoGetLimitsReply)

See Also:

• Nl::Linux::MptcpPm::Messages::DoGetLimitsRequest

# File 'nl-linux/generated/nl/linux/mptcp_pm.rb', line 1002

def do_get_limits(**args)
  exchange_message(:"do", Messages::DoGetLimitsRequest, Messages::DoGetLimitsReply, args)
end

#do_remove(**args) ⇒ void

This method returns an undefined value.

Announce removal

Requires CAP_NET_ADMIN in the user namespace owning the network namespace.

Parameters:

• args (Hash)

Options Hash (**args):

• token (Integer)
• loc_id (Integer)

See Also:

• Nl::Linux::MptcpPm::Messages::DoRemoveRequest

# File 'nl-linux/generated/nl/linux/mptcp_pm.rb', line 1039

def do_remove(**args)
  exchange_message(:"do", Messages::DoRemoveRequest, nil, args)
end

#do_set_flags(**args) ⇒ void

This method returns an undefined value.

Change endpoint flags

Requires CAP_NET_ADMIN in the user namespace owning the network namespace.

Parameters:

• args (Hash)

Options Hash (**args):

• addr (AttributeSets::Address, Hash<Symbol, Object>)
• token (Integer)
• addr_remote (AttributeSets::Address, Hash<Symbol, Object>)

See Also:

• Nl::Linux::MptcpPm::Messages::DoSetFlagsRequest

# File 'nl-linux/generated/nl/linux/mptcp_pm.rb', line 1015

def do_set_flags(**args)
  exchange_message(:"do", Messages::DoSetFlagsRequest, nil, args)
end

#do_set_limits(**args) ⇒ void

This method returns an undefined value.

Set protocol limits

Requires CAP_NET_ADMIN in the user namespace owning the network namespace.

Parameters:

• args (Hash)

Options Hash (**args):

• rcv_add_addrs (Integer)
• subflows (Integer)

See Also:

• Nl::Linux::MptcpPm::Messages::DoSetLimitsRequest

# File 'nl-linux/generated/nl/linux/mptcp_pm.rb', line 992

def do_set_limits(**args)
  exchange_message(:"do", Messages::DoSetLimitsRequest, nil, args)
end

#do_subflow_create(**args) ⇒ void

This method returns an undefined value.

Create subflow

Requires CAP_NET_ADMIN in the user namespace owning the network namespace.

Parameters:

• args (Hash)

Options Hash (**args):

• addr (AttributeSets::Address, Hash<Symbol, Object>)
• token (Integer)
• addr_remote (AttributeSets::Address, Hash<Symbol, Object>)

See Also:

• Nl::Linux::MptcpPm::Messages::DoSubflowCreateRequest

# File 'nl-linux/generated/nl/linux/mptcp_pm.rb', line 1052

def do_subflow_create(**args)
  exchange_message(:"do", Messages::DoSubflowCreateRequest, nil, args)
end

#do_subflow_destroy(**args) ⇒ void

This method returns an undefined value.

Destroy subflow

Requires CAP_NET_ADMIN in the user namespace owning the network namespace.

Parameters:

• args (Hash)

Options Hash (**args):

• addr (AttributeSets::Address, Hash<Symbol, Object>)
• token (Integer)
• addr_remote (AttributeSets::Address, Hash<Symbol, Object>)

See Also:

• Nl::Linux::MptcpPm::Messages::DoSubflowDestroyRequest

# File 'nl-linux/generated/nl/linux/mptcp_pm.rb', line 1065

def do_subflow_destroy(**args)
  exchange_message(:"do", Messages::DoSubflowDestroyRequest, nil, args)
end

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

Get endpoint information

Overloads:

• #dump_get_addr(**args) ⇒ Array<Messages::DumpGetAddrReply>

  Returns an array when no block is given.

  Parameters:

  • args (Hash)

  Returns:

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

  This method returns an undefined value.

  Yields each reply when a block is given.

  Parameters:

  • args (Hash)

  Yield Parameters:

  • reply (Messages::DumpGetAddrReply)

See Also:

• Nl::Linux::MptcpPm::Messages::DumpGetAddrRequest

# File 'nl-linux/generated/nl/linux/mptcp_pm.rb', line 969

def dump_get_addr(**args, &block)
  exchange_message(:"dump", Messages::DumpGetAddrRequest, Messages::DumpGetAddrReply, args, &block)
end