Modifier and Type	Class and Description
private static class	DGCClient.EndpointEntry EndpointEntry encapsulates the client-side DGC information specific to a particular Endpoint.

Modifier and Type	Field and Description
private static final int	cleanFailureRetries retry count for clean calls that fail with ConnectException
private static final long	cleanInterval maximum interval between retries of failed clean calls
private static final ObjID	dgcID ObjID for server-side DGC object
private static final int	dirtyFailureRetries minimum retry count for dirty calls that fail
private static final ObjID[]	emptyObjIDArray constant empty ObjID array for lease renewal optimization
private static final long	gcInterval maximum interval between complete garbage collections of local heap
private static final long	leaseValue lease duration to request (usually ignored by server)
private static long	nextSequenceNum next sequence number for DGC calls (access synchronized on class)
private static VMID	vmid unique identifier for this VM as a client of DGC

Access	Constructor and Description
private	DGCClient()

Modifier and Type	Method and Description
private static long	computeRenewTime(long grantTime, long duration) Given the length of a lease and the time that it was granted, compute the absolute time at which it should be renewed, giving room for reasonable computational and communication delays.
private static synchronized long	getNextSequenceNum() Get the next sequence number to be used for a dirty or clean operation from this VM.
pack-priv static void	registerRefs(Endpoint ep, List<LiveRef> refs) Register the LiveRef instances in the supplied list to participate in distributed garbage collection.

cleanFailureRetries	back to summary
private static final int cleanFailureRetries retry count for clean calls that fail with ConnectException

cleanInterval	back to summary
private static final long cleanInterval maximum interval between retries of failed clean calls

dgcID	back to summary
private static final ObjID dgcID ObjID for server-side DGC object

dirtyFailureRetries	back to summary
private static final int dirtyFailureRetries minimum retry count for dirty calls that fail

emptyObjIDArray	back to summary
private static final ObjID[] emptyObjIDArray constant empty ObjID array for lease renewal optimization

gcInterval	back to summary
private static final long gcInterval maximum interval between complete garbage collections of local heap

leaseValue	back to summary
private static final long leaseValue lease duration to request (usually ignored by server)

nextSequenceNum	back to summary
private static long nextSequenceNum next sequence number for DGC calls (access synchronized on class)

vmid	back to summary
private static VMID vmid unique identifier for this VM as a client of DGC

DGCClient	back to summary
private DGCClient()

computeRenewTime	back to summary
private static long computeRenewTime(long grantTime, long duration) Given the length of a lease and the time that it was granted, compute the absolute time at which it should be renewed, giving room for reasonable computational and communication delays.

getNextSequenceNum	back to summary
private static synchronized long getNextSequenceNum() Get the next sequence number to be used for a dirty or clean operation from this VM. This method should only be called while synchronized on the EndpointEntry whose data structures the operation affects.

registerRefs	back to summary
pack-priv static void registerRefs(Endpoint ep, List<LiveRef> refs) Register the LiveRef instances in the supplied list to participate in distributed garbage collection. All of the LiveRefs in the list must be for remote objects at the given endpoint.

private Class DGCClient.EndpointEntry

Class Inheritance

extends Object

java.lang.Object
sun.rmi.transport.DGCClient.EndpointEntry

EndpointEntry encapsulates the client-side DGC information specific to a particular Endpoint. Of most significance is the table that maps LiveRef value to RefEntry objects and the renew/clean thread that handles asynchronous client-side DGC operations.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	DGCClient.EndpointEntry.CleanRequest CleanRequest holds the data for the parameters of a clean call that needs to be made.
private class	DGCClient.EndpointEntry.RefEntry RefEntry encapsulates the client-side DGC information specific to a particular LiveRef value.
private class	DGCClient.EndpointEntry.RenewCleanThread RenewCleanThread handles the asynchronous client-side DGC activity for this entry: renewing the leases and making clean calls.

Field Summary

Modifier and Type	Field and Description
private DGC	dgc synthesized reference to the remote server-side DGC
private long	dirtyFailureDuration (average) elapsed time for recent failed dirty calls
private int	dirtyFailures count of recent dirty calls that have failed
private long	dirtyFailureStartTime absolute time of first recent failed dirty call
private Endpoint	endpoint the endpoint that this entry is for
private static Map<Endpoint, DGCClient.EndpointEntry>	endpointTable global endpoint table: maps Endpoint to EndpointEntry
private long	expirationTime absolute time current lease to this endpoint will expire
private static GC.LatencyRequest	gcLatencyRequest handle for GC latency request (for future cancellation)
private boolean	interruptible true if renew/clean thread may be interrupted
private Set<DGCClient.EndpointEntry.RefEntry>	invalidRefs set of RefEntry instances from last (failed) dirty call
private Set<DGCClient.EndpointEntry.CleanRequest>	pendingCleans set of clean calls that need to be made
private ReferenceQueue<LiveRef>	refQueue reference queue for phantom references
private Map<LiveRef, DGCClient.EndpointEntry.RefEntry>	refTable table of refs held for endpoint: maps LiveRef to RefEntry
private boolean	removed true if this entry has been removed from the global table
private Thread	renewCleanThread renew/clean thread for handling lease renewals and clean calls
private long	renewTime absolute time to renew current lease to this endpoint

