Class: Nl::Linux::Sunrpc

Inherits:

Genl::Family

• Object
• Family
• Genl::Family
• Nl::Linux::Sunrpc

Defined in:

nl-linux/generated/nl/linux/sunrpc_cache.rb

Overview

SUNRPC cache upcall support over generic netlink.

Defined Under Namespace

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

Constant Summary

NAME =

"sunrpc"

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

  Flush sunrpc caches (ip_map and/or unix_gid).

• #do_ip_map_set_reqs(**args) ⇒ void

  Respond to one or more ip_map requests.

• #do_unix_gid_set_reqs(**args) ⇒ void

  Respond to one or more unix_gid requests.

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

  Dump all pending ip_map requests.

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

  Dump all pending unix_gid requests.

• #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) ⇒ Sunrpc .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) ⇒ Sunrpc

  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:

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

  Returns:

  • (Object) —

    the result of the block

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

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

#do_cache_flush(**args) ⇒ void

This method returns an undefined value.

Flush sunrpc caches (ip_map and/or unix_gid)

Requires CAP_NET_ADMIN in the initial user namespace.

Parameters:

• args (Hash)

Options Hash (**args):

• mask (Integer) —

  Known flags are defined in Nl::Linux::Sunrpc::Flags::CacheType.

See Also:

• Nl::Linux::Sunrpc::Messages::DoCacheFlushRequest

# File 'nl-linux/generated/nl/linux/sunrpc_cache.rb', line 539

def do_cache_flush(**args)
  exchange_message(:"do", Messages::DoCacheFlushRequest, nil, args)
end

#do_ip_map_set_reqs(**args) ⇒ void

This method returns an undefined value.

Respond to one or more ip_map requests

Requires CAP_NET_ADMIN in the initial user namespace.

Parameters:

• args (Hash)

Options Hash (**args):

• requests (Array<AttributeSets::IpMap, Hash<Symbol, Object>>)

See Also:

• Nl::Linux::Sunrpc::Messages::DoIpMapSetReqsRequest

# File 'nl-linux/generated/nl/linux/sunrpc_cache.rb', line 499

def do_ip_map_set_reqs(**args)
  exchange_message(:"do", Messages::DoIpMapSetReqsRequest, nil, args)
end

#do_unix_gid_set_reqs(**args) ⇒ void

This method returns an undefined value.

Respond to one or more unix_gid requests

Requires CAP_NET_ADMIN in the initial user namespace.

Parameters:

• args (Hash)

Options Hash (**args):

• requests (Array<AttributeSets::UnixGid, Hash<Symbol, Object>>)

See Also:

• Nl::Linux::Sunrpc::Messages::DoUnixGidSetReqsRequest

# File 'nl-linux/generated/nl/linux/sunrpc_cache.rb', line 528

def do_unix_gid_set_reqs(**args)
  exchange_message(:"do", Messages::DoUnixGidSetReqsRequest, nil, args)
end

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

Dump all pending ip_map requests

Requires CAP_NET_ADMIN in the initial user namespace.

Overloads:

• #dump_ip_map_get_reqs(**args) ⇒ Array<Messages::DumpIpMapGetReqsReply>

  Returns an array when no block is given.

  Parameters:

  • args (Hash)

  Returns:

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

  This method returns an undefined value.

  Yields each reply when a block is given.

  Parameters:

  • args (Hash)

  Yield Parameters:

  • reply (Messages::DumpIpMapGetReqsReply)

See Also:

• Nl::Linux::Sunrpc::Messages::DumpIpMapGetReqsRequest

# File 'nl-linux/generated/nl/linux/sunrpc_cache.rb', line 488

def dump_ip_map_get_reqs(**args, &block)
  exchange_message(:"dump", Messages::DumpIpMapGetReqsRequest, Messages::DumpIpMapGetReqsReply, args, &block)
end

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

Dump all pending unix_gid requests

Requires CAP_NET_ADMIN in the initial user namespace.

Overloads:

• #dump_unix_gid_get_reqs(**args) ⇒ Array<Messages::DumpUnixGidGetReqsReply>

  Returns an array when no block is given.

  Parameters:

  • args (Hash)

  Returns:

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

  This method returns an undefined value.

  Yields each reply when a block is given.

  Parameters:

  • args (Hash)

  Yield Parameters:

  • reply (Messages::DumpUnixGidGetReqsReply)

See Also:

• Nl::Linux::Sunrpc::Messages::DumpUnixGidGetReqsRequest

# File 'nl-linux/generated/nl/linux/sunrpc_cache.rb', line 517

def dump_unix_gid_get_reqs(**args, &block)
  exchange_message(:"dump", Messages::DumpUnixGidGetReqsRequest, Messages::DumpUnixGidGetReqsReply, args, &block)
end

#subscribe(*groups) ⇒ self

Parameters:

• groups (Array<:none, :exportd>)

Returns:

• (self)

# File 'nl-linux/generated/nl/linux/sunrpc_cache.rb', line 612

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

#unsubscribe(*groups) ⇒ self

Parameters:

• groups (Array<:none, :exportd>)

Returns:

• (self)

# File 'nl-linux/generated/nl/linux/sunrpc_cache.rb', line 616

def unsubscribe(*groups) = super