Separated out include directory, started tutorial

Separate include directory so that examples can reference the same thing whether installed in the system or from the local folder.

Separated out include directory, started tutorial
Separate include directory so that examples can reference the same thing whether installed in the system or from the local folder.
Hayk Martirosyan
1 parent 5db70130
Showing 9 changed files with 59 additions and 32 deletions
CMakeLists.txt
README.md
src/redox.hpp → include/redox.hpp
src/client.hpp → include/redox/client.hpp
src/command.hpp → include/redox/command.hpp
src/subscriber.hpp → include/redox/subscriber.hpp
src/utils/logger.hpp → include/redox/utils/logger.hpp
src/client.cpp
src/utils/logger.cpp
@@ -26,23 +26,32 @@ set(CMAKE_CXX_FLAGS &quot;${CMAKE_CXX_FLAGS} -std=c++11 -fPIC -Wall&quot;)
 # ---------------------------------------------------------
 set(SRC_DIR ${CMAKE_SOURCE_DIR}/src)
+set(INC_DIR ${CMAKE_SOURCE_DIR}/include/redox)
 set(SRC_CORE
   ${SRC_DIR}/client.cpp
   ${SRC_DIR}/command.cpp
-  ${SRC_DIR}/subscriber.cpp
-)
+  ${SRC_DIR}/subscriber.cpp)
-set(SRC_LOGGER ${SRC_DIR}/utils/logger.cpp)
+set(INC_CORE
+    ${INC_DIR}/client.hpp
+    ${INC_DIR}/subscriber.hpp
+    ${INC_DIR}/command.hpp)
-set(SRC_ALL ${SRC_CORE} ${SRC_LOGGER})
+set(SRC_UTILS ${SRC_DIR}/utils/logger.cpp)
+set(INC_UTILS ${INC_DIR}/utils/logger.hpp)
-include_directories(${SRC_DIR})
+set(INC_WRAPPER ${CMAKE_SOURCE_DIR}/include/redox.hpp)
+
+set(SRC_ALL ${SRC_CORE} ${SRC_UTILS})
+set(INC_ALL ${INC_CORE} ${INC_UTILS} ${INC_WRAPPER})
+
+include_directories(${INC_DIR} ${INC_DIR/redox})
 # Dependent libraries - you may have to change
 # pthread to whatever C++11 threads depends on
 # for your platform
-set(REDOX_LIB_DEPS hiredis ev pthread)
+set(REDOX_LIB_DEPS ev pthread hiredis)
 # ---------------------------------------------------------
 # Library generation
@@ -50,7 +59,7 @@ set(REDOX_LIB_DEPS hiredis ev pthread)
 if (lib)
