Populated repo with skeleton files, Doxygen support, licensing files and basic directory structure.

Quickstart {#mainpage}

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

This library allows building C programs that interact with a Kinetic API implementation. It provides blocking and non-blocking styles of interaction depending on application needs.

Including the library

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

TBD

Opening a connection

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

TBD

Performing blocking GET/PUT operations

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

TBD

Performing non-blocking GET/PUT operations

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

TBD

kinetic-c-client

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

Introduction

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

This repo contains code for producing C kinetic clients.

Kinetic Cloud Storage C Client

Protocol Version

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

The client is using version `2.0.4` of the [Kinetic-Protocol](https://github.com/Seagate/kinetic-protocol/releases/tag/2.0.4).

Dependencies

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

* CMake??/Ceedling??

* Doxygen/graphviz for generating documentation

Initial Setup

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

TBD

Common Developer Tasks

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

**Building the lib**: TBD

**Running tests**: TBD

There is also an integration test suite. This suite reads the environment

variable `KINETIC_PATH` to determine a simulator executable to run tests

against. If that variable is not set, it instead assumes that a Kinetic server

is running on port 8123 on `localhost`. To run the integration tests, set

`KINETIC_PATH` if appropriate and run `make integration_test`. This will write

a JUnit report to `integrationresults.xml`.

**Checking code style**: TBD

**Generating documentation**: TBD

**Apply licenses**: Run something like `./apply_license.sh my_new_file.c` or `./apply_license.sh include/*.h`

#!/bin/sh

for file in "$@"

do

    if grep -q "Copyright (C) 2014 Seagate Technology." $file; then

        echo Skipping ${file}

    else

        echo Applying license to ${file}...

        cat license_template $file > tmp && mv tmp $file

    fi

done

/*

 * kinetic-c-client

 * Copyright (C) 2014 Seagate Technology.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

 *

 */

#ifndef KINETIC_C_CLIENT_KINETIC_H_

#define KINETIC_C_CLIENT_KINETIC_H_

/// Applications should only include this file

#endif /* KINETIC_C_CLIENT_KINETIC_H_ */