javadoc clean-up for commmunications/membership classes
Project: http://git-wip-us.apache.org/repos/asf/incubator-geode/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-geode/commit/40f95887 Tree: http://git-wip-us.apache.org/repos/asf/incubator-geode/tree/40f95887 Diff: http://git-wip-us.apache.org/repos/asf/incubator-geode/diff/40f95887 Branch: refs/heads/master Commit: 40f95887bfafc0720b0bdfc4984d711c15f4c791 Parents: f230349 Author: Bruce Schuchardt <[email protected]> Authored: Fri Jul 22 09:05:24 2016 -0700 Committer: Bruce Schuchardt <[email protected]> Committed: Fri Jul 22 09:07:23 2016 -0700 ---------------------------------------------------------------------- .../internal/DistributionAdvisor.java | 2 +- .../internal/locks/Collaboration.java | 6 +- .../internal/locks/DLockGrantor.java | 80 ++++++++++---------- .../internal/locks/GrantorRequestProcessor.java | 6 +- .../membership/gms/fd/GMSHealthMonitor.java | 2 - .../gms/messenger/JGroupsMessenger.java | 2 - .../gms/mgr/GMSMembershipManager.java | 1 + .../cache/tier/InternalClientMembership.java | 4 +- .../cache/tier/sockets/AcceptorImpl.java | 4 +- .../cache/tier/sockets/CacheClientProxy.java | 2 +- .../gemfire/internal/tcp/ConnectionTable.java | 2 +- 11 files changed, 54 insertions(+), 57 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/40f95887/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/DistributionAdvisor.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/DistributionAdvisor.java b/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/DistributionAdvisor.java index cefe9da..41fc4a6 100644 --- a/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/DistributionAdvisor.java +++ b/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/DistributionAdvisor.java @@ -175,7 +175,7 @@ public class DistributionAdvisor { /** * Hold onto removed profiles to compare to late-processed profiles. Fix for * bug 36881. Protected by synchronizing on this DistributionAdvisor. - * @guarded.By this DistributionAdvisor + * guarded.By this DistributionAdvisor */ private final Map removedProfiles = new HashMap(); http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/40f95887/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/locks/Collaboration.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/locks/Collaboration.java b/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/locks/Collaboration.java old mode 100755 new mode 100644 index cb36fd9..061154a --- a/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/locks/Collaboration.java +++ b/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/locks/Collaboration.java @@ -50,7 +50,7 @@ public class Collaboration { /** The current topic of collaboration * - * @guarded.By {@link #topicsQueue} + * guarded.By {@link #topicsQueue} */ private volatile Topic currentTopic; @@ -353,8 +353,8 @@ public class Collaboration { private final Object topicObject; /** - * @guarded.By {@link Collaboration#topicsQueue} - * @guarded.By this instance, <em>after</em> acquiring the topicsQueue + * guarded.By {@link Collaboration#topicsQueue} + * guarded.By this instance, <em>after</em> acquiring the topicsQueue */ private final List participatingThreads = new ArrayList(); http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/40f95887/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/locks/DLockGrantor.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/locks/DLockGrantor.java b/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/locks/DLockGrantor.java index 21a0300..3fcc720 100644 --- a/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/locks/DLockGrantor.java +++ b/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/locks/DLockGrantor.java @@ -90,7 +90,7 @@ public class DLockGrantor { * Map of grant tokens for tracking grantor-side state of distributed locks. * Key: Object name, Value: DLockGrantToken grant * - * @guarded.By grantTokens + * guarded.By grantTokens */ private final Map grantTokens = new HashMap(); @@ -118,7 +118,7 @@ public class DLockGrantor { * transfer grantorship request. At that point the state will be HALTED as * described above. * - * @guarded.By this + * guarded.By this */ private volatile int state = INITIALIZING; @@ -134,7 +134,7 @@ public class DLockGrantor { * <p> * Handling of batch locks synchronizes on this to assure serial processing. * - * @guarded.By batchLocks + * guarded.By batchLocks */ private final Map batchLocks = new HashMap(); @@ -199,7 +199,7 @@ public class DLockGrantor { /** * FIFO queue for suspend read and write lock waiters. * - * @guarded.By {@link #suspendLock} + * guarded.By {@link #suspendLock} */ private final LinkedList suspendQueue = new LinkedList(); @@ -208,28 +208,28 @@ public class DLockGrantor { * <p> * Key=RemoteThread, Value=ReadLockCount * - * @guarded.By {@link #suspendLock} + * guarded.By {@link #suspendLock} */ private final HashMap readLockCountMap = new HashMap(); /** * Number of suspend waiters waiting for write lock. * - * @guarded.By {@link #suspendLock} + * guarded.By {@link #suspendLock} */ private int writeLockWaiters = 0; /** * Total number of read locks held against suspend write lock. * - * @guarded.By {@link #suspendLock} + * guarded.By {@link #suspendLock} */ private int totalReadLockCount = 0; /** * List of next requests to process after handling an unlock or resume. * - * @guarded.By {@link #suspendLock} + * guarded.By {@link #suspendLock} */ private ArrayList permittedRequests = new ArrayList(); @@ -237,7 +237,7 @@ public class DLockGrantor { * List of active drains of permittedRequests. TODO: does this need to be * a synchronizedList? * - * @guarded.By {@link #suspendLock} + * guarded.By {@link #suspendLock} */ private final List permittedRequestsDrain = Collections.synchronizedList(new LinkedList()); @@ -815,7 +815,7 @@ public class DLockGrantor { * suspendLock and the grant token. * * @param request the lock request to be processed by this grantor - * @guarded.By {@link #acquireDestroyReadLock(long)} + * guarded.By {@link #acquireDestroyReadLock(long)} */ private void handlePermittedLockRequest(final DLockRequestMessage request) { if (logger.isTraceEnabled(LogMarker.DLS)) { @@ -1050,7 +1050,7 @@ public class DLockGrantor { * @param name the name of the lock to release * @param owner the member attempting to release the granted lock * @param lockId the id of the lease used by the owner - * @guarded.By {@link #acquireDestroyReadLock(long)} + * guarded.By {@link #acquireDestroyReadLock(long)} */ private void getAndReleaseGrantIfLockedBy(Object name, InternalDistributedMember owner, @@ -1290,7 +1290,7 @@ public class DLockGrantor { * Caller must acquire destroyWriteLock. Synchronizes on suspendLock, * grantTokens, and each grant token. * - * @guarded.By {@link #acquireDestroyWriteLock(long)} + * guarded.By {@link #acquireDestroyWriteLock(long)} */ private void destroyGrantor() { Assert.assertHoldsLock(this,true); @@ -1352,7 +1352,7 @@ public class DLockGrantor { * Caller must acquire destroyWriteLock. * * @param requests the requests to respond to - * @guarded.By {@link #acquireDestroyWriteLock(long)} + * guarded.By {@link #acquireDestroyWriteLock(long)} */ private void respondWithNotGrantor(Iterator requests) { while (requests.hasNext()) { @@ -1688,7 +1688,7 @@ public class DLockGrantor { * * @param name the key to fetch the grant token value for * @return the grant token stored under key name - * @guarded.By {@link #grantTokens} + * guarded.By {@link #grantTokens} */ private DLockGrantToken basicGetGrantToken(Object name) { return (DLockGrantToken) this.grantTokens.get(name); @@ -1700,7 +1700,7 @@ public class DLockGrantor { * Caller must synchronize on grantTokens * * @param grantToken the grant token to store in the map - * @guarded.By {@link #grantTokens} + * guarded.By {@link #grantTokens} */ private void basicPutGrantToken(DLockGrantToken grantToken) { this.grantTokens.put(grantToken.getName(), grantToken); @@ -1713,7 +1713,7 @@ public class DLockGrantor { * Caller must synchronize on grantTokens and then the grantToken. * * @param grantToken the grant token to remove from the map. - * @guarded.By {@link #grantTokens} and grantToken + * guarded.By {@link #grantTokens} and grantToken */ private void basicRemoveGrantToken(DLockGrantToken grantToken) { Object removed = this.grantTokens.remove(grantToken.getName()); // changed to ref token @@ -1789,7 +1789,7 @@ public class DLockGrantor { /** * True to enable test hook to sleep while handling suspend to cause timeout. * - * @guarded.By {@link #suspendLock} + * guarded.By {@link #suspendLock} */ private int debugHandleSuspendTimeouts = 0; @@ -2019,7 +2019,7 @@ public class DLockGrantor { } /** - * @guarded.By {@link #suspendLock} + * guarded.By {@link #suspendLock} */ private void postReleaseSuspendLock(RemoteThread rThread, Object lock) { if (!isLockingSuspendedBy(rThread)) { @@ -2073,7 +2073,7 @@ public class DLockGrantor { } /** - * @guarded.By {@link #suspendLock} + * guarded.By {@link #suspendLock} */ private void postReleaseReadLock(RemoteThread rThread, Object lock) { final boolean isDebugEnabled_DLS = logger.isTraceEnabled(LogMarker.DLS); @@ -2391,7 +2391,7 @@ public class DLockGrantor { /** * Verify the waiters (for debugging) * - * @guarded.By {@link #suspendLock} + * guarded.By {@link #suspendLock} */ private void checkWriteLockWaiters() { if (!DEBUG_SUSPEND_LOCK) { @@ -2412,7 +2412,7 @@ public class DLockGrantor { /** * Debugging method * - * @guarded.By {@link #suspendLock} + * guarded.By {@link #suspendLock} */ private void checkTotalReadLockCount() { if (!DEBUG_SUSPEND_LOCK) { @@ -2453,7 +2453,7 @@ public class DLockGrantor { /** * Pending requests queued up for the lock * - * @guarded.By this + * guarded.By this */ private LinkedList pendingRequests; @@ -2461,14 +2461,14 @@ public class DLockGrantor { * The reply processor id is used to identify the specific lock operation * used by the lessee to lease this lock * - * @guarded.By this + * guarded.By this */ private int leaseId = -1; /** * Distributed member that currently has a lease on this lock * - * @guarded.By this + * guarded.By this */ private InternalDistributedMember lessee; @@ -2478,28 +2478,28 @@ public class DLockGrantor { * leased out, the value is > 0. A value of Long.MAX_VALUE indicates a * non-expiring (infinite) lease. * - * @guarded.By this + * guarded.By this */ private long leaseExpireTime = -1; /** * Current count of threads attempting to access this grant token. * - * @guarded.By this + * guarded.By this */ private int accessCount = 0; /** * True if this token has been destroyed and removed from usage. * - * @guarded.By this + * guarded.By this */ private boolean destroyed = false; /** * RemoteThread identity of thread currently holding lease on this lock * - * @guarded.By this + * guarded.By this */ private RemoteThread lesseeThread = null; @@ -2868,7 +2868,7 @@ public class DLockGrantor { * Caller must synchronize on this grant token. * * @param requestsToRemove the pending requests to remove - * @guarded.By this + * guarded.By this */ private void removeRequests(Collection requestsToRemove) { if (!requestsToRemove.isEmpty()) { @@ -2939,7 +2939,7 @@ public class DLockGrantor { * * @param request the request to grant the lock to * @return leaseExpireTime or -1 if failed to grant. - * @guarded.By this + * guarded.By this */ private long grantAndRespondToRequest(DLockRequestMessage request) { @@ -3045,7 +3045,7 @@ public class DLockGrantor { * Caller must synchronize on this grant token. * * @return a string of the pending requests for logging or debugging - * @guarded.By this + * guarded.By this */ private String pendingRequestsToString() { if (this.pendingRequests == null) { @@ -3124,7 +3124,7 @@ public class DLockGrantor { * Caller must synchronize on this grant token. * * @return the lock id used to lease this lock - * @guarded.By this + * guarded.By this */ int getLockId() { return this.leaseId; @@ -3136,7 +3136,7 @@ public class DLockGrantor { * Caller must synchronize on this grant token. * * @return the identity of the thread that has this lock leased - * @guarded.By this + * guarded.By this */ RemoteThread getRemoteThread() { return this.lesseeThread; @@ -3279,7 +3279,7 @@ public class DLockGrantor { * @param newLeaseExpireTime the absolute expiration time * @param lockId the lock id used to request the lock * @param remoteThread identity of the locking thread - * @guarded.By this + * guarded.By this */ void grantLock(InternalDistributedMember owner, long newLeaseExpireTime, @@ -3299,7 +3299,7 @@ public class DLockGrantor { * @param newLeaseExpireTime the absolute expiration time * @param lockId the lock id used to request the lock * @param remoteThread identity of the locking thread - * @guarded.By this + * guarded.By this */ private void basicGrantLock(InternalDistributedMember owner, long newLeaseExpireTime, @@ -3322,7 +3322,7 @@ public class DLockGrantor { * Caller must synchronize on this grant token. * * @return true if this lock is currently leased out - * @guarded.By this + * guarded.By this */ boolean isLeaseHeld() { return this.lessee != null && this.leaseId > -1; @@ -3333,7 +3333,7 @@ public class DLockGrantor { * that is no longer in use. * <p> * Caller must synchronize on this grant token. - * @guarded.By this + * guarded.By this */ void destroy() { if (!this.destroyed) { @@ -3352,7 +3352,7 @@ public class DLockGrantor { * Caller must synchronize on this grant token. * * @throws IllegalStateException if this grant token has been destroyed - * @guarded.By this + * guarded.By this */ private void checkDestroyed() { if (this.destroyed) { @@ -3372,7 +3372,7 @@ public class DLockGrantor { * @param member the member to release the lock from * @param lockId the lock id that the member used when locking * @return true if lock was released - * @guarded.By this + * guarded.By this */ private boolean releaseLock(InternalDistributedMember member, int lockId) { @@ -3405,7 +3405,7 @@ public class DLockGrantor { * @param sender the member that potentially holds a lease * @param lockId the lock id provided by the member * @return true if the sender holds a lease on this lock - * @guarded.By this + * guarded.By this */ private boolean isLeaseHeldBy(InternalDistributedMember sender, int lockId) { http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/40f95887/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/locks/GrantorRequestProcessor.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/locks/GrantorRequestProcessor.java b/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/locks/GrantorRequestProcessor.java index ec5cd96..e22a8c0 100644 --- a/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/locks/GrantorRequestProcessor.java +++ b/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/locks/GrantorRequestProcessor.java @@ -91,14 +91,14 @@ public class GrantorRequestProcessor extends ReplyProcessor21 { /** * Our notion of the current elder * - * @guarded.By {@link #elderLock} + * guarded.By {@link #elderLock} */ InternalDistributedMember currentElder = null; /** * Count of the elder calls in-flight * - * @guarded.By {@link #elderLock} + * guarded.By {@link #elderLock} */ int elderCallsInProgress = 0; @@ -106,7 +106,7 @@ public class GrantorRequestProcessor extends ReplyProcessor21 { * If true, we're cooling our heels waiting for the elders to pass * the baton * - * @guarded.By {@link #elderLock} + * guarded.By {@link #elderLock} */ boolean waitingToChangeElder = false; http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/40f95887/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/membership/gms/fd/GMSHealthMonitor.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/membership/gms/fd/GMSHealthMonitor.java b/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/membership/gms/fd/GMSHealthMonitor.java index 586427f..4b63d4f 100644 --- a/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/membership/gms/fd/GMSHealthMonitor.java +++ b/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/membership/gms/fd/GMSHealthMonitor.java @@ -419,8 +419,6 @@ public class GMSHealthMonitor implements HealthMonitor, MessageHandler { /** * This method sends heartbeat request to other member and waits for member-timeout * time for response. If it doesn't see response then it returns false. - * @param member - * @return */ private boolean doCheckMember(InternalDistributedMember member, boolean waitForResponse) { if (playingDead || beingSick) { http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/40f95887/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/membership/gms/messenger/JGroupsMessenger.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/membership/gms/messenger/JGroupsMessenger.java b/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/membership/gms/messenger/JGroupsMessenger.java old mode 100755 new mode 100644 index fc81049..879b0a5 --- a/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/membership/gms/messenger/JGroupsMessenger.java +++ b/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/membership/gms/messenger/JGroupsMessenger.java @@ -1076,8 +1076,6 @@ public class JGroupsMessenger implements Messenger { /** * returns the handler that should process the given message. * The default handler is the membership manager - * @param msg - * @return */ private MessageHandler getMessageHandler(DistributionMessage msg) { Class<?> msgClazz = msg.getClass(); http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/40f95887/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/membership/gms/mgr/GMSMembershipManager.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/membership/gms/mgr/GMSMembershipManager.java b/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/membership/gms/mgr/GMSMembershipManager.java index 4ed30a4..cfd11ed 100644 --- a/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/membership/gms/mgr/GMSMembershipManager.java +++ b/geode-core/src/main/java/com/gemstone/gemfire/distributed/internal/membership/gms/mgr/GMSMembershipManager.java @@ -2070,6 +2070,7 @@ public class GMSMembershipManager implements MembershipManager, Manager * * Concurrency: protected by {@link #latestViewLock} ReentrantReadWriteLock * + * guarded.By latestViewLock * @return true if the given member is a zombie */ public boolean isShunned(DistributedMember m) { http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/40f95887/geode-core/src/main/java/com/gemstone/gemfire/internal/cache/tier/InternalClientMembership.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/com/gemstone/gemfire/internal/cache/tier/InternalClientMembership.java b/geode-core/src/main/java/com/gemstone/gemfire/internal/cache/tier/InternalClientMembership.java old mode 100755 new mode 100644 index 04752b3..b2d5959 --- a/geode-core/src/main/java/com/gemstone/gemfire/internal/cache/tier/InternalClientMembership.java +++ b/geode-core/src/main/java/com/gemstone/gemfire/internal/cache/tier/InternalClientMembership.java @@ -93,7 +93,7 @@ public final class InternalClientMembership { /** * True if class is monitoring systems * - * @guarded.By InternalClientMembership.class + * guarded.By InternalClientMembership.class */ private static boolean isMonitoring = false; @@ -552,7 +552,7 @@ for (int i=0; i<queueElementsAfter.length; i++) { } /** - * @guarded.By {@link #systems} + * guarded.By {@link #systems} */ private static void ensureExecutorIsRunning() { // protected by calling method synchronized on systems http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/40f95887/geode-core/src/main/java/com/gemstone/gemfire/internal/cache/tier/sockets/AcceptorImpl.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/com/gemstone/gemfire/internal/cache/tier/sockets/AcceptorImpl.java b/geode-core/src/main/java/com/gemstone/gemfire/internal/cache/tier/sockets/AcceptorImpl.java index 4f952a8..d016fd3 100644 --- a/geode-core/src/main/java/com/gemstone/gemfire/internal/cache/tier/sockets/AcceptorImpl.java +++ b/geode-core/src/main/java/com/gemstone/gemfire/internal/cache/tier/sockets/AcceptorImpl.java @@ -232,13 +232,13 @@ public class AcceptorImpl extends Acceptor implements Runnable * * Instances added when constructed; removed when terminated. * - * @guarded.By {@link #allSCsLock} + * guarded.By {@link #allSCsLock} */ private final HashSet allSCs = new HashSet(); /** List of ServerConnections, for {@link #emergencyClose()} * - * @guarded.By {@link #allSCsLock} + * guarded.By {@link #allSCsLock} */ private volatile ServerConnection allSCList[] = new ServerConnection[0]; http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/40f95887/geode-core/src/main/java/com/gemstone/gemfire/internal/cache/tier/sockets/CacheClientProxy.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/com/gemstone/gemfire/internal/cache/tier/sockets/CacheClientProxy.java b/geode-core/src/main/java/com/gemstone/gemfire/internal/cache/tier/sockets/CacheClientProxy.java index e080cbb..46737b7 100644 --- a/geode-core/src/main/java/com/gemstone/gemfire/internal/cache/tier/sockets/CacheClientProxy.java +++ b/geode-core/src/main/java/com/gemstone/gemfire/internal/cache/tier/sockets/CacheClientProxy.java @@ -2381,7 +2381,7 @@ public class CacheClientProxy implements ClientSession { private volatile boolean _isStopped = true; /** - * @guarded.By _pausedLock + * guarded.By _pausedLock */ //boolean _isPausedDispatcher = false; http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/40f95887/geode-core/src/main/java/com/gemstone/gemfire/internal/tcp/ConnectionTable.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/com/gemstone/gemfire/internal/tcp/ConnectionTable.java b/geode-core/src/main/java/com/gemstone/gemfire/internal/tcp/ConnectionTable.java index 7161088..9f0b61b 100644 --- a/geode-core/src/main/java/com/gemstone/gemfire/internal/tcp/ConnectionTable.java +++ b/geode-core/src/main/java/com/gemstone/gemfire/internal/tcp/ConnectionTable.java @@ -108,7 +108,7 @@ public class ConnectionTable { /** * Timer to kill idle threads * - * @guarded.By this + * guarded.By this */ private SystemTimer idleConnTimer;
