Class: Nl::Linux::OvsFlow::AttributeSets::FlowAttrs

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

Defined Under Namespace

Classes: Actions, Attribute, Clear, Key, Mask, Pad, Probe, Stats, TcpFlags, Ufid, UfidFlags, Used

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:



855
 
# File 'nl-linux/generated/nl/linux/ovs_flow.rb', line 855

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

.by_type(type) ⇒ Attribute

Looks up Attribute class by type value.

Parameters:

  • type (Integer)

Returns:



861
 
# File 'nl-linux/generated/nl/linux/ovs_flow.rb', line 861

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

Instance Method Details

#actions ⇒ AttributeSets::ActionAttrs

Nested attributes specifying the actions to take for packets that match the key. Always present in notifications. Required for OVS_FLOW_CMD_NEW requests, optional for OVS_FLOW_CMD_SET requests. An OVS_FLOW_CMD_SET without OVS_FLOW_ATTR_ACTIONS will not modify the actions. To clear the actions, an OVS_FLOW_ATTR_ACTIONS without any nested attributes must be given.

Returns:

See Also:



783
 
# File 'nl-linux/generated/nl/linux/ovs_flow.rb', line 783

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

#clear ⇒ Integer

If present in a OVS_FLOW_CMD_SET request, clears the last-used time, accumulated TCP flags, and statistics for this flow. Otherwise ignored in requests. Never present in notifications.

Returns:

  • (Integer)

See Also:



811
 
# File 'nl-linux/generated/nl/linux/ovs_flow.rb', line 811

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

#key ⇒ AttributeSets::KeyAttrs

Nested attributes specifying the flow key. Always present in notifications. Required for all requests (except dumps).

Returns:

See Also:



773
 
# File 'nl-linux/generated/nl/linux/ovs_flow.rb', line 773

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

#mask ⇒ AttributeSets::KeyAttrs

Nested attributes specifying the mask bits for wildcarded flow match. Mask bit value '1' specifies exact match with corresponding flow key bit, while mask bit value '0' specifies a wildcarded match. Omitting attribute is treated as wildcarding all corresponding fields. Optional for all requests. If not present, all flow key bits are exact match bits.

Returns:

See Also:



821
 
# File 'nl-linux/generated/nl/linux/ovs_flow.rb', line 821

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

#pad ⇒ String

Returns:

  • (String)

See Also:



848
 
# File 'nl-linux/generated/nl/linux/ovs_flow.rb', line 848

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

#probe ⇒ String

Flow operation is a feature probe, error logging should be suppressed.

Returns:

  • (String)

See Also:



826
 
# File 'nl-linux/generated/nl/linux/ovs_flow.rb', line 826

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

#stats ⇒ Structs::OvsFlowStats

Statistics for this flow. Present in notifications if the stats would be nonzero. Ignored in requests.

Returns:

See Also:



789
 
# File 'nl-linux/generated/nl/linux/ovs_flow.rb', line 789

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

#tcp_flags ⇒ Integer

An 8-bit value giving the ORed value of all of the TCP flags seen on packets in this flow. Only present in notifications for TCP flows, and only if it would be nonzero. Ignored in requests.

Returns:

  • (Integer)

See Also:



796
 
# File 'nl-linux/generated/nl/linux/ovs_flow.rb', line 796

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

#ufid ⇒ String

A value between 1-16 octets specifying a unique identifier for the flow. Causes the flow to be indexed by this value rather than the value of the OVS_FLOW_ATTR_KEY attribute. Optional for all requests. Present in notifications if the flow was created with this attribute.

Returns:

  • (String)

See Also:



835
 
# File 'nl-linux/generated/nl/linux/ovs_flow.rb', line 835

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

#ufid_flags ⇒ Integer

A 32-bit value of ORed flags that provide alternative semantics for flow installation and retrieval. Optional for all requests.

Known flags are defined in Flags::OvsUfidFlags.

Returns:

  • (Integer)

See Also:



844
 
# File 'nl-linux/generated/nl/linux/ovs_flow.rb', line 844

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

#used ⇒ Integer

A 64-bit integer giving the time, in milliseconds on the system monotonic clock, at which a packet was last processed for this flow. Only present in notifications if a packet has been processed for this flow. Ignored in requests.

Returns:

  • (Integer)

See Also:



804
 
# File 'nl-linux/generated/nl/linux/ovs_flow.rb', line 804

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