Constructor Summary

Access	Constructor and Description
private	EndpointEntry(final Endpoint endpoint)

Method Summary

Modifier and Type	Method and Description
private static ObjID[]	createObjIDArray(Set<DGCClient.EndpointEntry.RefEntry> refEntries) Create an array of ObjIDs (needed for the DGC remote calls) from the ids in the given set of refs.
public static DGCClient.EndpointEntry	lookup(Endpoint ep) Look up the EndpointEntry for the given Endpoint.
private void	makeCleanCalls() Make all of the clean calls described by the clean requests in this entry's set of "pending cleans".
private void	makeDirtyCall(Set<DGCClient.EndpointEntry.RefEntry> refEntries, long sequenceNum) Make a DGC dirty call to this entry's endpoint, for the ObjIDs corresponding to the given set of refs and with the given sequence number.
private void	processPhantomRefs(DGCClient.EndpointEntry.RefEntry.PhantomLiveRef phantom) Process the notification of the given phantom reference and any others that are on this entry's reference queue.
public boolean	registerRefs(List<LiveRef> refs) Register the LiveRef instances in the supplied list to participate in distributed garbage collection.
private void	removeRefEntry(DGCClient.EndpointEntry.RefEntry refEntry) Remove the given RefEntry from the ref table.
private void	setRenewTime(long newRenewTime) Set the absolute time at which the lease for this entry should be renewed.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

dgc	back to summary
private DGC dgc synthesized reference to the remote server-side DGC

dirtyFailureDuration	back to summary
private long dirtyFailureDuration (average) elapsed time for recent failed dirty calls

dirtyFailures	back to summary
private int dirtyFailures count of recent dirty calls that have failed

dirtyFailureStartTime	back to summary
private long dirtyFailureStartTime absolute time of first recent failed dirty call

endpoint	back to summary
private Endpoint endpoint the endpoint that this entry is for

endpointTable	back to summary
private static Map<Endpoint, DGCClient.EndpointEntry> endpointTable global endpoint table: maps Endpoint to EndpointEntry

expirationTime	back to summary
private long expirationTime absolute time current lease to this endpoint will expire

gcLatencyRequest	back to summary
private static GC.LatencyRequest gcLatencyRequest handle for GC latency request (for future cancellation)

interruptible	back to summary
private boolean interruptible true if renew/clean thread may be interrupted

invalidRefs	back to summary
private Set<DGCClient.EndpointEntry.RefEntry> invalidRefs set of RefEntry instances from last (failed) dirty call

pendingCleans	back to summary
private Set<DGCClient.EndpointEntry.CleanRequest> pendingCleans set of clean calls that need to be made

refQueue	back to summary
private ReferenceQueue<LiveRef> refQueue reference queue for phantom references

refTable	back to summary
private Map<LiveRef, DGCClient.EndpointEntry.RefEntry> refTable table of refs held for endpoint: maps LiveRef to RefEntry

removed	back to summary
private boolean removed true if this entry has been removed from the global table

renewCleanThread	back to summary
private Thread renewCleanThread renew/clean thread for handling lease renewals and clean calls

renewTime	back to summary
private long renewTime absolute time to renew current lease to this endpoint

Constructor Detail

EndpointEntry	back to summary
private EndpointEntry(final Endpoint endpoint)

Method Detail

createObjIDArray	back to summary
private static ObjID[] createObjIDArray(Set<DGCClient.EndpointEntry.RefEntry> refEntries) Create an array of ObjIDs (needed for the DGC remote calls) from the ids in the given set of refs.

lookup	back to summary
public static DGCClient.EndpointEntry lookup(Endpoint ep) Look up the EndpointEntry for the given Endpoint. An entry is created if one does not already exist.

makeCleanCalls	back to summary
private void makeCleanCalls() Make all of the clean calls described by the clean requests in this entry's set of "pending cleans". Clean requests for clean calls that succeed are removed from the "pending cleans" set. This method must NOT be called while synchronized on this entry.

