summaryrefslogtreecommitdiff
path: root/java/src/Ice/AMISentCallback.java
diff options
context:
space:
mode:
Diffstat (limited to 'java/src/Ice/AMISentCallback.java')
-rw-r--r--java/src/Ice/AMISentCallback.java16
1 files changed, 16 insertions, 0 deletions
diff --git a/java/src/Ice/AMISentCallback.java b/java/src/Ice/AMISentCallback.java
index 2aca793f7f8..659b5be65e9 100644
--- a/java/src/Ice/AMISentCallback.java
+++ b/java/src/Ice/AMISentCallback.java
@@ -9,7 +9,23 @@
package Ice;
+/**
+ * Callback interface for AMI invocations. This is useful
+ * for applications that send asynchronous invocations that
+ * might not be sent for some time and, therefore, are
+ * queued in the Ice run time for transmission.
+ * <p>
+ * The Ice run time calls <code>ice_sent</code> if an
+ * an AMI invocation cannot be written to transport and was
+ * queued for later transmission. Applications that need to
+ * implement flow control for AMI invocations can implement
+ * this interface on the corresponding AMI callback object.
+ **/
public interface AMISentCallback
{
+ /**
+ * Indicates to the caller of an AMI operation that
+ * the invocation was queued for later transmission.
+ **/
void ice_sent();
};