Class: Nl::Linux::Nl80211

Inherits:

Genl::Family

• Object
• Family
• Genl::Family
• Nl::Linux::Nl80211

Defined in:

nl-linux/generated/nl/linux/nl80211.rb

Overview

Netlink API for 802.11 wireless devices

Defined Under Namespace

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

Constant Summary

NAME =

"nl80211"

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_get_interface(**args) ⇒ Messages::DoGetInterfaceReply

  Get information about an interface or dump a list of all interfaces.

• #do_get_protocol_features(**args) ⇒ Messages::DoGetProtocolFeaturesReply

  Get information about supported protocol features.

• #do_get_wiphy(**args) ⇒ Messages::DoGetWiphyReply

  Get information about a wiphy or dump a list of all wiphys.

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

  Get information about an interface or dump a list of all interfaces.

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

  Get information about a wiphy or dump a list of all wiphys.

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

  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:

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

  Returns:

  • (Object) —

    the result of the block

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

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

#do_get_interface(**args) ⇒ Messages::DoGetInterfaceReply

Get information about an interface or dump a list of all interfaces

Parameters:

• args (Hash)

Options Hash (**args):

• ifname (String)

Returns:

• (Messages::DoGetInterfaceReply)

See Also:

• Nl::Linux::Nl80211::Messages::DoGetInterfaceRequest

# File 'nl-linux/generated/nl/linux/nl80211.rb', line 7005

def do_get_interface(**args)
  exchange_message(:"do", Messages::DoGetInterfaceRequest, Messages::DoGetInterfaceReply, args)
end

#do_get_protocol_features(**args) ⇒ Messages::DoGetProtocolFeaturesReply

Get information about supported protocol features

Parameters:

• args (Hash)

Options Hash (**args):

• protocol_features (Integer) —

  Known flags are defined in Nl::Linux::Nl80211::Flags::ProtocolFeatures.

Returns:

• (Messages::DoGetProtocolFeaturesReply)

See Also:

• Nl::Linux::Nl80211::Messages::DoGetProtocolFeaturesRequest

# File 'nl-linux/generated/nl/linux/nl80211.rb', line 7032

def do_get_protocol_features(**args)
  exchange_message(:"do", Messages::DoGetProtocolFeaturesRequest, Messages::DoGetProtocolFeaturesReply, args)
end

#do_get_wiphy(**args) ⇒ Messages::DoGetWiphyReply

Get information about a wiphy or dump a list of all wiphys. Requests to dump get-wiphy should unconditionally include the split-wiphy-dump flag in the request.

Parameters:

• args (Hash)

Options Hash (**args):

• wiphy (Integer)
• ifindex (Integer)
• wdev (Integer)

Returns:

• (Messages::DoGetWiphyReply)

See Also:

• Nl::Linux::Nl80211::Messages::DoGetWiphyRequest

# File 'nl-linux/generated/nl/linux/nl80211.rb', line 6970

def do_get_wiphy(**args)
  exchange_message(:"do", Messages::DoGetWiphyRequest, Messages::DoGetWiphyReply, args)
end

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

Get information about an interface or dump a list of all interfaces

Overloads:

• #dump_get_interface(**args) ⇒ Array<Messages::DumpGetInterfaceReply>

  Returns an array when no block is given.

  Parameters:

  • args (Hash)

  Options Hash (**args):

  • ifname (String)

  Returns:

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

  This method returns an undefined value.

  Yields each reply when a block is given.

  Parameters:

  • args (Hash)

  Options Hash (**args):

  • ifname (String)

  Yield Parameters:

  • reply (Messages::DumpGetInterfaceReply)

See Also:

• Nl::Linux::Nl80211::Messages::DumpGetInterfaceRequest

# File 'nl-linux/generated/nl/linux/nl80211.rb', line 7023

def dump_get_interface(**args, &block)
  exchange_message(:"dump", Messages::DumpGetInterfaceRequest, Messages::DumpGetInterfaceReply, args, &block)
end

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

Get information about a wiphy or dump a list of all wiphys. Requests to dump get-wiphy should unconditionally include the split-wiphy-dump flag in the request.

Overloads:

• #dump_get_wiphy(**args) ⇒ Array<Messages::DumpGetWiphyReply>

  Returns an array when no block is given.

  Parameters:

  • args (Hash)

  Options Hash (**args):

  • wiphy (Integer)
  • ifindex (Integer)
  • wdev (Integer)
  • split_wiphy_dump (Integer)

  Returns:

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

  This method returns an undefined value.

  Yields each reply when a block is given.

  Parameters:

  • args (Hash)

  Options Hash (**args):

  • wiphy (Integer)
  • ifindex (Integer)
  • wdev (Integer)
  • split_wiphy_dump (Integer)

  Yield Parameters:

  • reply (Messages::DumpGetWiphyReply)

See Also:

• Nl::Linux::Nl80211::Messages::DumpGetWiphyRequest

# File 'nl-linux/generated/nl/linux/nl80211.rb', line 6996

def dump_get_wiphy(**args, &block)
  exchange_message(:"dump", Messages::DumpGetWiphyRequest, Messages::DumpGetWiphyReply, args, &block)
end

#subscribe(*groups) ⇒ self

Parameters:

• groups (Array<:config, :scan, :regulatory, :mlme, :vendor, :nan, :testmode>)

Returns:

• (self)

# File 'nl-linux/generated/nl/linux/nl80211.rb', line 7106

def subscribe(*groups) = super
# @rbs (*(:config | :scan | :regulatory | :mlme | :vendor | :nan | :testmode) groups) -> self
# @param [Array<:config, :scan, :regulatory, :mlme, :vendor, :nan, :testmode>] groups
# @return [self]

#unsubscribe(*groups) ⇒ self

Parameters:

• groups (Array<:config, :scan, :regulatory, :mlme, :vendor, :nan, :testmode>)

Returns:

• (self)

# File 'nl-linux/generated/nl/linux/nl80211.rb', line 7110

def unsubscribe(*groups) = super