This is an automated email from the ASF dual-hosted git repository.

jasonhuynh pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/geode.git


The following commit(s) were added to refs/heads/develop by this push:
     new 3b596ff  GEODE-2667: Improved javaDoc for GatewayReceiver.destroy() 
(#1490)
3b596ff is described below

commit 3b596ff38ac4b55e8dcc447dedce4d0e289415af
Author: Jason Huynh <huyn...@gmail.com>
AuthorDate: Thu Feb 22 17:36:09 2018 -0800

    GEODE-2667: Improved javaDoc for GatewayReceiver.destroy() (#1490)
---
 .../src/main/java/org/apache/geode/cache/wan/GatewayReceiver.java | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git 
a/geode-core/src/main/java/org/apache/geode/cache/wan/GatewayReceiver.java 
b/geode-core/src/main/java/org/apache/geode/cache/wan/GatewayReceiver.java
index 987029e..b09e0ec 100644
--- a/geode-core/src/main/java/org/apache/geode/cache/wan/GatewayReceiver.java
+++ b/geode-core/src/main/java/org/apache/geode/cache/wan/GatewayReceiver.java
@@ -19,6 +19,7 @@ import java.util.List;
 
 import org.apache.geode.cache.server.CacheServer;
 import org.apache.geode.distributed.internal.DistributionConfig;
+import org.apache.geode.internal.cache.wan.GatewayReceiverException;
 
 /**
  * A GatewayReceiver that receives the events from a 
<code>GatewaySender</code>. GatewayReceiver is
@@ -91,7 +92,12 @@ public interface GatewayReceiver {
   void stop();
 
   /**
-   * Destroy this receiver. Stop should be called before calling destroy
+   * Destroys this <code>GatewayReceiver</code>
+   * Removes the <code>GatewayReceiverMBean</code> associated with this 
<code>GatewayReceiver</code>
+   * {@link #stop() stop} should be called before calling destroy
+   * Does not remove receiver from cluster configuration
+   *
+   * @throws GatewayReceiverException if receiver has not been stopped before 
calling destroy
    */
   void destroy();
 

-- 
To stop receiving notification emails like this one, please contact
jasonhu...@apache.org.

Reply via email to