makeDirtyCall	back to summary
private void makeDirtyCall(Set<DGCClient.EndpointEntry.RefEntry> refEntries, long sequenceNum) Make a DGC dirty call to this entry's endpoint, for the ObjIDs corresponding to the given set of refs and with the given sequence number. This method must NOT be called while synchronized on this entry.

processPhantomRefs	back to summary
private void processPhantomRefs(DGCClient.EndpointEntry.RefEntry.PhantomLiveRef phantom) Process the notification of the given phantom reference and any others that are on this entry's reference queue. Each phantom reference is removed from its RefEntry's ref set. All ref entries that have no more registered instances are collected into up to two batched clean call requests: one for refs requiring a "strong" clean call, and one for the rest. This method must ONLY be called while synchronized on this entry.

processPhantomRefs

back to summary

private void processPhantomRefs(DGCClient.EndpointEntry.RefEntry.PhantomLiveRef phantom)

Process the notification of the given phantom reference and any others that are on this entry's reference queue. Each phantom reference is removed from its RefEntry's ref set. All ref entries that have no more registered instances are collected into up to two batched clean call requests: one for refs requiring a "strong" clean call, and one for the rest. This method must ONLY be called while synchronized on this entry.

registerRefs	back to summary
public boolean registerRefs(List<LiveRef> refs) Register the LiveRef instances in the supplied list to participate in distributed garbage collection. This method returns false if this entry was removed from the global endpoint table (because it was empty) before these refs could be registered. In that case, a new EndpointEntry needs to be looked up. This method must NOT be called while synchronized on this entry.

registerRefs

back to summary

public boolean registerRefs(List<LiveRef> refs)

Register the LiveRef instances in the supplied list to participate in distributed garbage collection. This method returns false if this entry was removed from the global endpoint table (because it was empty) before these refs could be registered. In that case, a new EndpointEntry needs to be looked up. This method must NOT be called while synchronized on this entry.

removeRefEntry	back to summary
private void removeRefEntry(DGCClient.EndpointEntry.RefEntry refEntry) Remove the given RefEntry from the ref table. If that makes the ref table empty, remove this entry from the global endpoint table. This method must ONLY be called while synchronized on this entry.

setRenewTime	back to summary
private void setRenewTime(long newRenewTime) Set the absolute time at which the lease for this entry should be renewed. This method must ONLY be called while synchronized on this entry.

sun.rmi.transport back to summary

private Class DGCClient.EndpointEntry.CleanRequest

Class Inheritance

extends Object

java.lang.Object
sun.rmi.transport.DGCClient.EndpointEntry.CleanRequest

CleanRequest holds the data for the parameters of a clean call that needs to be made.

Field Summary

Modifier and Type	Field and Description
pack-priv int	failures how many times this request has failed
pack-priv final ObjID[]	objIDs
pack-priv final long	sequenceNum
pack-priv final boolean	strong

Constructor Summary

Access	Constructor and Description
pack-priv	CleanRequest(ObjID[] objIDs, long sequenceNum, boolean strong)

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

failures	back to summary
pack-priv int failures how many times this request has failed

objIDs	back to summary
pack-priv final ObjID[] objIDs

sequenceNum	back to summary
pack-priv final long sequenceNum

strong	back to summary
pack-priv final boolean strong

Constructor Detail

CleanRequest	back to summary
pack-priv CleanRequest(ObjID[] objIDs, long sequenceNum, boolean strong)

sun.rmi.transport back to summary

private Class DGCClient.EndpointEntry.RefEntry

Class Inheritance

extends Object

java.lang.Object
sun.rmi.transport.DGCClient.EndpointEntry.RefEntry

RefEntry encapsulates the client-side DGC information specific to a particular LiveRef value. In particular, it contains a set of phantom references to all of the instances of the LiveRef value registered in the system (but not garbage collected locally).

Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	DGCClient.EndpointEntry.RefEntry.PhantomLiveRef PhantomLiveRef is a PhantomReference to a LiveRef instance, used to detect when the LiveRef becomes permanently unreachable in this VM.

Field Summary

Modifier and Type	Field and Description
private boolean	dirtyFailed true if a dirty call containing this ref has failed
private LiveRef	ref LiveRef value for this entry (not a registered instance)
private Set<DGCClient.EndpointEntry.RefEntry.PhantomLiveRef>	refSet set of phantom references to registered instances

Constructor Summary

Access	Constructor and Description
public	RefEntry(LiveRef ref)

Method Summary