-  add_library(redox SHARED ${SRC_ALL})
+  add_library(redox SHARED ${SRC_ALL} ${INC_CORE})
   target_link_libraries(redox ${REDOX_LIB_DEPS})
   set_target_properties(redox
@@ -139,17 +148,16 @@ endif()
 # Install (sudo make install)
 # ---------------------------------------------------------
+set(CMAKE_INSTALL_PREFIX /usr/)
+
 # Install the dynamic library to /usr/lib
 install(TARGETS redox DESTINATION lib)
 # Install the headers into /usr/include/redox
-set(INC_CORE ${SRC_DIR}/client.hpp ${SRC_DIR}/subscriber.hpp)
-set(INC_UTILS ${SRC_DIR}/utils/logger.hpp)
 install(FILES ${INC_CORE} DESTINATION include/redox)
 install(FILES ${INC_UTILS} DESTINATION include/redox/utils)
-# Install the top-level header into /usr/include directly
-set(INC_WRAPPER ${SRC_DIR}/redox.hpp)
+# Install the top-level header directly into /usr/include
 install(FILES ${INC_WRAPPER} DESTINATION include)
 # ---------------------------------------------------------
@@ -27,25 +27,23 @@ Redox is built on top of
 asynchronous API of hiredis, even for synchronous commands. There is no dependency on
 Boost or any other libraries.
-### Performance Benchmarks
+## Benchmarks
 Benchmarks are given by averaging the results of five trials of the speed tests
 in `examples/` on an AWS t2.medium instance running Ubuntu 14.04 (64-bit).
 Local Redis server, TCP connection:
- * 100 commandLoop calls (`speed_test_async_multi`): **710,014 commands/s**
- * One commandLoop call (`speed_test_async`): **195,159 commands/s**
- * Looped commandSync call  (`speed_test_sync`): **23,609 commands/s**
+ * 100 command loops (`speed_test_async_multi`): **710,014 commands/s**
+ * One command loop (`speed_test_async`): **195,159 commands/s**
+ * Looped synchronous command (`speed_test_sync`): **28,609 commands/s**
-Results are comparable to that of an
-average laptop. On a high-end laptop or PC, `speed_test_async_multi` usually tops
-1 million commands per second. All results are slightly faster if over Unix sockets
-than TCP.
+Results are comparable to that of an average laptop. On a high-end machine,
+`speed_test_async_multi` usually tops 1,000,000 commands/s.
-## Install
+## Installation
 Instructions provided are for Ubuntu, but all components are platform-independent.
-### Build library from source
+#### Build from source
 Get the build environment and dependencies:
     sudo apt-get install git cmake build-essential
@@ -61,7 +59,7 @@ Install into system directories (optional):
     sudo make install
-### Build examples and test suite
+#### Build examples and test suite
 Enable examples using ccmake or the following:
     cmake -Dexamples=ON ..
@@ -76,4 +74,25 @@ then:
     ./test_redox
 ## Tutorial
-Coming soon. Take a look at `examples/` for now.
+Here is a hello world program for redox:
+
+    #include <iostream>
+    #include "redox.hpp"
+    
+    int main(int argc, char* argv[]) {
+    
+      redox::Redox rdx = {"localhost", 6379};
+      if(!rdx.connect()) return 1;
+    
+      rdx.set("hello", "world!");
+      std::cout << "Hello, " << rdx.get("hello") << std::endl;
+    
+      rdx.disconnect();
+      return 0;
+    }
+
+Compile and run:
+
+    $ g++ hello.cpp -o hello -std=c++11 -lredox -lev -lhiredis
+    $ ./hello
+    Hello, world!
@@ -20,6 +20,6 @@
 #pragma once
-#include "client.hpp"
-#include "command.hpp"
-#include "subscriber.hpp"
+#include "redox/client.hpp"
+#include "redox/command.hpp"
+#include "redox/subscriber.hpp"
@@ -72,7 +72,7 @@ public:
     const int port = REDIS_DEFAULT_PORT,
     std::function<void(int)> connection_callback = nullptr,
     std::ostream& log_stream = std::cout,
-    log::Level log_level = log::Info
+    log::Level log_level = log::Warning
   );
   /**
@@ -82,7 +82,7 @@ public:
     const std::string& path,
     std::function<void(int)> connection_callback,
     std::ostream& log_stream = std::cout,
-    log::Level log_level = log::Info
+    log::Level log_level = log::Warning
   );
   /**
@@ -36,7 +36,7 @@ public:
       const int port = REDIS_DEFAULT_PORT,
       std::function<void(int)> connection_callback = nullptr,
       std::ostream& log_stream = std::cout,
-      log::Level log_level = log::Info
+      log::Level log_level = log::Warning
   );
   /**
@@ -46,7 +46,7 @@ public:
       const std::string& path,
       std::function<void(int)> connection_callback,
       std::ostream& log_stream = std::cout,
-      log::Level log_level = log::Info
+      log::Level log_level = log::Warning
   );
   /**
@@ -19,7 +19,7 @@
 */
 #include <signal.h>
-#include "redox.hpp"
+#include "client.hpp"
 using namespace std;
@@ -5,7 +5,7 @@
 *   http://vilipetek.com/2014/04/17/thread-safe-simple-logger-in-c11/
 */
-#include "logger.hpp"
+#include "utils/logger.hpp"
 #include <iostream>
 #include <iomanip>