Class: Pio::Echo::Request

Inherits:

Message

Object
Message
Pio::Echo::Request

show all

Defined in:: lib/pio/echo/request.rb

Overview

OpenFlow 1.0 Echo Request message.

Instance Method Summary collapse

#initialize(user_options = {}) ⇒ Request constructor

Creates an EchoRequest OpenFlow message.

Methods inherited from Message

create_from

Constructor Details

#initialize ⇒ `Request` #initialize(transaction_id) ⇒ `Request` #initialize(user_options) ⇒ `Request`

Creates an EchoRequest OpenFlow message. This message can be used to measure the bandwidth of a controller/switch connection as well as to verify its liveness.

Overloads:

#initialize ⇒ Request
Examples:
```
Pio::Echo::Request.new
```
#initialize(transaction_id) ⇒ Request
Examples:
```
Pio::Echo::Request.new(123)
```
Parameters:
- transaction_id (Number) —
  
  An unsigned 32-bit integer number associated with this message.
#initialize(user_options) ⇒ Request
Examples:
```
Pio::Echo::Request.new(
  transaction_id: transaction_id,
  user_data: 'Thu Aug 25 13:09:00 +0900 2011'
)
```
Parameters:
- user_options (Hash) —
  
  The options to create a message with.
Options Hash (user_options):
- :transaction_id (Number)
- :xid (Number) —
  
  An alias to transaction_id.
- :user_data (String) —
  
  The user data field specified as a String may be a message timestamp to check latency, various lengths to measure bandwidth or zero-size(nil) to verify liveness between the switch and controller.



40
41
42

# File 'lib/pio/echo/request.rb', line 40

def initialize(user_options = {})
  super REQUEST, user_options
end