From d479253768d296a40b4f699e1de9b03c7146a97a Mon Sep 17 00:00:00 2001 From: Jesse Morgan Date: Tue, 3 Dec 2013 14:03:28 -0800 Subject: Adding javadocs and Carbonado User Guide --- .../capability/RemoteProcedure.Request.html | 288 +++++++++++++++++++++ 1 file changed, 288 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/capability/RemoteProcedure.Request.html (limited to 'apidocs/com/amazon/carbonado/capability/RemoteProcedure.Request.html') diff --git a/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Request.html b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Request.html new file mode 100644 index 0000000..04a63b8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Request.html @@ -0,0 +1,288 @@ + + + + + + +RemoteProcedure.Request (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.capability
+

Interface RemoteProcedure.Request<R,D>

+
+
+
+
    +
  • +
    Type Parameters:
    R - reply object type
    D - request data object type
    +
    +
    Enclosing interface:
    +
    RemoteProcedure<R,D>
    +
    +
    +
    +
    public static interface RemoteProcedure.Request<R,D>
    +
    Request into a remote procedure, as seen by procedure implementation. To + avoid leaking resources, the request or reply object must always be + finished. If an exception is thrown by a method defined in this + interface, resources are automatically released.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      RemoteProcedure.Reply<R>beginReply() +
      Begin a reply after receiving all data.
      +
      voidfinish() +
      Reply and immediately finish, without sending any data to caller.
      +
      Dreceive() +
      Receive data from caller.
      +
      intreceiveInto(java.util.Collection<? super D> c) +
      Receive all remaining data from caller.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        receiveInto

        +
        int receiveInto(java.util.Collection<? super D> c)
+                throws RepositoryException
        +
        Receive all remaining data from caller.
        +
        Parameters:
        c - collection to receive data
        +
        Returns:
        amount received
        +
        Throws:
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        beginReply

        +
        RemoteProcedure.Reply<R> beginReply()
+                                    throws RepositoryException
        +
        Begin a reply after receiving all data. If no data is expected, + reply can be made without calling receive.
        +
        Throws:
        +
        java.lang.IllegalStateException - if reply was already begun, or if + request is finished, or if more data must be received
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        finish

        +
        void finish()
+            throws RepositoryException
        +
        Reply and immediately finish, without sending any data to caller.
        +
        Throws:
        +
        java.lang.IllegalStateException - if a reply was already begun or if + more data must be received
        +
        RepositoryException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + -- cgit v1.2.3