20181203

Author: liangdongcheng

Doc/Basic Component.jpg

@@ -0,0 +1,48 @@
+#include <hpsocket/HPSocket4C.h>
+
+// 5. process network events
+EnHandleResult __HP_CALL OnConnect(HP_Agent pSender, HP_CONNID dwConnID);
+EnHandleResult __HP_CALL OnReceive(HP_Agent pSender, HP_CONNID dwConnID, int iLength);
+EnHandleResult __HP_CALL OnSend(HP_Agent pSender, HP_CONNID dwConnID, const BYTE* pData, int iLength);
+EnHandleResult __HP_CALL OnClose(HP_Agent pSender, HP_CONNID dwConnID, En_HP_SocketOperation enOperation, int iErrorCode);
+EnHandleResult __HP_CALL OnShutdown(HP_Agent pSender);
+
+int main(int argc, char* const argv[])
+{
+	HP_TcpPullAgentListener s_listener;
+	HP_TcpPullAgent s_agent;
+
+	// 1. Create listener object
+	s_listener	= ::Create_HP_TcpPullAgentListener();
+	// 2. Create component object (and binding with listener object)
+	s_agent		= ::Create_HP_TcpPullAgent(s_listener);
+	
+	/* Set listener callbacks */
+	::HP_Set_FN_Agent_OnConnect(s_listener, OnConnect);
+	::HP_Set_FN_Agent_OnSend(s_listener, OnSend);
+	::HP_Set_FN_Agent_OnPullReceive(s_listener, OnReceive);
+	::HP_Set_FN_Agent_OnClose(s_listener, OnClose);
+	::HP_Set_FN_Agent_OnShutdown(s_listener, OnShutdown);
+	
+	// 3. Start component object
+	if(::HP_Agent_HasStarted(s_agent))
+		exit(1);
+	
+	// 4. Connect to dest host
+	::HP_Agent_Connect(s_agent, "remote.host.1", REMOTE_PORT_1, nullptr);
+	::HP_Agent_Connect(s_agent, "remote.host.2", REMOTE_PORT_2, nullptr);
+	::HP_Agent_Connect(s_agent, "remote.host.3", REMOTE_PORT_3, nullptr);
+	
+	/* wait for exit */
+	// ... ... 
+	
+	// 6. (optional) Stop component object
+	::HP_Agent_Stop(s_agent)
+
+	// 7. Destroy component object
+	::Destroy_HP_TcpPullAgent(s_agent);
+	// 8. Destroy listener object
+	::Destroy_HP_TcpPullAgentListener(s_listener);
+	
+	return 0;
+}

Doc/Example.c

@@ -0,0 +1,39 @@
+#include <hpsocket/HPSocket.h>
+
+/* Listener Class */
+class CListenerImpl : public CTcpPullServerListener
+{
+
+public:
+	// 5. process network events
+	virtual EnHandleResult OnPrepareListen(ITcpServer* pSender, SOCKET soListen);
+	virtual EnHandleResult OnAccept(ITcpServer* pSender, CONNID dwConnID, UINT_PTR soClient);
+	virtual EnHandleResult OnHandShake(ITcpServer* pSender, CONNID dwConnID);
+	virtual EnHandleResult OnReceive(ITcpServer* pSender, CONNID dwConnID, int iLength);
+	virtual EnHandleResult OnSend(ITcpServer* pSender, CONNID dwConnID, const BYTE* pData, int iLength);
+	virtual EnHandleResult OnClose(ITcpServer* pSender, CONNID dwConnID, EnSocketOperation enOperation, int iErrorCode);
+	virtual EnHandleResult OnShutdown(ITcpServer* pSender);
+};
+
+int main(int argc, char* const argv[])
+{
+	// 1. Create listener object
+	CListenerImpl s_listener;
+	// 2. Create component object (and binding with listener object)
+	CTcpPullServerPtr s_pserver(&s_listener);
+	
+	// 3. Start component object
+	if(!s_pserver->Start("0.0.0.0", 5555))
+		exit(1);
+	
+	/* wait for exit */
+	// ... ... 
+	
+	// 6. (optional) Stop component object
+	s_pserver->Stop()
+
+	return 0;
+	
+	// 7. Destroy component object automatically
+	// 8. Destroy listener object automatically
+}

