Class: Nl::Linux::Ovpn::AttributeSets::PeerSetInput

Inherits:
AttributeSet
  • Object
show all
Defined in:
nl-linux/generated/nl/linux/ovpn.rb

Defined Under Namespace

Classes: Attribute, Id, KeepaliveInterval, KeepaliveTimeout, LocalIpv4, LocalIpv6, RemoteIpv4, RemoteIpv6, RemoteIpv6ScopeId, RemotePort, TxId, VpnIpv4, VpnIpv6

Constant Summary

Constants inherited from AttributeSet

AttributeSet::SELECTOR_NAMES

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from AttributeSet

#<<, #[], build_attributes, decode, #encode, #initialize

Constructor Details

This class inherits a constructor from Nl::AttributeSet

Class Method Details

.by_name(name) ⇒ Attribute

Looks up Attribute class by name.

Parameters:

  • name (Symbol)

Returns:



812
 
# File 'nl-linux/generated/nl/linux/ovpn.rb', line 812

def by_name(name); BY_NAME.fetch(name); end

.by_type(type) ⇒ Attribute

Looks up Attribute class by type value.

Parameters:

  • type (Integer)

Returns:



818
 
# File 'nl-linux/generated/nl/linux/ovpn.rb', line 818

def by_type(type); BY_TYPE.fetch(type); end

Instance Method Details

#id ⇒ Integer

The unique ID of the peer in the device context. To be used to identify peers during operations for a specific device. Also used to match packets received from this peer.

Returns:

  • (Integer)

See Also:



750
 
# File 'nl-linux/generated/nl/linux/ovpn.rb', line 750

def id; self[:"id"]&.value; end

#keepalive_interval ⇒ Integer

The number of seconds after which a keep alive message is sent to the peer

Returns:

  • (Integer)

See Also:



795
 
# File 'nl-linux/generated/nl/linux/ovpn.rb', line 795

def keepalive_interval; self[:"keepalive_interval"]&.value; end

#keepalive_timeout ⇒ Integer

The number of seconds from the last activity after which the peer is assumed dead

Returns:

  • (Integer)

See Also:



800
 
# File 'nl-linux/generated/nl/linux/ovpn.rb', line 800

def keepalive_timeout; self[:"keepalive_timeout"]&.value; end

#local_ipv4 ⇒ Integer

The local IPv4 to be used to send packets to the peer (UDP only)

Returns:

  • (Integer)

See Also:



785
 
# File 'nl-linux/generated/nl/linux/ovpn.rb', line 785

def local_ipv4; self[:"local_ipv4"]&.value; end

#local_ipv6 ⇒ String

The local IPv6 to be used to send packets to the peer (UDP only)

Returns:

  • (String)

See Also:



790
 
# File 'nl-linux/generated/nl/linux/ovpn.rb', line 790

def local_ipv6; self[:"local_ipv6"]&.value; end

#remote_ipv4 ⇒ Integer

The remote IPv4 address of the peer

Returns:

  • (Integer)

See Also:



755
 
# File 'nl-linux/generated/nl/linux/ovpn.rb', line 755

def remote_ipv4; self[:"remote_ipv4"]&.value; end

#remote_ipv6 ⇒ String

The remote IPv6 address of the peer

Returns:

  • (String)

See Also:



760
 
# File 'nl-linux/generated/nl/linux/ovpn.rb', line 760

def remote_ipv6; self[:"remote_ipv6"]&.value; end

#remote_ipv6_scope_id ⇒ Integer

The scope id of the remote IPv6 address of the peer (RFC2553)

Returns:

  • (Integer)

See Also:



765
 
# File 'nl-linux/generated/nl/linux/ovpn.rb', line 765

def remote_ipv6_scope_id; self[:"remote_ipv6_scope_id"]&.value; end

#remote_port ⇒ Integer

The remote port of the peer

Returns:

  • (Integer)

See Also:



770
 
# File 'nl-linux/generated/nl/linux/ovpn.rb', line 770

def remote_port; self[:"remote_port"]&.value; end

#tx_id ⇒ Integer

The ID value used when transmitting packets to this peer. This way outgoing packets can have a different ID than incoming ones. Useful in multipeer-to-multipeer connections, where each peer will advertise the tx-id to be used on the link.

Returns:

  • (Integer)

See Also:



805
 
# File 'nl-linux/generated/nl/linux/ovpn.rb', line 805

def tx_id; self[:"tx_id"]&.value; end

#vpn_ipv4 ⇒ Integer

The IPv4 address assigned to the peer by the server

Returns:

  • (Integer)

See Also:



775
 
# File 'nl-linux/generated/nl/linux/ovpn.rb', line 775

def vpn_ipv4; self[:"vpn_ipv4"]&.value; end

#vpn_ipv6 ⇒ String

The IPv6 address assigned to the peer by the server

Returns:

  • (String)

See Also:



780
 
# File 'nl-linux/generated/nl/linux/ovpn.rb', line 780

def vpn_ipv6; self[:"vpn_ipv6"]&.value; end