com.outbackinc.services.protocol.snmp
Class SnmpOrderInfo

java.lang.Object
  |
  +--com.outbackinc.services.protocol.snmp.SnmpOrderInfo

All Implemented Interfaces:

java.io.Serializable

public class SnmpOrderInfo

extends java.lang.Object

implements java.io.Serializable

SnmpOrderInfo objects contain information about caching and retrying requests. All orders placed with a SnmpV123Session include this information. The same order object can be used for multiple orders, if desired. The information that each SnmpOrderInfo object contains is:

• cache threshhold
• timeout period for the message(s) sent.
• number of times to retry if a message times-out

See Also:

Serialized Form

Constructor Summary

SnmpOrderInfo(int iTimeout, int iRetries, long lCacheThreshhold)
Constructor.

Method Summary

long	getCacheThreshhold() The cache threshhold (in milliseconds).
int	getRetries() The number of times to retry if a timeout occurs.
int	getTimeout() The time (in seconds) to wait for a response before declaring a timeout.

Methods inherited from class java.lang.Object

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

Constructor Detail

SnmpOrderInfo

public SnmpOrderInfo(int iTimeout,
                     int iRetries,
                     long lCacheThreshhold)
              throws java.lang.IllegalArgumentException

Constructor.

Parameters:

iTimeout - the time (in seconds) to wait for a response before declaring a timeout

iRetries - the number of times to retry if a timeout occurs

lCacheThreshhold - the cache threshhold (in milliseconds). A cache hit will occur if the latest value for a particular object was retreived within the cache threshhold.

Throws:

java.lang.IllegalArgumentException - if iTimeout <= 0

Method Detail

getTimeout

public int getTimeout()

The time (in seconds) to wait for a response before declaring a timeout.

Returns:

timeout

getRetries

public int getRetries()

The number of times to retry if a timeout occurs.

Returns:

retries

getCacheThreshhold

public long getCacheThreshhold()

The cache threshhold (in milliseconds). A cache hit will occur if the latest value for a particular object was retreived within the cache threshhold.

Returns:

cache threshhold