Commit 3d622e94 authored by Greg Williams's avatar Greg Williams
Browse files

Updated for 0.8.0 release

parent f54a526a
Loading
Loading
Loading
Loading
+1 −1
Original line number Diff line number Diff line
@@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8
# title of most generated pages and in a few other places.
# The default value is: My Project.

PROJECT_NAME           = protobuf-c
PROJECT_NAME           = kinetic-c

# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
+1 −1
Original line number Diff line number Diff line
0.8.0-beta
0.8.0
+20 −7
Original line number Diff line number Diff line
@@ -76,39 +76,49 @@ KineticStatus KineticClient_NoOp(KineticSessionHandle handle);
 * @brief Executes a PUT command to store/update an entry on the Kinetic Device.
 *
 * @param handle        KineticSessionHandle for a connected session.
 * @param metadata      Key/value metadata for object to store. 'value' must
 * @param entry         Key/value entry for object to store. 'value' must
 *                      specify the data to be stored.
 * @param closure       Optional closure. If specified, operation will be
 *                      executed in asynchronous mode, and closure callback
 *                      will be called upon completion.
 * 
 *
 * @return              Returns the resulting KineticStatus
 */
KineticStatus KineticClient_Put(KineticSessionHandle handle,
                                KineticEntry* const metadata,
                                KineticEntry* const entry,
                                KineticCompletionClosure* closure);

/**
 * @brief Executes a GET command to retrieve and entry from the Kinetic Device.
 *
 * @param handle        KineticSessionHandle for a connected session.
 * @param metadata      Key/value metadata for object to retrieve. 'value' will
 *                      be populated unless 'metadataOnly' is set to 'true'
 * @param entry         Key/value entry for object to retrieve. 'value' will
 *                      be populated unless 'metadataOnly' is set to 'true'.
 * @param closure       Optional closure. If specified, operation will be
 *                      executed in asynchronous mode, and closure callback
 *                      will be called upon completion.
 *
 * @return              Returns the resulting KineticStatus
 */
KineticStatus KineticClient_Get(KineticSessionHandle handle,
                                KineticEntry* const metadata,
                                KineticEntry* const entry,
                                KineticCompletionClosure* closure);

/**
 * @brief Executes a DELETE command to delete an entry from the Kinetic Device
 *
 * @param handle        KineticSessionHandle for a connected session.
 * @param metadata      Key/value metadata for object to delete. 'value' is
 * @param entry         Key/value entry for object to delete. 'value' is
 *                      not used for this operation.
 * @param closure       Optional closure. If specified, operation will be
 *                      executed in asynchronous mode, and closure callback
 *                      will be called upon completion.
 *
 * @return              Returns the resulting KineticStatus
 */
KineticStatus KineticClient_Delete(KineticSessionHandle handle,
                                   KineticEntry* const metadata,
                                   KineticEntry* const entry,
                                   KineticCompletionClosure* closure);

/**
@@ -118,6 +128,9 @@ KineticStatus KineticClient_Delete(KineticSessionHandle handle,
 * @param handle        KineticSessionHandle for a connected session
 * @param range         KineticKeyRange specifying keys to return
 * @param keys          ByteBufferArray to store the retrieved keys
 * @param closure       Optional closure. If specified, operation will be
 *                      executed in asynchronous mode, and closure callback
 *                      will be called upon completion.
 *
 *
 * @return              Returns 0 upon succes, -1 or the Kinetic status code