Doc/Example.cpp

@@ -0,0 +1,88 @@
+# ======================================== #
+HP-Socket v5.4.3 API Update List:
+# ======================================== #
+--------------------
+1.HTTP:
+--------------------
+HP_HttpServer_StartHttp				(ADD)
+HP_HttpServer_SetHttpAutoStart		(ADD)
+HP_HttpServer_IsHttpAutoStart		(ADD)
+HP_HttpAgent_StartHttp				(ADD)
+HP_HttpAgent_SetHttpAutoStart		(ADD)
+HP_HttpAgent_IsHttpAutoStart		(ADD)
+HP_HttpClient_StartHttp				(ADD)
+HP_HttpClient_SetHttpAutoStart		(ADD)
+HP_HttpClient_IsHttpAutoStart		(ADD)
+
+# ======================================== #
+HP-Socket v5.4.2 API Update List:
+# ======================================== #
+--------------------
+1.Server / Agent:
+--------------------
+HP_Server_SetOnSendSyncPolicy		(ADD)
+HP_Server_GetOnSendSyncPolicy		(ADD)
+HP_Agent_SetOnSendSyncPolicy		(ADD)
+HP_Agent_GetOnSendSyncPolicy		(ADD)
+
+--------------------
+2.SSL:
+--------------------
+HP_SSLServer_StartSSLHandShake		(ADD)
+HP_SSLServer_SetSSLAutoHandShake	(ADD)
+HP_SSLServer_IsSSLAutoHandShake		(ADD)
+HP_SSLAgent_StartSSLHandShake		(ADD)
+HP_SSLAgent_SetSSLAutoHandShake		(ADD)
+HP_SSLAgent_IsSSLAutoHandShake		(ADD)
+HP_SSLClient_StartSSLHandShake		(ADD)
+HP_SSLClient_SetSSLAutoHandShake	(ADD)
+HP_SSLClient_IsSSLAutoHandShake		(ADD)
+
+# ======================================== #
+HP-Socket v5.4.1 API Update List:
+# ======================================== #
+--------------------
+1. System:
+--------------------
+SYS_Malloc						(ADD)
+SYS_Realloc						(ADD)
+SYS_Free						(ADD)
+
+--------------------
+2. TCP/UDP:
+--------------------
+HP_Agent_ConnectWithLocalPort				(ADD)
+HP_Agent_ConnectWithExtraAndLocalPort		(ADD)
+HP_Client_StartWithBindAddressAndLocalPort	(ADD)
+HP_Agent_IsConnected						(ADD)
+HP_Client_IsConnected						(ADD)
+HP_Server_IsConnected						(ADD)
+
+--------------------
+3. Thread Pool:
+--------------------
+Create_HP_ThreadPool			(ADD)
+Destroy_HP_ThreadPool			(ADD)
+Create_HP_SocketTaskObj			(ADD)
+Destroy_HP_SocketTaskObj		(ADD)
+HP_ThreadPool_Start				(ADD)
+HP_ThreadPool_Stop				(ADD)
+HP_ThreadPool_Submit			(ADD)
+HP_ThreadPool_Submit_Task		(ADD)
+HP_ThreadPool_AdjustThreadCount	(ADD)
+HP_ThreadPool_HasStarted		(ADD)
+HP_ThreadPool_GetState			(ADD)
+HP_ThreadPool_GetQueueSize		(ADD)
+HP_ThreadPool_GetThreadCount	(ADD)
+HP_ThreadPool_GetMaxQueueSize	(ADD)
+HP_ThreadPool_GetRejectedPolicy	(ADD)
+
+# ======================================== #
+HP-Socket v5.2.1 API Update List:
+# ======================================== #
+
+1. Add all functions for SSL & HTTP components
+
+# ======================================== #
+HP-Socket v1.0.0 API Update List:
+# ======================================== #

