project arrangement

Author: zhengshuxin

acl_cpp_vc2008.sln

@@ -1,6 +1,6 @@
 Microsoft Visual Studio Solution File, Format Version 10.00
 # Visual Studio 2008
-Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "samples", "samples", "{4FE55739-6D3E-4FA7-BC10-05AB84E3D721}"
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "acl_cpp_samples", "acl_cpp_samples", "{4FE55739-6D3E-4FA7-BC10-05AB84E3D721}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "aio", "aio", "{B8331BFA-4F66-41B8-9A0F-8B7617DC07B8}"
 EndProject

acl_cpp_vc2010.sln

@@ -279,6 +279,8 @@ Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "redis_cluster2_vc2010", "li
 		{FE724EF7-3763-4E78-BDF5-BCBC075719FD} = {FE724EF7-3763-4E78-BDF5-BCBC075719FD}
 	EndProjectSection
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "samples_acl", "samples_acl", "{6E9E519A-6E4F-491A-91C0-6CA079CA0C94}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Win32 = Debug|Win32

acl_cpp_vc2012.sln

@@ -261,8 +261,6 @@ Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "zdb", "lib_acl\samples\zdb\
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "samples_acl", "samples_acl", "{267F658E-44AF-4080-8577-EFCE99A5E030}"
 EndProject
-Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "samples_protocol", "samples_protocol", "{7C54A0C9-3817-4BBC-BF52-4FA941FD3C69}"
-EndProject
 Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "cgi", "lib_acl_cpp\samples\cgi\cgi_vc2012.vcxproj", "{2C2212C1-01D2-4C8E-AB15-F7E31C7C134B}"
 EndProject
 Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "aio_server_ssl", "lib_acl_cpp\samples\aio\aio_server_ssl\aio_server_ssl_vc2012.vcxproj", "{A07145B7-36AE-4D6F-8536-30A8BE48529D}"

lib_acl_cpp/include/acl_cpp/redis/redis.hpp

