Lease Class Reference

List of all members.


Detailed Description

Encapsulates a Jini Lease object.

Public Member Functions

long long getExpiration () const
 Returns a value that indicates the time that the lease will expire.
std::string getUid () const
 Lease (const Lease &src)
void setUid (std::string uid)

Static Public Attributes

static const long long ABSOLUTE_TIME = 2
 The serialized form of the lease will contain the time of expiration stored as an absolute time, represented in terms of milliseconds since the beginning of the epoch.
static const long long ANY = -1
 Indicates that there is no particular lease time desired.
static const long long DURATION = 0x1
 The serialized form of the lease will convert the time of lease expiration into a duration (in milliseconds) from the time of serialization.
static const long long FOREVER = LLONG_MAX
 Used to request a lease that never expires.

Member Function Documentation

long long Lease::getExpiration (  )  const [inline]

Returns a value that indicates the time that the lease will expire.

This time is represented as milliseconds from the beginning of the epoch, relative to the local clock.

Returns:
Expiration time.

std::string Lease::getUid (  )  const

gets the UID of the lease object

Returns:
UID of lease object

void Lease::setUid ( std::string  uid  ) 

sets the UID of the lease object

Returns:
nothing


Member Data Documentation

const long long Lease::ABSOLUTE_TIME = 2 [static]

The serialized form of the lease will contain the time of expiration stored as an absolute time, represented in terms of milliseconds since the beginning of the epoch.

const long long Lease::ANY = -1 [static]

Indicates that there is no particular lease time desired.

The effective duration will be the same as FOREVER.

const long long Lease::DURATION = 0x1 [static]

The serialized form of the lease will convert the time of lease expiration into a duration (in milliseconds) from the time of serialization.

This form is best used when transmitting a Lease object from one address space to another (via an RMI call) where it cannot be assumed that the address spaces have synchronized clocks.

const long long Lease::FOREVER = LLONG_MAX [static]

Used to request a lease that never expires.


Generated on Thu Jul 22 08:11:54 2010 for GigaSpaces XAP 9.5 C++ by  doxygen 1.5.3