Class: Nl::Linux::Ovpn::AttributeSets::Peer

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

Defined Under Namespace

Classes: Attribute, DelReason, Id, KeepaliveInterval, KeepaliveTimeout, LinkRxBytes, LinkRxPackets, LinkTxBytes, LinkTxPackets, LocalIpv4, LocalIpv6, LocalPort, RemoteIpv4, RemoteIpv6, RemoteIpv6ScopeId, RemotePort, Socket, SocketNetnsid, TxId, VpnIpv4, VpnIpv6, VpnRxBytes, VpnRxPackets, VpnTxBytes, VpnTxPackets

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:



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

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

.by_type(type) ⇒ Attribute

Looks up Attribute class by type value.

Parameters:

  • type (Integer)

Returns:



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

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

Instance Method Details

#del_reason ⇒ Integer

The reason why a peer was deleted

Known enum values are defined in Enums::DelPeerReason.

Returns:

  • (Integer)

See Also:



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

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

#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:



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

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:



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

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:



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

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

#link_rx_bytes ⇒ Integer

Number of bytes received at the transport level

Returns:

  • (Integer)

See Also:



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

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

#link_rx_packets ⇒ Integer

Number of packets received at the transport level

Returns:

  • (Integer)

See Also:



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

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

#link_tx_bytes ⇒ Integer

Number of bytes transmitted at the transport level

Returns:

  • (Integer)

See Also:



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

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

#link_tx_packets ⇒ Integer

Number of packets transmitted at the transport level

Returns:

  • (Integer)

See Also:



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

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

#local_ipv4 ⇒ Integer

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

Returns:

  • (Integer)

See Also:



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

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:



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

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

#local_port ⇒ Integer

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

Returns:

  • (Integer)

See Also:



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

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

#remote_ipv4 ⇒ Integer

The remote IPv4 address of the peer

Returns:

  • (Integer)

See Also:



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

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

#remote_ipv6 ⇒ String

The remote IPv6 address of the peer

Returns:

  • (String)

See Also:



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

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:



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

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:



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

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

#socket ⇒ Integer

The socket to be used to communicate with the peer

Returns:

  • (Integer)

See Also:



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

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

#socket_netnsid ⇒ Integer

The ID of the netns the socket assigned to this peer lives in

Returns:

  • (Integer)

See Also:



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

def socket_netnsid; self[:"socket_netnsid"]&.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:



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

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:



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

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:



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

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

#vpn_rx_bytes ⇒ Integer

Number of bytes received over the tunnel

Returns:

  • (Integer)

See Also:



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

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

#vpn_rx_packets ⇒ Integer

Number of packets received over the tunnel

Returns:

  • (Integer)

See Also:



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

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

#vpn_tx_bytes ⇒ Integer

Number of bytes transmitted over the tunnel

Returns:

  • (Integer)

See Also:



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

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

#vpn_tx_packets ⇒ Integer

Number of packets transmitted over the tunnel

Returns:

  • (Integer)

See Also:



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

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