org.snmp4j.mp

Class MPv3.Cache

java.lang.Object

org.snmp4j.mp.MPv3.Cache

Enclosing class:

MPv3

protected static class MPv3.Cache
extends Object

The Cache stores state reference information for the MPv3.

Version:

1.0

Author:

Frank Fock

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Cache()

Method Summary

Modifier and Type	Method and Description
int	addEntry(StateReference<?> entry) Adds a StateReference to the cache.
boolean	deleteEntry(PduHandle pduHandle) Delete the cache entry with the supplied PduHandle.
StateReference<?>	popEntry(MessageID messageID) Pop the cache entry with the supplied ID from the cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

Cache

protected Cache()

Method Detail

addEntry

public int addEntry(StateReference<?> entry)

Adds a StateReference to the cache. The PduHandle of the supplied entry will be set to null when the new entry is already part of the cache, because the cache uses a WeakHashMap internally which uses the PduHandle as key. If the new entry equals an existing entry except of the message ID then the new message ID will be added to the existing entry.

Parameters:

entry - the state reference to add.

Returns:

SnmpConstants.SNMP_MP_DOUBLED_MESSAGE if the entry already exists and SnmpConstants.SNMP_MP_OK on success.

deleteEntry

public boolean deleteEntry(PduHandle pduHandle)

Delete the cache entry with the supplied PduHandle.

Parameters:

pduHandle - a pduHandle.

Returns:

true if an entry has been deleted, false otherwise.

popEntry

public StateReference<?> popEntry(MessageID messageID)

Pop the cache entry with the supplied ID from the cache.

Parameters:

messageID - a message ID.

Returns:

a MPv3.CacheEntry instance with the given message ID or null if such an entry cannot be found. If a cache entry is returned, the same is removed from the cache.