etri.sdn.controller.util

Class OFMessageDamper

java.lang.Object

etri.sdn.controller.util.OFMessageDamper

public final class OFMessageDamper
extends java.lang.Object

Dampens OFMessages sent to an OF switch. A message is only written to a switch if the same message (as defined by .equals()) has not been written in the last n milliseconds. Timer granularity is based on TimedCache

Author:

gregor, bjlee

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	OFMessageDamper.DamperEntry An entry in the TimedCache.

Field Summary

Fields

Modifier and Type	Field and Description
private TimedCache<OFMessageDamper.DamperEntry>	cache
private java.util.Set<org.openflow.protocol.interfaces.OFMessageType>	msgTypesToCache

Constructor Summary

Constructors

Constructor and Description
OFMessageDamper(int capacity, java.util.Set<org.openflow.protocol.interfaces.OFMessageType> typesToDampen, int timeout)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	write(Connection conn, org.openflow.protocol.OFMessage msg) write the messag to the switch according to our dampening settings

Methods inherited from class java.lang.Object

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

Field Detail

cache

private TimedCache<OFMessageDamper.DamperEntry> cache

msgTypesToCache

private java.util.Set<org.openflow.protocol.interfaces.OFMessageType> msgTypesToCache

Constructor Detail

OFMessageDamper

public OFMessageDamper(int capacity,
               java.util.Set<org.openflow.protocol.interfaces.OFMessageType> typesToDampen,
               int timeout)

Parameters:

capacity - the maximum number of messages that should be kept

typesToDampen - The set of OFMessageTypes that should be dampened by this instance. Other types will be passed through

timeout - The dampening timeout. A message will only be written if the last write for the an equal message more than timeout ms ago.

Method Detail

write

public boolean write(Connection conn,
            org.openflow.protocol.OFMessage msg)
              throws java.io.IOException

write the messag to the switch according to our dampening settings

Parameters:

conn - connection to write

msg - message to write

Returns:

true if the message was written to the switch, false if the message was dampened.

Throws:

java.io.IOException