Commit 90059129 authored by Greg Williams's avatar Greg Williams
Browse files

Updated Doxygen info for API doc refresh. 

Removed old versions of kinetic-java simulator jar files.
Updated DEVELOP.md.
parent 64d453be

.gitmodules

+1 −1
Original line number Diff line number Diff line
@@ -5,7 +5,7 @@ 
[submodule "kinetic-protocol"]

	path = vendor/kinetic-protocol

	url = https://github.com/Seagate/kinetic-protocol.git

	branch = 2.0.4

	branch = 2.0.6

[submodule "socket99"]

	path = vendor/socket99

	url = https://github.com/silentbicycle/socket99.git

DEVELOP.md

+9 −3
Original line number Diff line number Diff line 
Kinetic-C Library Developer Reference

=====================================



Prerequisites

=============

-------------



* [Ruby](https://www.ruby-lang.org) (v1.9.3 or higher) scripting language

* [RubyGems](http://rubygems.org) (installed w/ `bundle install)
@@ -9,10 +11,14 @@ Prerequisites 
* [Valgrind](http://valgrind.org/) for validation of memory usage/management

* [Doxygen](https://github.com/doxygen) and [GraphViz](http://www.graphviz.org/) for generating API documentation



API Documentation

=================

[Kinetic-C API](http://seagate.github.io/kinetic-c/) (generated with Doxygen)



Common Developer Tasks

======================

----------------------



NOTE: Prefix the following commands with `bundle exec` so that they execute in the context of the bundle environment setup via `bundle install`.

**NOTE: Prefix the following commands with `bundle exec` so that they execute in the context of the bundle environment setup via `bundle install`.**



* List available Rake tasks w/descriptions

    * `rake -T`

build.sh

deleted100755 → 0
+0 −55
Original line number Diff line number Diff line 
#!/usr/bin/env bash



echo

echo ================================================================================

echo Cleaning out old build artifacts...

echo ================================================================================

find src/**/*.o vendor/socket99/*.o vendor/protobuf-c/protobuf-c/*.o | xargs rm $1

rm libkinetic-c-client.a

rm src/utility/kinetic-c-util

echo DONE!



echo

echo ================================================================================

echo Building the kinetic-c lib sources and bundled dependencies

echo ================================================================================

cd src/lib/

gcc -Wall -c *.c -I. -I../../include/ -I../../vendor/

cd ../../

cd vendor/socket99/

gcc -Wall -std=c99 -c *.c

cd ../protobuf-c/protobuf-c

gcc -Wall -std=c99 -c *.c

cd ../../socket99/

gcc -Wall -std=c99 -c *.c

cd ../../

cd src/lib/

gcc -Wall -std=c99 -c *.c -I. -I../../include/ -I../../vendor/

cd ../..

echo DONE!



echo

echo ================================================================================

echo Assembling kinetic-c-client lib

echo ================================================================================

ar -cvq libkinetic-c-client.a src/lib/*.o vendor/protobuf-c/protobuf-c/*.o vendor/socket99/socket99.o

ar -t libkinetic-c-client.a

echo DONE!



echo

echo ================================================================================

echo Building kinetic-c-client utility

echo ================================================================================

cd src/utility/

gcc -o kinetic-c-util -std=c99 *.c ./examples/*.c  ../../libkinetic-c-client.a -I. -I../../include/ -I../lib -I ./examples/ -l crypto -l ssl

echo DONE!



echo

echo ================================================================================

echo Running kinetic-c-client examples

echo ================================================================================

./kinetic-c-util noop

cd ../../

echo DONE!

echo

echo Kinetic-C library and utility build complete!

config/Doxyfile

+57 −76
Original line number Diff line number Diff line
@@ -980,25 +980,6 @@ USE_HTAGS = NO 


VERBATIM_HEADERS       = NO



# If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the

# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the

# cost of reduced performance. This can be particularly helpful with template

# rich C++ code for which doxygen's built-in parser lacks the necessary type

# information.

# Note: The availability of this option depends on whether or not doxygen was

# compiled with the --with-libclang option.

# The default value is: NO.



CLANG_ASSISTED_PARSING = NO



# If clang assisted parsing is enabled you can provide the compiler with command

# line options that you would normally use when invoking the compiler. Note that

# the include paths will already be set by doxygen for the files and directories

# specified with INPUT and INCLUDE_PATH.

# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.



CLANG_OPTIONS          = 



#---------------------------------------------------------------------------

# Configuration options related to the alphabetical class index

#---------------------------------------------------------------------------

include/kinetic_client.h

+14 −10
Original line number Diff line number Diff line
@@ -39,7 +39,7 @@ void KineticClient_Init(const char* logFile); 
 * @param nonBlocking       Set to true for non-blocking or false for blocking I/O

 * @param clusterVersion    Cluster version to use for the session

 * @param identity          Identity to use for the session

 * @param key               Key to use for HMAC calculations (NULL-terminated string)

 * @param hmacKey           Key to use for HMAC calculations

 *

 * @return                  Returns true if connection succeeded

 */
@@ -49,7 +49,7 @@ bool KineticClient_Connect(KineticConnection* connection, 
    bool nonBlocking,

    int64_t clusterVersion,

    int64_t identity,

    ByteArray key);

    ByteArray hmacKey);



/**

 * @brief Closes the socket connection to a host.
@@ -63,7 +63,6 @@ void KineticClient_Disconnect(KineticConnection* connection); 
 *

 * @param connection    KineticConnection instance to associate with operation

 * @param request       KineticPDU instance to use for request

 * @param requestMsg    KineticMessage instance to use for request

 * @param response      KineticPDU instance to use for reponse

 *

 * @return              Returns a configured operation instance
@@ -78,7 +77,8 @@ KineticOperation KineticClient_CreateOperation( 
 *

 * @param operation     KineticOperation instance to use for the operation

 *

 * @return              Returns 0 upon succes, -1 or the Kinetic status code upon failure

 * @return              Returns 0 upon succes, -1 or the Kinetic status code

 *                      upon failure

 */

KineticProto_Status_StatusCode KineticClient_NoOp(KineticOperation* operation);
@@ -86,22 +86,26 @@ KineticProto_Status_StatusCode KineticClient_NoOp(KineticOperation* operation); 
 * @brief Executes a PUT command to write data to the Kinetic Device

 *

 * @param operation     KineticOperation instance to use for the operation

 * @param metadata      Key/value metadata for object to store. 'value' must

 *                      specify the data to be stored.

 *

 * @return              Returns 0 upon succes, -1 or the Kinetic status code upon failure

 * @return              Returns 0 upon succes, -1 or the Kinetic status code

 *                      upon failure

 */

KineticProto_Status_StatusCode KineticClient_Put(KineticOperation* operation,

    const Kinetic_KeyValue* metadata,

    ByteArray value);

    const Kinetic_KeyValue* metadata);



/**

 * @brief Executes a GET command to read data from the Kinetic Device

 *

 * @param operation     KineticOperation instance to use for the operation

 * @param metadata      Key/value metadata for object to retrieve. 'value' will

 *                      be populated unless 'metadataOnly' is set to 'true'

 *

 * @return              Returns 0 upon succes, -1 or the Kinetic status code upon failure

 * @return              Returns 0 upon succes, -1 or the Kinetic status code

 *                      upon failure

 */

KineticProto_Status_StatusCode KineticClient_Get(KineticOperation* operation,

    const Kinetic_KeyValue* metadata,

    const ByteArray value);

    const Kinetic_KeyValue* metadata);



#endif // _KINETIC_CLIENT_H