hbase/hbase-native-client/README.md

<!---
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
-->

# hbase-native-client

Native client for HBase 0.96

This is a C  library that implements a
HBase client.  It's thread safe and libEv
based.


## Design Philosphy

Synchronous and Async versions will both be built
on the same foundation. The core foundation will
be C++.  External users wanting a C library will
have to choose either async or sync.  These
libraries will be thin veneers ontop of the C++.

We should try and follow pthreads example as much
as possible:

* Consistent naming.
* Opaque pointers as types so that binary compat is easy.
* Simple setup when the defaults are good.
* Attr structs when lots of paramters could be needed.


## Naming
All public C files will start with hbase_*.{h, cc}.  This
is to keep naming conflicts to a minimum. Anything without
the hbase_ prefix is assumed to be implementation private.

All C apis and typedefs will be prefixed with hb_.

All typedefs end with _t.