NAME
Brocade::BSC::Node::OF::FlowEntry
DESCRIPTION
Model a flow table entry in an OpenFlow capable device.
METHODS
- new
-
Creates and returns a new Brocade::BSC::Node::OF::FlowEntry object.
### parameters: # + id # + cookie # + cookie_mask # + table_id # + priority # + idle_timeout # + hard_timeout # + strict # + out_port # + out_group # + flags # + flow_name # + installHw # + barrier # + buffer_id # + match # + instructions
- as_json
-
# Returns : FlowEntry as formatted JSON string.
- get_payload
-
# Returns : FlowEntry as formatted for transmission to controller.
- table_id
-
Set or retrieve the FlowEntry table id.
- flow_name
-
Set or retrieve the FlowEntry name.
- id
-
Set or retrieve the FlowEntry ID.
- install_hw
-
Set or retrieve the FlowEntry installHw flag. This is used to force the OpenFlow switch to do ordered message processing. Barrier request/reply messages are used by the controller to ensure message dependencies have been met or to receive notifications for completed operations. When the controller wants to ensure message dependencies have been met or wants to receive notifications for completed operations, it may use an OFPT_BARRIER_REQUEST message. This message has no body. Upon receipt, the switch must finish all previously received messages--including sending corresponding reply or error messages--before executing any messages beyond the Barrier Request.
- priority
-
Set or retrieve the FlowEntry priority.
- hard_timeout
-
Set or retrieve the FlowEntry hard timeout: max time before discarding packet (seconds).
- idle_timeout
-
Set or retrieve the FlowEntry idle timeout: idle time before discarding packets (seconds).
-
Set or retrieve the FlowEntry cookie.
-
Set or retrieve the FlowEntry cookie mask.
- strict
-
Set or retrieve the FlowEntry strict flag.
- add_instruction
-
Add a new instruction to the FlowEntry.
- add_match
-
Add a new match to the FlowEntry.
COPYRIGHT
Copyright (c) 2015, BROCADE COMMUNICATIONS SYSTEMS, INC
All rights reserved.