org.openflow.protocol
Class AggregateStatsRequest

java.lang.Object
  extended by org.openflow.gui.net.protocol.OFGMessage
      extended by org.openflow.gui.net.protocol.StatsHeader
          extended by org.openflow.protocol.AggregateStatsRequest
All Implemented Interfaces:
Message<OFGMessageType>

public class AggregateStatsRequest
extends StatsHeader

A request for aggregate statistics.

Author:
David Underhill

Field Summary
static byte ALL_TABLES
           
 Match match
          Fields to match
static short OFPP_NONE
           
 short outPort
          Require matching entries to include this output port, or OFPP_NONE
 byte tableID
          ID of table to read or 0xFF for all tables
 
Fields inherited from class org.openflow.gui.net.protocol.StatsHeader
dpid, flags, REPLY, REQUEST, statsType
 
Fields inherited from class org.openflow.gui.net.protocol.OFGMessage
SIZEOF, timeCreated, TSSEP, type, xid
 
Constructor Summary
AggregateStatsRequest(long dpid)
          Create an aggregate stats request from the switch with this DPID.
AggregateStatsRequest(long dpid, short outPort)
          Create an aggregate stats request from the switch with this DPID and port.
AggregateStatsRequest(long dpid, short outPort, Match m)
          Create an aggregate stats request from the switch with this DPID, port, and match.
AggregateStatsRequest(long dpid, short outPort, Match m, byte tableID)
          Create an aggregate stats request from the switch with this DPID, port, match, and table ID.
AggregateStatsRequest(long dpid, StatsFlag flags, java.io.DataInput in)
          Create an aggregate request for stats from the switch with the specified DPID and flags and read the request from the receive buffer.
 
Method Summary
 boolean isStatefulRequest()
          returns true because this message is part of a stateful exchange
 int length()
          total length of this message in bytes
 java.lang.String toString()
          String representation of the message including the date and type.
 void write(java.io.DataOutput out)
          sends the message over the specified output stream
 
Methods inherited from class org.openflow.gui.net.protocol.OFGMessage
getType, isStatefulReply, timeCreated
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ALL_TABLES

public static final byte ALL_TABLES
See Also:
Constant Field Values

OFPP_NONE

public static final short OFPP_NONE
See Also:
Constant Field Values

match

public final Match match
Fields to match


tableID

public byte tableID
ID of table to read or 0xFF for all tables


outPort

public short outPort
Require matching entries to include this output port, or OFPP_NONE

Constructor Detail

AggregateStatsRequest

public AggregateStatsRequest(long dpid)
Create an aggregate stats request from the switch with this DPID.


AggregateStatsRequest

public AggregateStatsRequest(long dpid,
                             short outPort)
Create an aggregate stats request from the switch with this DPID and port.


AggregateStatsRequest

public AggregateStatsRequest(long dpid,
                             short outPort,
                             Match m)
Create an aggregate stats request from the switch with this DPID, port, and match.


AggregateStatsRequest

public AggregateStatsRequest(long dpid,
                             short outPort,
                             Match m,
                             byte tableID)
Create an aggregate stats request from the switch with this DPID, port, match, and table ID.


AggregateStatsRequest

public AggregateStatsRequest(long dpid,
                             StatsFlag flags,
                             java.io.DataInput in)
                      throws java.io.IOException
Create an aggregate request for stats from the switch with the specified DPID and flags and read the request from the receive buffer.

Throws:
java.io.IOException
Method Detail

isStatefulRequest

public boolean isStatefulRequest()
returns true because this message is part of a stateful exchange

Overrides:
isStatefulRequest in class OFGMessage

length

public int length()
total length of this message in bytes

Overrides:
length in class StatsHeader

write

public void write(java.io.DataOutput out)
           throws java.io.IOException
Description copied from class: OFGMessage
sends the message over the specified output stream

Overrides:
write in class StatsHeader
Throws:
java.io.IOException

toString

public java.lang.String toString()
Description copied from class: OFGMessage
String representation of the message including the date and type. Also includes the transaction ID if it is non-zero.

Overrides:
toString in class StatsHeader