SimpleLeaseManager

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.psepr.jClient
Class SimpleLeaseManager

java.lang.Object
  org.psepr.jClient.LeaseManager
      org.psepr.jClient.SimpleLeaseManager

All Implemented Interfaces:: EventReceiver, PayloadParser

public class SimpleLeaseManager
extends LeaseManager
extends LeaseManager

The simple lease manager tries to manage a lease of a fixed duration and, when the end of the lease nears, to request a new lease of that duration again. The effect is to keep the lease active until this.release() is called.

The use of this class is:

 LeaseManager myLM = new SimpleLeaseManager(channelName, leaseDurationInSeconds);
 PsEPRLease myLease = pConn.getLease(channelName, payloadParser, eventReceiver, myLM);
 ....
 pConn.releaseLease(myLease);

There are also calls in PsEPRConnection.getLease that hide the use of SimpleLeaseManager with a call that just specifies a duration:

 PsEPRLease myLease = pConn.getLease(channelName, payloadParser, eventReceiver, leaseDurationInSeconds);
 ...
 pConn.releaseLease(myLease);

This lease manager has several states:

LEASE_INACTIVE: no lease requested. Sitting idle.
LEASE_PENDING: have initially asked for a lease an am waiting for a lease reply
LEASE_ACTIVE: have received a lease message for a request lease
LEASE_RENEGOTIATING: are renegotiating the lease for a previously granted lease. This happens when 70% of the lease period has passed.
LEASE_EXPIRED: we've asked for a lease and retried asking for it but we have never received a lease acknowledgement request. No more lease requests will be sent out unless this.start() is called again.
LEASE_RELEASE: have been asked to release the lease. No more lease messages will be sent out.

A timeout routine is set while a lease is pending, active or renegotiating. If LEASE_ACTIVE, the timeout is LongTimeoutPercent/100 th of the granted time period and it causes this to renegotiate for a longer lease. If LEASE_PENDING or LEASE_RENEGOTIATING, the retry counter is counted down (starts at MaxRetries and counts down to zero) and the lease request is retried. In this case, the timeout period is ShortTimeoutPercent/100 th of the requested lease length.

Author:: Robert.Adams@intel.com

Constructor Summary
`SimpleLeaseManager()`
`SimpleLeaseManager(PsEPRConnection pConn, java.lang.String chan, java.lang.String type)`
`SimpleLeaseManager(PsEPRConnection pConn, java.lang.String chan, java.lang.String type, long interval)`

Method Summary
`void`	`forceRenegotiation()` Called to make the lease ask for permission again.
`java.lang.String`	`getChannel()`
`boolean`	`getLeaseActive()`
`long`	`getLeaseGranted()`
`java.lang.String`	`getLeaseID()` Return the unique identifier for the lease
`int`	`getLeaseState()`
`java.lang.String`	`getLeaseStateName()`
`long`	`getLeaseWindow()`
`int`	`getLongTimeoutPercent()`
`long`	`getLongTimeoutPeriod()`
`int`	`getMaxRetries()`
`int`	`getRetriesRemaining()`
`int`	`getShortTimeoutPeriod()`
`java.lang.String`	`getType()`
`boolean`	`receiveEvent(PsEPREvent pE)` Called to see if I want to process this event.
`void`	`release()` Release our lease.
`void`	`setChannel(java.lang.String chan)`
`void`	`setLeaseGranted(long lg)`
`void`	`setLeaseID(java.lang.String xx)`
`void`	`setLeaseWindow(long lw)` Set the duration of the lease.
`void`	`setLongTimeoutPercent(int xx)`
`void`	`setMaxRetries(int mr)`
`void`	`setRetriesRemaining(int mr)`
`void`	`setShortTimeoutPeriod(int xx)`
`void`	`setType(java.lang.String tp)`
`void`	`start()` Start the lease.

Methods inherited from class org.psepr.jClient.LeaseManager
`getConnection, getNamespace, parsePayload, setConnection, setNamespace`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail