Class: Nl::Linux::Handshake

Inherits:
Genl::Family show all
Defined in:
nl-linux/generated/nl/linux/handshake.rb

Overview

Netlink protocol to request a transport layer security handshake.

Defined Under Namespace

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

Constant Summary collapse

NAME = 
"handshake"
VERSION = 
1

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Genl::Family

version

Class Method Details

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

    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:

  • .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:

    Returns:

    • (Object) —

      the result of the block



33
34
35
 
# File 'nl-linux/generated/nl/linux/handshake.rb', line 33

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:



495
496
497
498
 
# File 'nl-linux/generated/nl/linux/handshake.rb', line 495

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

#do_accept(**args) ⇒ Messages::DoAcceptReply

Handler retrieves next queued handshake request

Requires CAP_NET_ADMIN in the initial user namespace.

Parameters:

  • args (Hash)

Options Hash (**args):

Returns:

See Also:



445
446
447
 
# File 'nl-linux/generated/nl/linux/handshake.rb', line 445

def do_accept(**args)
  exchange_message(:"do", Messages::DoAcceptRequest, Messages::DoAcceptReply, args)
end

#do_done(**args) ⇒ void

This method returns an undefined value.

Handler reports handshake completion

Requires CAP_NET_ADMIN in the initial user namespace.

Parameters:

  • args (Hash)

Options Hash (**args):

  • status (Integer)
  • sockfd (Integer)
  • remote_auth (Array<Integer>)

See Also:



458
459
460
 
# File 'nl-linux/generated/nl/linux/handshake.rb', line 458

def do_done(**args)
  exchange_message(:"do", Messages::DoDoneRequest, nil, args)
end

#subscribe(*groups) ⇒ self

Parameters:

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

Returns:

  • (self) 


502
503
504
505
 
# File 'nl-linux/generated/nl/linux/handshake.rb', line 502

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

#unsubscribe(*groups) ⇒ self

Parameters:

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

Returns:

  • (self) 


506
 
# File 'nl-linux/generated/nl/linux/handshake.rb', line 506

def unsubscribe(*groups) = super