Doc/HP-Socket Class Diagram.jpg

@@ -0,0 +1,132 @@
+==========================================================================================
+v5.4.3 Update:
+==========================================================================================
+
+> HTTP Components Update
+-----------------
+1. The HTTP components can manually start HTTP communication to perform pre-operations such as SOCKS proxy server settings for HTTP communication.
+2. The HTTP components (Server/Agent/Client) adds the following interface methods to support manual startup of the HTTP communication:
+	1) StartHttp(): Manually start HTTP communication. When the component is set to non-automatic start, this method needs to be called to start the HTTP communication.
+	2) SetHttpAutoStart(): Set the component's HTTP start mode (default: TRUE, automatic start).
+	3) IsHttpAutoStart(): Get the component's HTTP start mode.
+
+> Other Update
+-----------------
+1. Bug fix: UDP Server may be trigger the OnAccept event repeatedly in high concurrent scenarios
+
+==========================================================================================
+v5.4.2 Update:
+==========================================================================================
+
+> SSL Components Update
+-----------------
+1. The SSL components can manually start SSL handshake to perform pre-operations such as proxy server settings for SSL/Https communication.
+2. The SSL components (Server/Agent/Client) adds the following interface methods to support manual startup of the SSL handshake:
+	1) StartSSLHandShake(): Manually start SSL handshake. When the component is set to non-automatic handshake, this method needs to be called to start the SSL handshake.
+	2) SetSSLAutoHandShake(): Set the component's handshake mode (default: TRUE, automatic handshake).
+	3) IsSSLAutoHandShake(): Get the component's handshake mode.
+
+> Other Update
+-----------------
+1. All component interface methods that may cause a Socket to close are asynchronously fired OnClose event in the Socket communication thread.
+2. The Disconnect() method of the Server and Agent components no longer supports ‘non-forced disconnects’ (still retains the bForce parameter) and is forced to disconnect when invoked.
+3. openssl upgrade to version 1.1.0i
+
+==========================================================================================
+v5.4.1 Update:
+==========================================================================================
+
+> Add Thread Pool Component
+-----------------
+1. add IHPThreadPool thread pool component
+2. important methods ofIHPThreadPool:
+	1) Start: startup thread pool
+	2) Stop: shutdown thread pool
+	3) Submit: submit task
+	4) AdjustThreadCount: adjust thread count
+
+> Interface Update
+-----------------
+1. The Connect() method of IAgent interface adds parameter 'usLocalPort', which can be bound to a local port when connecting
+2. The Start() method of IClient interface adds parameter 'usLocalPort', which can be bound to a local port when connecting
+3. IClient/IAgent/IServer interfaces add method IsConnected() to detect whether it is valid connection
+
+> Regular Update
+-----------------
+1. fix known issues
+2. performance optimization
+
+==========================================================================================
+v5.3.2 Update:
+==========================================================================================
+
+> Regular Update
+-----------------
+1. bug fix: shared library can not be loaded by dlopen() in version 5.3.1
+2. jemalloc upgrade to version 5.1.0
+
+==========================================================================================
+v5.3.1 Update:
+==========================================================================================
+
+> Android NDK supported
+-----------------
+1. all components are compatible with Android NDK
+2. provide _ZLIB_DISABLED precompiled macro to disable zlib functions
+3. provide _ICONV_DISABLED precompiled macro to disable iconv functions
+
+> Regular Update
+-----------------
+1. http-parser upgrade to version 2.8.1, and reference it using source code
+2. jemalloc upgrade to version 5.0.1
+3. openssl upgrade to version 1.1.0h
+
+==========================================================================================
+v5.2.1 Update:
+==========================================================================================
+
+> Create HP-Socket SSL Components
+-----------------
+1. Server: SSL Server, SSL Pull Server, SSL Pack Server
+2. Agent: SSL Agent, SSL Pull Agent, SSL Pack Agent
+3. Client: SSL Client, SSL Pull Client, SSL Pack Client
+
+> Create HP-Socket HTTP Components
+-----------------
+1. Server: HTTP Server, HTTPS Server
+2. Agent: HTTP Agent, HTTPS Agent
+3. Client: HTTP Client, HTTPS Client, HTTP Sync Client, HTTPS Sync Client
+
+> Create Demos：
+-----------------
+1. testecho-ssl: (SRC) SSL simple test echo server/agent/client
+2. testecho-ssl-pfm: (SO) SSL performance test echo server/agent/client
+3. testecho-ssl-pull: (SO) SSL pull echo server/agent/client
+4. testecho-ssl-pack: (4C SO) SSL pack echo server/agent/client
+5. testecho-http: (SRC) HTTP simple test echo server/agent/client/sync-client
+6. testecho-http-4c: (4C SO) HTTP simple test echo server/agent/client/sync-client
+
+> Other Updates：
+-----------------
+1. Version number revision: Use a unified version number for Windows & Linux distribution
+2. Code optimization and knowing bug fixed
+
+==========================================================================================
+v1.0.0 Update:
+==========================================================================================
+
+> Create HP-Socket Basic Components
+-----------------
+1. Server: TCP Server, TCP Pull Server, TCP Pack Server, UDP Server
+2. Agent: TCP Agent, TCP Pull Agent, TCP Pack Agent
+3. Client: TCP Client, TCP Pull Client, TCP Pack Client, UDP Client, UDP Cast
+
+> Create Demos：
+-----------------
+1. testecho: tcp simple test echo server/agent/client
+2. testecho-pfm: tcp performance test echo server/agent/client
+3. testecho-pull: tcp pull echo server/agent/client
+4. testecho-pack: tcp pack echo server/agent/client
+5. testecho-udp: udp simple echo server/client/cast
+6. testecho-udp-pfm: udp performance test echo server/client
+7. testecho-lib: tcp pull echo server/agent/client (use hpsocket.so and hpsocket4c.so)