Modifier and Type	Method and Description
public void	addInstanceToRefSet(LiveRef ref) Add a LiveRef to the set of registered instances for this entry.
public LiveRef	getRef() Return the LiveRef value for this entry (not a registered instance).
public boolean	hasDirtyFailed() Return true if a dirty call that explicitly contained this entry's ref has failed (and therefore a clean call for this ref needs to be marked "strong").
public boolean	isRefSetEmpty() Return true if there are no registered LiveRef instances for this entry still reachable in this VM.
public void	markDirtyFailed() Record that a dirty call that explicitly contained this entry's ref has failed.
public void	removeInstanceFromRefSet(DGCClient.EndpointEntry.RefEntry.PhantomLiveRef phantom) Remove a PhantomLiveRef from the set of registered instances.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

dirtyFailed	back to summary
private boolean dirtyFailed true if a dirty call containing this ref has failed

ref	back to summary
private LiveRef ref LiveRef value for this entry (not a registered instance)

refSet	back to summary
private Set<DGCClient.EndpointEntry.RefEntry.PhantomLiveRef> refSet set of phantom references to registered instances

Constructor Detail

RefEntry	back to summary
public RefEntry(LiveRef ref)

Method Detail

addInstanceToRefSet	back to summary
public void addInstanceToRefSet(LiveRef ref) Add a LiveRef to the set of registered instances for this entry. This method must ONLY be invoked while synchronized on this RefEntry's EndpointEntry.

getRef	back to summary
public LiveRef getRef() Return the LiveRef value for this entry (not a registered instance).

hasDirtyFailed	back to summary
public boolean hasDirtyFailed() Return true if a dirty call that explicitly contained this entry's ref has failed (and therefore a clean call for this ref needs to be marked "strong"). This method must ONLY be invoked while synchronized on this RefEntry's EndpointEntry.

isRefSetEmpty	back to summary
public boolean isRefSetEmpty() Return true if there are no registered LiveRef instances for this entry still reachable in this VM. This method must ONLY be invoked while synchronized on this RefEntry's EndpointEntry.

markDirtyFailed	back to summary
public void markDirtyFailed() Record that a dirty call that explicitly contained this entry's ref has failed. This method must ONLY be invoked while synchronized on this RefEntry's EndpointEntry.

removeInstanceFromRefSet	back to summary
public void removeInstanceFromRefSet(DGCClient.EndpointEntry.RefEntry.PhantomLiveRef phantom) Remove a PhantomLiveRef from the set of registered instances. This method must ONLY be invoked while synchronized on this RefEntry's EndpointEntry.

sun.rmi.transport back to summary

private Class DGCClient.EndpointEntry.RefEntry.PhantomLiveRef

Class Inheritance

extends PhantomReference<LiveRef>

java.lang.Object
java.lang.ref.Reference
java.lang.ref.PhantomReference
sun.rmi.transport.DGCClient.EndpointEntry.RefEntry.PhantomLiveRef

PhantomLiveRef is a PhantomReference to a LiveRef instance, used to detect when the LiveRef becomes permanently unreachable in this VM.

Constructor Summary

Access	Constructor and Description
public	PhantomLiveRef(LiveRef ref)

Method Summary

Modifier and Type	Method and Description
public DGCClient.EndpointEntry.RefEntry	getRefEntry()

Inherited from java.lang.ref.PhantomReference:: get

Constructor Detail

PhantomLiveRef	back to summary
public PhantomLiveRef(LiveRef ref)

Method Detail

getRefEntry	back to summary
public DGCClient.EndpointEntry.RefEntry getRefEntry()

sun.rmi.transport back to summary

private Class DGCClient.EndpointEntry.RenewCleanThread

Class Inheritance

extends Object
implements Runnable

java.lang.Object
sun.rmi.transport.DGCClient.EndpointEntry.RenewCleanThread

All Implemented Interfaces

java.lang.Runnable

RenewCleanThread handles the asynchronous client-side DGC activity for this entry: renewing the leases and making clean calls.

Constructor Summary

Access	Constructor and Description
private	RenewCleanThread()

Method Summary

Modifier and Type	Method and Description
public void	run() Implements java.lang.Runnable.run. Runs this operation.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

RenewCleanThread	back to summary
private RenewCleanThread()

Method Detail

run

back to summary

public void run()

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.

pack-priv final Class DGCClient

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class DGCClient.EndpointEntry

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class DGCClient.EndpointEntry.CleanRequest

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

private Class DGCClient.EndpointEntry.RefEntry

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class DGCClient.EndpointEntry.RefEntry.PhantomLiveRef

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class DGCClient.EndpointEntry.RenewCleanThread

Constructor Summary

Method Summary

Constructor Detail

Method Detail