org.openflow.gui.net.protocol
Class PollStart

java.lang.Object
  org.openflow.gui.net.protocol.OFGMessage
      org.openflow.gui.net.protocol.PollStart

All Implemented Interfaces:

Message<OFGMessageType>

public class PollStart
extends OFGMessage

OFGMessage which tells the backend to periodically send a message for us.

Author:

David Underhill

Field Summary

OFGMessage	msg the message to poll
short	pollInterval time between copies of this message being sent out (in units of 100ms, e.g.

Fields inherited from class org.openflow.gui.net.protocol.OFGMessage

SIZEOF, timeCreated, TSSEP, type, xid

Constructor Summary

PollStart(short pollInterval, OFGMessage msg)
Construct a PollStart message.

Method Summary

int	length() This returns the maximum length of LinkSubscribe
java.lang.String	toString() String representation of the message including the date and type.
void	write(java.io.DataOutput out) Writes the header (via super.write()), the poll interval, and poll message

Methods inherited from class org.openflow.gui.net.protocol.OFGMessage

getType, isStatefulReply, isStatefulRequest, timeCreated

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

pollInterval

public final short pollInterval

time between copies of this message being sent out (in units of 100ms, e.g. pollInterval=5 => poll every 500ms)

msg

public final OFGMessage msg

the message to poll

Constructor Detail

PollStart

public PollStart(short pollInterval,
                 OFGMessage msg)

Construct a PollStart message.

Parameters:

pollInterval - how often (in 100ms units) for the backend to send this message; if 0, then it will be sent only once

msg - the message to send

Method Detail

length

public int length()

This returns the maximum length of LinkSubscribe

Overrides:

length in class OFGMessage

write

public void write(java.io.DataOutput out)
           throws java.io.IOException

Writes the header (via super.write()), the poll interval, and poll message

Overrides:

write in class OFGMessage

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 OFGMessage