Doc/HP-Socket Class Diagram.uml

@@ -0,0 +1,22 @@
+/*
+ * Copyright JessMA Open Source ([email protected])
+ *
+ * Author	: Bruce Liang
+ * Website	: http://www.jessma.org
+ * Project	: https://github.com/ldcsaa
+ * Blog		: http://www.cnblogs.com/ldcsaa
+ * Wiki		: http://www.oschina.net/p/hp-socket
+ * QQ Group	: 75375912, 44636872
+ *
+ * Licensed 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.
+ */

Doc/HP-Socket Development Guide.pdf

@@ -0,0 +1,17 @@
+# HP-Socket for Linx
+    The exported API of HP-Socket for Linux is consistent with HP-Socket for Windows, but the implementation code is completely separated. HP-Socket for Linux uses the features of the *C++14* standard, and thus needs to be compiled by a compiler which version is *GCC 5.x* and above.  
+    The distribution packages of HP-Socket contains a series of Visual Studio Solutions, which were used to compile HP-Socket components and demos, you can compile them by yourself after install and configure the [*Visual C++ for Linux Development*](https://blogs.msdn.microsoft.com/vcblog/2016/03/30/visual-c-for-linux-development/) plug-in. Of course, you can write your own Makefile file to compile these codes.  
+    Note: the compilation and execution environments of HP-Socket requires Linux kernel version *2.6.32* and above.
+## Installation
+```
+$ sudo ./install.sh -h
+Usage: install.sh [...O.P.T.I.O.N.S...]
+-----------------+------------------------------------------------
+  -p|--prefix    : install/uninstall path (default: /usr/local)
+  -l|--libdir    : lib dir (default: x86 -> lib, x64 -> lib64)
+  -d|--with-demo : install demos or not (default: true)
+  -u|--uninstall : execute uninstall operation from install path
+  -v|--version   : print installing hp-socket version
+  -h|--help      : print this usage message
+-----------------+------------------------------------------------
+```