@@ -16,6 +16,12 @@
 namespace acl
 {
 
+/**
+ * 该类继承了所有 redis 命令类，因此可以只通过此类对象使用所有的 redis 命令。
+ * inherit all the redis command class, which include all the commands
+ * of Key, String, Hash, List, Set, SortedSet, Hyperloglog, Pub/Sub,
+ * Transaction, Script, Connection, Server.
+ */
 class ACL_CPP_API redis
 	: public redis_connection
 	, public redis_hash

lib_acl_cpp/include/acl_cpp/redis/redis_client.hpp

@@ -12,6 +12,14 @@ class dbuf_pool;
 class redis_result;
 class redis_request;
 
+/**
+ * redis 客户端对象网络通信类，通过此类将组织好的 redis 请求命令发给 redis 服务端，
+ * 同时接收 redis 服务端响应结果；该类继承于 connect_client 类，主要为了使用连接池
+ * 功能。
+ * redis client network IO class. The redis request is sent to server
+ * and the server's respond is handled in this class. The class inherits
+ * connect_client, which can use the connection pool function.
+ */
 class ACL_CPP_API redis_client : public connect_client
 {
 public:

lib_acl_cpp/include/acl_cpp/redis/redis_cluster.hpp

@@ -9,6 +9,13 @@ namespace acl
 
 class redis_pool;
 
+/**
+ * redis 客户端集群类，通过将此类对象注册入 redis 客户端命令类(redis_command)，
+ * 则使所有的客户端命令自动支持集群版 redis 命令。
+ * redis client cluster class. The class's object is set in the redis_command
+ * using redis_command::set_cluster(redis_cluster*), and all the redis client
+ * command will support the redis cluster mode.
+ */
 class ACL_CPP_API redis_cluster : public connect_manager
 {
 public:

lib_acl_cpp/include/acl_cpp/redis/redis_command.hpp

@@ -19,9 +19,34 @@ class redis_request;
 class ACL_CPP_API redis_command
 {
 public:
+	/**
+	 * 缺省的构造函数，如果使用此构造函数初始化类对象，则必须调用 set_client 或
+	 * set_cluster 设置 redis 客户端命令类对象的通讯方式。
+	 * default constructor. You must set the communication method by
+	 * set_client or set_cluster functions.
+	 */
 	redis_command();
+
+	/**
+	 * 当使用非集群模式时的构造函数，可以使用此构造函数设置 redis 通信类对象。
+	 * Using this constructor to set the redis communication mode,
+	 * usually in no-cluster mode.
+	 * @param conn {redis_client*} redis 通信类对象
+	 *  the redis communication in no-cluster mode
+	 */
 	redis_command(redis_client* conn);
+
+	/**
+	 * 使用集群模式的构造函数，在构造类对象时指定了集群模式的 redis_cluster 对象。
+	 * Using this constructor to set the redis_cluster, usually in
+	 * cluster mode.
+	 * @param cluster {redis_cluster*} redis 集群连接对象
+	 *  redis cluster object in cluster mode
+	 * @param max_conns {size_t} 与集群中所有结点之间的每个连接池的最大连接数
+	 *  the max of every connection pool with all the redis nodes
+	 */
 	redis_command(redis_cluster* cluster, size_t max_conns);
+
 	virtual ~redis_command() = 0;
 
 	/**
@@ -39,9 +64,9 @@ class ACL_CPP_API redis_command
 	void reset(bool save_slot = false);
 
 	/**
-	 * 在使用连接池方式时，通过本函数将从连接池获得的连接对象;
-	 * when using connection pool and not in cluster mode, the function
-	 * is used to set the connection for next redis command operation.
+	 * 在使用非集群方式时，通过本函数将从连接池获得的连接对象;
+	 * when not using cluster mode, the function is used
+	 * to set the connection for next redis command operation.
 	 * @param conn {redis_client*} 与 redis 客户端命令进行关联;
 	 *  the redis connection to be set in next redis operation
 	 */
@@ -232,6 +257,7 @@ class ACL_CPP_API redis_command
 	const redis_result** scan_keys(const char* cmd, const char* key,
 		int& cursor, size_t& size, const char* pattern,
 		const size_t* count);
+
 	/*******************************************************************/
 
 	void build(const char* cmd, const char* key,

lib_acl_cpp/include/acl_cpp/redis/redis_connection.hpp

@@ -10,46 +10,72 @@ class redis_client;
 /**
  * redis Connection 类，包含命令如下：
  * AUTH、ECHO、PING、QUIT、SELECT
+ * redis connection command clss, including as below:
+ * AUTH, ECHO, PING, QUIT, SELECT
  */
 class ACL_CPP_API redis_connection : virtual public redis_command
 {
 public:
+	/**
+	 * see redis_command::redis_command()
+	 */
 	redis_connection();
+
+	/**
+	 * see redis_command::redis_command(redis_client*)
+	 */
 	redis_connection(redis_client* conn);
+
+	/**
+	 * see redis_command::redis_command(redis_cluster*， size_t)
+	 */
 	redis_connection(redis_cluster* cluster, size_t max_conns);
+
 	virtual ~redis_connection();
 
 	/////////////////////////////////////////////////////////////////////
 
 	/**
 	 * 连接至 redis-server 时进行身份验证
+	 * AUTH command to login the redis server.
 	 * @param passwd {const char*} 在 redis 配置文件中指定的认证密码
+	 *  the password in redis-server configure
 	 * @return {bool} 身份认证是否成功，返回 false 表示认证失败或操作失败
+	 *  return true if success, or false because auth failed or error.
 	 */
 	bool auth(const char* passwd);
 
 	/**
 	 * 选择 redis-server 中的数据库 ID
+	 * SELECT command to select the DB id in redis-server
 	 * @param dbnum {int} redis 数据库 ID
+	 *  the DB id
 	 * @return {bool} 操作是否成功
+	 *  return true if success, or false for failed.
 	 */
 	bool select(int dbnum);
 
 	/**
 	 * 探测 redis 连接是否正常
+	 * PING command for testing if the connection is OK
 	 * @return {bool} 连接是否正常
+	 *  return true if success
 	 */
 	bool ping();
 
 	/**
 	 * 测试用命令，让 redis-server 回显给定字符串
+	 * ECHO command, request redis-server to echo something.
 	 * @return {bool} 操作是否成功
+	 *  return true if success
 	 */
 	bool echo(const char* s);
 
 	/**
 	 * 关闭 redis 连接
+	 * QUIT command to close the redis connection
 	 * @return {bool}
+	 *  return true if success
 	 */
 	bool quit();
 };

lib_acl_cpp/include/acl_cpp/redis/redis_hash.hpp

@@ -19,9 +19,21 @@ class redis_result;
 class ACL_CPP_API redis_hash : virtual public redis_command
 {
 public:
+	/**
+	 * see redis_command::redis_command()
+	 */
 	redis_hash();
+
+	/**
+	 * see redis_command::redis_command(redis_client*)
+	 */
 	redis_hash(redis_client* conn);
+
+	/**
+	 * see redis_command::redis_command(redis_cluster*， size_t)
+	 */
 	redis_hash(redis_cluster* cluster, size_t max_conns);
+
 	virtual ~redis_hash();
 
 	/////////////////////////////////////////////////////////////////////

lib_acl_cpp/include/acl_cpp/redis/redis_hyperloglog.hpp

@@ -12,9 +12,21 @@ class redis_client;
 class ACL_CPP_API redis_hyperloglog : virtual public redis_command
 {
 public:
+	/**
+	 * see redis_command::redis_command()
+	 */
 	redis_hyperloglog();
+
+	/**
+	 * see redis_command::redis_command(redis_client*)
+	 */
 	redis_hyperloglog(redis_client* conn);
+
+	/**
+	 * see redis_command::redis_command(redis_cluster*， size_t)
+	 */
 	redis_hyperloglog(redis_cluster* cluster, size_t max_conns);
+
 	virtual ~redis_hyperloglog();
 
 	/**