Updated documentation to prepare for 0.9.0 release tag (5441ab44) · Commits · kinetic-archive / kinetic-c

RELEASE.md

+15 −12

Original line number	Diff line number	Diff line
		v0.8.2
		------
		* Added FLUSHALLDATA operation.
		v0.9.0 (kinetic-protocol 3.0.5)
		-------------------------------
		* Changed API to use a `KineticSession` with a pointer to private session/connection info in place of the old `KineticSessionHandle`.
		* Added `FLUSHALLDATA` operation via `KineticClient_Flush()`
		* Added `GETPREVIOUS`/`GETNEXT` operations via `KineticClient_GetPrevious()`/`KineticClient_GetNext()`
		* Replaced `KinticClient_Connect()`/`Disconnect()` with `KineticClient_CreateConnection()`/`DestroyConnection()`, since the connection structure is dynamically allocated and populated in the provided `KineticSession`. `KineticClient_DestroyConnection()` MUST be called on the an established `KineticSession` in order to shutdown the connection and free up resources.

		v0.8.1 (kinetic-protocol 3.0.5)
		-------------------------------
		* Added GETLOG operation.
		* Added `GETLOG` operation.
		* Added thread-safety to allow multiple client threads within the same session.
		* Added I/O examples to demonstrate client write operations for blocking/non-blocking (asynchrounous) and single/multi-threaded.

		@@ -13,23 +16,23 @@ v0.8.0 (kinetic-protocol 3.0.5)
		* Updated to use Kinetic Protocol v3.0 (3.0.5)
		* NOT backwards compatible with earlier versions of Kinetic Protocol
		* Kinetic device firmware must be updated to a release supporting v3.0 protocol!
		* Added asynchronous/non-blocking execution option to all operations (GET/PUT/DELETE/GETKEYRANGE).
		* Added asynchronous/non-blocking execution option to all operations (`GET`/`PUT`/`DELETE`/`GETKEYRANGE`).
		* A given operation is carried out in asynchronous mode if a closure callback with optional data is supplied.
		* ByteArray and ByteBuffer types are now supplied directly in the byte_array.h public interface file.
		* Fixed a concurrency issue that intermittently produces a crash in kinetic_allocator in a threaded context
		* `ByteArray` and `ByteBuffer` types are now supplied directly in the `byte_array.h` public interface file.
		* Fixed a concurrency issue that intermittently produces a crash in `kinetic_allocator` in a threaded context

		v0.7.0 (kinetic-protocol 2.0.6)
		-------------------------------
		* Added blocking GETKEYRANGE operation.
		* Added blocking `GETKEYRANGE` operation.

		v0.6.0 (kinetic-protocol 2.0.6)
		-------------------------------
		* Added blocking GET and DELETE operations.
		* Added blocking `GET` and `DELETE` operations.
		* Added Makefile build implementing standard (make; sudo make install) interface.
		* Added creation/installation of static (.a) and dynamic (.so) libraries
		* Added ByteArray type for buffer management.
		* Added Kinetic_KeyValue type for key/value pair handling.
		* Added `ByteArray` type for buffer management.
		* Added `Kinetic_KeyValue` type for key/value pair handling.

		v0.5.0 (kinetic-protocol 2.0.4)
		-------------------------------
		* Added blocking PUT operation
		* Added blocking `PUT` operation

config/Doxyfile

+1 −1

Original line number	Diff line number	Diff line
		@@ -38,7 +38,7 @@ PROJECT_NAME = kinetic-c
		# could be handy for archiving the generated documentation or if some version
		# control system is used.

		PROJECT_NUMBER = "v0.8.1"
		PROJECT_NUMBER = "v0.9.0"

		# Using the PROJECT_BRIEF tag one can provide an optional one line description
		# for a project that appears at the top of each page and should give viewer a

config/VERSION

+1 −1

Original line number	Diff line number	Diff line
		0.8.2
		0.9.0

include/kinetic_client.h

+20 −8

Original line number	Diff line number	Diff line
		@@ -41,20 +41,30 @@ void KineticClient_Shutdown(void);
		* connection to the specified Kinetic Device, and establishes a session.
		*
		* @param session Configured KineticSession to connect
		* .config `KineticSessionConfig` structure which must be configured
		* by the client prior to creating the device connection.
		* .host Host name or IP address to connect to
		* .port Port to establish socket connection on
		* .clusterVersion Cluster version to use for the session
		* .identity Identity to use for the session
		* .hmacKey Key to use for HMAC calculations (NULL-terminated string)
		*
		* @return Returns the resulting KineticStatus.
		* .connection Pointer to dynamically allocated connection which will be
		* populated upon establishment of a connection.
		*
		* @return Returns the resulting `KineticStatus`, and `session->connection`
		* will be populated with a session instance pointer upon success.
		* The client should call KineticClient_DestroyConnection() in
		* order to shutdown a connection and cleanup resources when
		* done using a KineticSession.
		*/
		KineticStatus KineticClient_CreateConnection(KineticSession * const session);

		/**
		* @brief Closes the connection to a host.
		*
		* @param session The KineticSession to destroy.
		* @param session The connected `KineticSession` to close. The connection
		* instance will be freed by this call after closing the
		* connection.
		*
		* @return Returns the resulting KineticStatus.
		*/
		@@ -197,7 +207,9 @@ KineticStatus KineticClient_GetKeyRange(KineticSession const * const session,
		* @param type KineticLogDataType specifying data type to retrieve.
		* @param info KineticDeviceInfo pointer, which will be assigned to
		* a dynamically allocated structure populated with
		* the requested data, if successful.
		* the requested data, if successful. The client should
		* call free() on this pointer in order to free the root
		* and any nested structures.
		* @param closure Optional closure. If specified, operation will be
		* executed in asynchronous mode, and closure callback
		* will be called upon completion in another thread.