/* * Copyright: JessMA Open Source (ldcsaa@gmail.com) * * Version : 3.6.1 * 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 * * 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. */ #pragma once #include #include "HPTypeDef.h" /*****************************************************************************************************************************************************/ /***************************************************************** TCP/UDP Interfaces ****************************************************************/ /*****************************************************************************************************************************************************/ /************************************************************************ 名称：Complex Socket 监听器基接口 描述：定义 IServer 和 IAgent 组件监听器的公共方法 ************************************************************************/ class IComplexSocketListener { public: /* * 名称：握手完成通知 * 描述：连接完成握手时，Socket 监听器将收到该通知，监听器接收到该通知后才能开始 * 数据收发操作 * * 参数： dwConnID -- 连接 ID * 返回值： HR_OK / HR_IGNORE -- 继续执行 * HR_ERROR -- 引发 OnClose() 事件并关闭连接 */ virtual EnHandleResult OnHandShake(CONNID dwConnID) = 0; /* * 名称：已发送数据通知 * 描述：成功发送数据后，Socket 监听器将收到该通知 * * 参数： dwConnID -- 连接 ID * pData -- 已发送数据缓冲区 * iLength -- 已发送数据长度 * 返回值： HR_OK / HR_IGNORE -- 继续执行 * HR_ERROR -- 该通知不允许返回 HR_ERROR（调试模式下引发断言错误） */ virtual EnHandleResult OnSend(CONNID dwConnID, const BYTE* pData, int iLength) = 0; /* * 名称：数据到达通知（PUSH 模型） * 描述：对于 PUSH 模型的 Socket 通信组件，成功接收数据后将向 Socket 监听器发送该通知 * * 参数： dwConnID -- 连接 ID * pData -- 已接收数据缓冲区 * iLength -- 已接收数据长度 * 返回值： HR_OK / HR_IGNORE -- 继续执行 * HR_ERROR -- 引发 OnClose() 事件并关闭连接 */ virtual EnHandleResult OnReceive(CONNID dwConnID, const BYTE* pData, int iLength) = 0; /* * 名称：数据到达通知（PULL 模型） * 描述：对于 PULL 模型的 Socket 通信组件，成功接收数据后将向 Socket 监听器发送该通知 * * 参数： dwConnID -- 连接 ID * iLength -- 已接收数据长度 * 返回值： HR_OK / HR_IGNORE -- 继续执行 * HR_ERROR -- 引发 OnClose() 事件并关闭连接 */ virtual EnHandleResult OnReceive(CONNID dwConnID, int iLength) = 0; /* * 名称：通信错误通知 * 描述：通信发生错误后，Socket 监听器将收到该通知，并关闭连接 * * 参数： dwConnID -- 连接 ID * enOperation -- Socket 操作类型 * iErrorCode -- 错误代码 * 返回值： 忽略返回值 */ virtual EnHandleResult OnClose(CONNID dwConnID, EnSocketOperation enOperation, int iErrorCode) = 0; /* * 名称：关闭通信组件通知 * 描述：通信组件关闭时，Socket 监听器将收到该通知 * * 参数： * 返回值：忽略返回值 */ virtual EnHandleResult OnShutdown() = 0; public: virtual ~IComplexSocketListener() {} }; /************************************************************************ 名称：服务端 Socket 监听器接口 描述：定义服务端 Socket 监听器的所有事件 ************************************************************************/ class IServerListener : public IComplexSocketListener { public: /* * 名称：准备监听通知 * 描述：通信服务端组件启动时，在监听 Socket 创建完成并开始执行监听前，Socket 监听 * 器将收到该通知，监听器可以在通知处理方法中执行 Socket 选项设置等额外工作 * * 参数： soListen -- 监听 Socket * 返回值： HR_OK / HR_IGNORE -- 继续执行 * HR_ERROR -- 终止启动通信服务组件 */ virtual EnHandleResult OnPrepareListen(SOCKET soListen) = 0; }; /************************************************************************ 名称：TCP 服务端 Socket 监听器接口 描述：定义 TCP 服务端 Socket 监听器的所有事件 ************************************************************************/ class ITcpServerListener : public IServerListener { public: /* * 名称：接收连接通知 * 描述：接收到客户端连接请求时，Socket 监听器将收到该通知，监听器可以在通知处理方 * 法中执行 Socket 选项设置或拒绝客户端连接等额外工作 * * 参数： dwConnID -- 连接 ID * soClient -- 客户端 Socket * 返回值： HR_OK / HR_IGNORE -- 接受连接 * HR_ERROR -- 拒绝连接 */ virtual EnHandleResult OnAccept(CONNID dwConnID, SOCKET soClient) = 0; }; /************************************************************************ 名称：PUSH 模型服务端 Socket 监听器抽象基类 描述：定义某些事件的默认处理方法（忽略事件） ************************************************************************/ class CTcpServerListener : public ITcpServerListener { public: virtual EnHandleResult OnPrepareListen(SOCKET soListen) {return HR_IGNORE;} virtual EnHandleResult OnAccept(CONNID dwConnID, SOCKET soClient) {return HR_IGNORE;} virtual EnHandleResult OnHandShake(CONNID dwConnID) {return HR_IGNORE;} virtual EnHandleResult OnReceive(CONNID dwConnID, int iLength) {return HR_IGNORE;} virtual EnHandleResult OnSend(CONNID dwConnID, const BYTE* pData, int iLength) {return HR_IGNORE;} virtual EnHandleResult OnShutdown() {return HR_IGNORE;} }; /************************************************************************ 名称：PULL 模型服务端 Socket 监听器抽象基类 描述：定义某些事件的默认处理方法（忽略事件） ************************************************************************/ class CTcpPullServerListener : public CTcpServerListener { public: virtual EnHandleResult OnReceive(CONNID dwConnID, int iLength) = 0; virtual EnHandleResult OnReceive(CONNID dwConnID, const BYTE* pData, int iLength) {return HR_IGNORE;} }; /************************************************************************ 名称：UDP 服务端 Socket 监听器接口 描述：定义 UDP 服务端 Socket 监听器的所有事件 ************************************************************************/ class IUdpServerListener : public IServerListener { public: /* * 名称：接收连接通知 * 描述：接收到客户端连接请求时，Socket 监听器将收到该通知，监听器可以在通知处理方 * 法中执行 Socket 选项设置或拒绝客户端连接等额外工作 * * 参数： dwConnID -- 连接 ID * soClient -- 客户端 Socket * 返回值： HR_OK / HR_IGNORE -- 接受连接 * HR_ERROR -- 拒绝连接 */ virtual EnHandleResult OnAccept(CONNID dwConnID, const SOCKADDR_IN* pSockAddr) = 0; }; /************************************************************************ 名称：UDP 服务端 Socket 监听器抽象基类 描述：定义某些事件的默认处理方法（忽略事件） ************************************************************************/ class CUdpServerListener : public IUdpServerListener { public: virtual EnHandleResult OnPrepareListen(SOCKET soListen) {return HR_IGNORE;} virtual EnHandleResult OnAccept(CONNID dwConnID, const SOCKADDR_IN* pSockAddr) {return HR_IGNORE;} virtual EnHandleResult OnHandShake(CONNID dwConnID) {return HR_IGNORE;} virtual EnHandleResult OnReceive(CONNID dwConnID, int iLength) {return HR_IGNORE;} virtual EnHandleResult OnSend(CONNID dwConnID, const BYTE* pData, int iLength) {return HR_IGNORE;} virtual EnHandleResult OnShutdown() {return HR_IGNORE;} }; /************************************************************************ 名称：通信代理 Socket 监听器接口 描述：定义 通信代理 Socket 监听器的所有事件 ************************************************************************/ class IAgentListener : public IComplexSocketListener { public: /* * 名称：准备连接通知 * 描述：通信客户端组件启动时，在客户端 Socket 创建完成并开始执行连接前，Socket 监听 * 器将收到该通知，监听器可以在通知处理方法中执行 Socket 选项设置等额外工作 * * 参数： dwConnID -- 连接 ID * socket -- 客户端 Socket * 返回值： HR_OK / HR_IGNORE -- 继续执行 * HR_ERROR -- 终止启动通信客户端组件 */ virtual EnHandleResult OnPrepareConnect(CONNID dwConnID, SOCKET socket) = 0; /* * 名称：连接完成通知 * 描述：与服务端成功建立连接时，Socket 监听器将收到该通知 * * 参数： dwConnID -- 连接 ID * 返回值： HR_OK / HR_IGNORE -- 继续执行 * HR_ERROR -- 同步连接：终止启动通信客户端组件 * 异步连接：关闭连接 */ virtual EnHandleResult OnConnect(CONNID dwConnID) = 0; }; /************************************************************************ 名称：TCP 通信代理 Socket 监听器接口 描述：定义 TCP 通信代理 Socket 监听器的所有事件 ************************************************************************/ class ITcpAgentListener : public IAgentListener { public: }; /************************************************************************ 名称：PUSH 模型通信代理 Socket 监听器抽象基类 描述：定义某些事件的默认处理方法（忽略事件） ************************************************************************/ class CTcpAgentListener : public ITcpAgentListener { public: virtual EnHandleResult OnPrepareConnect(CONNID dwConnID, SOCKET socket) {return HR_IGNORE;} virtual EnHandleResult OnConnect(CONNID dwConnID) {return HR_IGNORE;} virtual EnHandleResult OnHandShake(CONNID dwConnID) {return HR_IGNORE;} virtual EnHandleResult OnReceive(CONNID dwConnID, int iLength) {return HR_IGNORE;} virtual EnHandleResult OnSend(CONNID dwConnID, const BYTE* pData, int iLength) {return HR_IGNORE;} virtual EnHandleResult OnShutdown() {return HR_IGNORE;} }; /************************************************************************ 名称：PULL 通信代理 Socket 监听器抽象基类 描述：定义某些事件的默认处理方法（忽略事件） ************************************************************************/ class CTcpPullAgentListener : public CTcpAgentListener { public: virtual EnHandleResult OnReceive(CONNID dwConnID, int iLength) = 0; virtual EnHandleResult OnReceive(CONNID dwConnID, const BYTE* pData, int iLength) {return HR_IGNORE;} }; /************************************************************************ 名称：客户端 Socket 监听器接口 描述：定义客户端 Socket 监听器的所有事件 ************************************************************************/ class IClient; class IClientListener { public: /* * 名称：握手完成通知 * 描述：连接完成握手时，Socket 监听器将收到该通知，监听器接收到该通知后才能开始 * 数据收发操作 * * 参数： dwConnID -- 连接 ID * 返回值： HR_OK / HR_IGNORE -- 继续执行 * HR_ERROR -- 引发 OnClose() 事件并关闭连接 */ virtual EnHandleResult OnHandShake(IClient* pClient) = 0; /* * 名称：准备连接通知 * 描述：通信客户端组件启动时，在客户端 Socket 创建完成并开始执行连接前，Socket 监听 * 器将收到该通知，监听器可以在通知处理方法中执行 Socket 选项设置等额外工作 * * 参数： pClient -- 连接对象 * socket -- 客户端 Socket * 返回值： HR_OK / HR_IGNORE -- 继续执行 * HR_ERROR -- 终止启动通信客户端组件 */ virtual EnHandleResult OnPrepareConnect(IClient* pClient, SOCKET socket) = 0; /* * 名称：连接完成通知 * 描述：与服务端成功建立连接时，Socket 监听器将收到该通知 * * 参数： pClient -- 连接对象 * 返回值： HR_OK / HR_IGNORE -- 继续执行 * HR_ERROR -- 同步连接：终止启动通信客户端组件 * 异步连接：关闭连接 */ virtual EnHandleResult OnConnect(IClient* pClient) = 0; /* * 名称：已发送数据通知 * 描述：成功发送数据后，Socket 监听器将收到该通知 * * 参数： pClient -- 连接对象 * pData -- 已发送数据缓冲区 * iLength -- 已发送数据长度 * 返回值： HR_OK / HR_IGNORE -- 继续执行 * HR_ERROR -- 该通知不允许返回 HR_ERROR（调试模式下引发断言错误） */ virtual EnHandleResult OnSend(IClient* pClient, const BYTE* pData, int iLength) = 0; /* * 名称：数据到达通知（PUSH 模型） * 描述：对于 PUSH 模型的 Socket 通信组件，成功接收数据后将向 Socket 监听器发送该通知 * * 参数： pClient -- 连接对象 * pData -- 已接收数据缓冲区 * iLength -- 已接收数据长度 * 返回值： HR_OK / HR_IGNORE -- 继续执行 * HR_ERROR -- 引发 OnClose() 事件并关闭连接 */ virtual EnHandleResult OnReceive(IClient* pClient, const BYTE* pData, int iLength) = 0; /* * 名称：数据到达通知（PULL 模型） * 描述：对于 PULL 模型的 Socket 通信组件，成功接收数据后将向 Socket 监听器发送该通知 * * 参数： pClient -- 连接对象 * iLength -- 已接收数据长度 * 返回值： HR_OK / HR_IGNORE -- 继续执行 * HR_ERROR -- 引发 OnClose() 事件并关闭连接 */ virtual EnHandleResult OnReceive(IClient* pClient, int iLength) = 0; /* * 名称：通信错误通知 * 描述：通信发生错误后，Socket 监听器将收到该通知，并关闭连接 * * 参数： pClient -- 连接对象 * enOperation -- Socket 操作类型 * iErrorCode -- 错误代码 * 返回值： 忽略返回值 */ virtual EnHandleResult OnClose(IClient* pClient, EnSocketOperation enOperation, int iErrorCode) = 0; public: virtual ~IClientListener() {} }; /************************************************************************ 名称：TCP 客户端 Socket 监听器接口 描述：定义 TCP 客户端 Socket 监听器的所有事件 ************************************************************************/ class ITcpClientListener : public IClientListener { public: }; /************************************************************************ 名称：PUSH 模型客户端 Socket 监听器抽象基类 描述：定义某些事件的默认处理方法（忽略事件） ************************************************************************/ class CTcpClientListener : public ITcpClientListener { public: virtual EnHandleResult OnPrepareConnect(IClient* pClient, SOCKET socket) {return HR_IGNORE;} virtual EnHandleResult OnConnect(IClient* pClient) {return HR_IGNORE;} virtual EnHandleResult OnHandShake(IClient* pClient) {return HR_IGNORE;} virtual EnHandleResult OnReceive(IClient* pClient, int iLength) {return HR_IGNORE;} virtual EnHandleResult OnSend(IClient* pClient, const BYTE* pData, int iLength) {return HR_IGNORE;} }; /************************************************************************ 名称：PULL 客户端 Socket 监听器抽象基类 描述：定义某些事件的默认处理方法（忽略事件） ************************************************************************/ class CTcpPullClientListener : public CTcpClientListener { public: virtual EnHandleResult OnReceive(IClient* pClient, int iLength) = 0; virtual EnHandleResult OnReceive(IClient* pClient, const BYTE* pData, int iLength) {return HR_IGNORE;} }; /************************************************************************ 名称：UDP 客户端 Socket 监听器接口 描述：定义 UDP 客户端 Socket 监听器的所有事件 ************************************************************************/ class IUdpClientListener : public IClientListener { }; /************************************************************************ 名称：UDP 户端 Socket 监听器抽象基类 描述：定义某些事件的默认处理方法（忽略事件） ************************************************************************/ class CUdpClientListener : public IUdpClientListener { public: virtual EnHandleResult OnPrepareConnect(IClient* pClient, SOCKET socket) {return HR_IGNORE;} virtual EnHandleResult OnConnect(IClient* pClient) {return HR_IGNORE;} virtual EnHandleResult OnHandShake(IClient* pClient) {return HR_IGNORE;} virtual EnHandleResult OnReceive(IClient* pClient, int iLength) {return HR_IGNORE;} virtual EnHandleResult OnSend(IClient* pClient, const BYTE* pData, int iLength) {return HR_IGNORE;} }; /************************************************************************ 名称：UDP 传播 Socket 监听器接口 描述：定义 UDP 传播 Socket 监听器的所有事件 ************************************************************************/ class IUdpCastListener : public IClientListener { }; /************************************************************************ 名称：UDP 传播 Socket 监听器抽象基类 描述：定义某些事件的默认处理方法（忽略事件） ************************************************************************/ class CUdpCastListener : public IUdpCastListener { public: virtual EnHandleResult OnPrepareConnect(IClient* pClient, SOCKET socket) {return HR_IGNORE;} virtual EnHandleResult OnConnect(IClient* pClient) {return HR_IGNORE;} virtual EnHandleResult OnHandShake(IClient* pClient) {return HR_IGNORE;} virtual EnHandleResult OnReceive(IClient* pClient, int iLength) {return HR_IGNORE;} virtual EnHandleResult OnSend(IClient* pClient, const BYTE* pData, int iLength) {return HR_IGNORE;} }; /************************************************************************ 名称：复合 Socket 组件接口 描述：定义复合 Socket 组件的所有操作方法和属性访问方法，复合 Socket 组件同时管理多个 Socket 连接 ************************************************************************/ class IComplexSocket { public: /***********************************************************************/ /***************************** 组件操作方法 *****************************/ /* * 名称：关闭通信组件 * 描述：关闭通信组件，关闭完成后断开所有连接并释放所有资源 * * 参数： * 返回值： TRUE -- 成功 * FALSE -- 失败，可通过 GetLastError() 获取错误代码 */ virtual BOOL Stop () = 0; /* * 名称：发送数据 * 描述：向指定连接发送数据 * * 参数： dwConnID -- 连接 ID * pBuffer -- 发送缓冲区 * iLength -- 发送缓冲区长度 * iOffset -- 发送缓冲区指针偏移量 * 返回值： TRUE -- 成功 * FALSE -- 失败，可通过 Windows API 函数 ::GetLastError() 获取 Windows 错误代码 */ virtual BOOL Send (CONNID dwConnID, const BYTE* pBuffer, int iLength, int iOffset = 0) = 0; /* * 名称：发送多组数据 * 描述：向指定连接发送多组数据 * TCP - 顺序发送所有数据包 * UDP - 把所有数据包组合成一个数据包发送（数据包的总长度不能大于设置的 UDP 包最大长度） * * 参数： dwConnID -- 连接 ID * pBuffers -- 发送缓冲区数组 * iCount -- 发送缓冲区数目 * 返回值： TRUE -- 成功 * FALSE -- 失败，可通过 Windows API 函数 ::GetLastError() 获取 Windows 错误代码 */ virtual BOOL SendPackets(CONNID dwConnID, const WSABUF pBuffers[], int iCount) = 0; /* * 名称：断开连接 * 描述：断开某个连接 * * 参数： dwConnID -- 连接 ID * bForce -- 是否强制断开连接 * 返回值： TRUE -- 成功 * FALSE -- 失败 */ virtual BOOL Disconnect(CONNID dwConnID, BOOL bForce = TRUE) = 0; /* * 名称：断开超时连接 * 描述：断开超过指定时长的连接 * * 参数： dwPeriod -- 时长（毫秒） * bForce -- 是否强制断开连接 * 返回值： TRUE -- 成功 * FALSE -- 失败 */ virtual BOOL DisconnectLongConnections(DWORD dwPeriod, BOOL bForce = TRUE) = 0; /* * 名称：断开静默连接 * 描述：断开超过指定时长的静默连接 * * 参数： dwPeriod -- 时长（毫秒） * bForce -- 是否强制断开连接 * 返回值： TRUE -- 成功 * FALSE -- 失败 */ virtual BOOL DisconnectSilenceConnections(DWORD dwPeriod, BOOL bForce = TRUE) = 0; public: /***********************************************************************/ /***************************** 属性访问方法 *****************************/ /* * 名称：设置连接的附加数据 * 描述：是否为连接绑定附加数据或者绑定什么样的数据，均由应用程序自身决定 * * 参数： dwConnID -- 连接 ID * pv -- 数据 * 返回值： TRUE -- 成功 * FALSE -- 失败（无效的连接 ID） */ virtual BOOL SetConnectionExtra (CONNID dwConnID, PVOID pExtra) = 0; /* * 名称：获取连接的附加数据 * 描述：是否为连接绑定附加数据或者绑定什么样的数据，均由应用程序自身决定 * * 参数： dwConnID -- 连接 ID * ppv -- 数据指针 * 返回值： TRUE -- 成功 * FALSE -- 失败（无效的连接 ID） */ virtual BOOL GetConnectionExtra (CONNID dwConnID, PVOID* ppExtra) = 0; /* 检查通信组件是否已启动 */ virtual BOOL HasStarted () = 0; /* 查看通信组件当前状态 */ virtual EnServiceState GetState () = 0; /* 获取连接数 */ virtual DWORD GetConnectionCount () = 0; /* 获取所有连接的 CONNID */ virtual BOOL GetAllConnectionIDs (CONNID pIDs[], DWORD& dwCount) = 0; /* 获取某个连接时长（毫秒） */ virtual BOOL GetConnectPeriod (CONNID dwConnID, DWORD& dwPeriod) = 0; /* 获取某个连接静默时间（毫秒） */ virtual BOOL GetSilencePeriod (CONNID dwConnID, DWORD& dwPeriod) = 0; /* 获取某个连接的本地地址信息 */ virtual BOOL GetLocalAddress (CONNID dwConnID, TCHAR lpszAddress[], int& iAddressLen, USHORT& usPort) = 0; /* 获取某个连接的远程地址信息 */ virtual BOOL GetRemoteAddress (CONNID dwConnID, TCHAR lpszAddress[], int& iAddressLen, USHORT& usPort) = 0; /* 获取最近一次失败操作的错误代码 */ virtual EnSocketError GetLastError () = 0; /* 获取最近一次失败操作的错误描述 */ virtual LPCTSTR GetLastErrorDesc () = 0; /* 获取连接中未发出数据的长度 */ virtual BOOL GetPendingDataLength (CONNID dwConnID, int& iPending) = 0; /* 设置数据发送策略 */ virtual void SetSendPolicy (EnSendPolicy enSendPolicy) = 0; /* 设置最大连接数（组件会根据设置值预分配内存，因此需要根据实际情况设置，不宜过大）*/ virtual void SetMaxConnectionCount (DWORD MaxConnectionCount) = 0; /* 设置 Socket 缓存对象锁定时间（毫秒，在锁定期间该 Socket 缓存对象不能被获取使用） */ virtual void SetFreeSocketObjLockTime (DWORD dwFreeSocketObjLockTime) = 0; /* 设置 Socket 缓存池大小（通常设置为平均并发连接数的 1/3 - 1/2） */ virtual void SetFreeSocketObjPool (DWORD dwFreeSocketObjPool) = 0; /* 设置内存块缓存池大小（通常设置为 Socket 缓存池大小的 2 - 3 倍） */ virtual void SetFreeBufferObjPool (DWORD dwFreeBufferObjPool) = 0; /* 设置 Socket 缓存池回收阀值（通常设置为 Socket 缓存池大小的 3 倍） */ virtual void SetFreeSocketObjHold (DWORD dwFreeSocketObjHold) = 0; /* 设置内存块缓存池回收阀值（通常设置为内存块缓存池大小的 3 倍） */ virtual void SetFreeBufferObjHold (DWORD dwFreeBufferObjHold) = 0; /* 设置工作线程数量（通常设置为 2 * CPU + 2） */ virtual void SetWorkerThreadCount (DWORD dwWorkerThreadCount) = 0; /* 设置是否标记静默时间（设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效，默认：TRUE） */ virtual void SetMarkSilence (BOOL bMarkSilence) = 0; /* 获取数据发送策略 */ virtual EnSendPolicy GetSendPolicy () = 0; /* 获取最大连接数 */ virtual DWORD GetMaxConnectionCount () = 0; /* 获取 Socket 缓存对象锁定时间 */ virtual DWORD GetFreeSocketObjLockTime () = 0; /* 获取 Socket 缓存池大小 */ virtual DWORD GetFreeSocketObjPool () = 0; /* 获取内存块缓存池大小 */ virtual DWORD GetFreeBufferObjPool () = 0; /* 获取 Socket 缓存池回收阀值 */ virtual DWORD GetFreeSocketObjHold () = 0; /* 获取内存块缓存池回收阀值 */ virtual DWORD GetFreeBufferObjHold () = 0; /* 获取工作线程数量 */ virtual DWORD GetWorkerThreadCount () = 0; /* 检测是否标记静默时间 */ virtual BOOL IsMarkSilence () = 0; public: virtual ~IComplexSocket() {} }; /************************************************************************ 名称：通信服务端组件接口 描述：定义通信服务端组件的所有操作方法和属性访问方法 ************************************************************************/ class IServer : public IComplexSocket { public: /***********************************************************************/ /***************************** 组件操作方法 *****************************/ /* * 名称：启动通信组件 * 描述：启动服务端通信组件，启动完成后可开始接收客户端连接并收发数据 * * 参数： lpszBindAddress -- 监听地址 * usPort -- 监听端口 * 返回值： TRUE -- 成功 * FALSE -- 失败，可通过 GetLastError() 获取错误代码 */ virtual BOOL Start (LPCTSTR lpszBindAddress, USHORT usPort) = 0; public: /***********************************************************************/ /***************************** 属性访问方法 *****************************/ /* 获取监听 Socket 的地址信息 */ virtual BOOL GetListenAddress(TCHAR lpszAddress[], int& iAddressLen, USHORT& usPort) = 0; }; /************************************************************************ 名称：TCP 通信服务端组件接口 描述：定义 TCP 通信服务端组件的所有操作方法和属性访问方法 ************************************************************************/ class ITcpServer : public IServer { public: /***********************************************************************/ /***************************** 组件操作方法 *****************************/ /* * 名称：发送小文件 * 描述：向指定连接发送 4096 KB 以下的小文件 * * 参数： dwConnID -- 连接 ID * lpszFileName -- 文件路径 * pHead -- 头部附加数据 * pTail -- 尾部附加数据 * 返回值： TRUE -- 成功 * FALSE -- 失败，可通过 Windows API 函数 ::GetLastError() 获取 Windows 错误代码 */ virtual BOOL SendSmallFile (CONNID dwConnID, LPCTSTR lpszFileName, const LPWSABUF pHead = nullptr, const LPWSABUF pTail = nullptr) = 0; public: /***********************************************************************/ /***************************** 属性访问方法 *****************************/ /* 设置 Accept 预投递数量（根据负载调整设置，Accept 预投递数量越大则支持的并发连接请求越多） */ virtual void SetAcceptSocketCount (DWORD dwAcceptSocketCount) = 0; /* 设置通信数据缓冲区大小（根据平均通信数据包大小调整设置，通常设置为 1024 的倍数） */ virtual void SetSocketBufferSize (DWORD dwSocketBufferSize) = 0; /* 设置监听 Socket 的等候队列大小（根据并发连接数量调整设置） */ virtual void SetSocketListenQueue (DWORD dwSocketListenQueue) = 0; /* 设置正常心跳包间隔（毫秒，0 则不发送心跳包，默认：30 * 1000） */ virtual void SetKeepAliveTime (DWORD dwKeepAliveTime) = 0; /* 设置异常心跳包间隔（毫秒，0 不发送心跳包，，默认：10 * 1000，如果超过若干次 [默认：WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线） */ virtual void SetKeepAliveInterval (DWORD dwKeepAliveInterval) = 0; /* 获取 Accept 预投递数量 */ virtual DWORD GetAcceptSocketCount () = 0; /* 获取通信数据缓冲区大小 */ virtual DWORD GetSocketBufferSize () = 0; /* 获取监听 Socket 的等候队列大小 */ virtual DWORD GetSocketListenQueue () = 0; /* 获取正常心跳包间隔 */ virtual DWORD GetKeepAliveTime () = 0; /* 获取异常心跳包间隔 */ virtual DWORD GetKeepAliveInterval () = 0; }; /************************************************************************ 名称：UDP 通信服务端组件接口 描述：定义 UDP 通信服务端组件的所有操作方法和属性访问方法 ************************************************************************/ class IUdpServer : public IServer { public: /***********************************************************************/ /***************************** 组件操作方法 *****************************/ public: /***********************************************************************/ /***************************** 属性访问方法 *****************************/ /* 设置数据报文最大长度（建议在局域网环境下不超过 1472 字节，在广域网环境下不超过 548 字节） */ virtual void SetMaxDatagramSize (DWORD dwMaxDatagramSize) = 0; /* 获取数据报文最大长度 */ virtual DWORD GetMaxDatagramSize () = 0; /* 设置 Receive 预投递数量（根据负载调整设置，Receive 预投递数量越大则丢包概率越小） */ virtual void SetPostReceiveCount (DWORD dwPostReceiveCount) = 0; /* 获取 Receive 预投递数量 */ virtual DWORD GetPostReceiveCount () = 0; /* 设置监测包尝试次数（0 则不发送监测跳包，如果超过最大尝试次数则认为已断线） */ virtual void SetDetectAttempts (DWORD dwDetectAttempts) = 0; /* 设置监测包发送间隔（秒，0 不发送监测包） */ virtual void SetDetectInterval (DWORD dwDetectInterval) = 0; /* 获取心跳检查次数 */ virtual DWORD GetDetectAttempts () = 0; /* 获取心跳检查间隔 */ virtual DWORD GetDetectInterval () = 0; }; /************************************************************************ 名称：通信代理组件接口 描述：定义通信代理组件的所有操作方法和属性访问方法，代理组件本质是一个同时连接多个服务器的客户端组件 ************************************************************************/ class IAgent : public IComplexSocket { public: /***********************************************************************/ /***************************** 组件操作方法 *****************************/ /* * 名称：启动通信组件 * 描述：启动通信代理组件，启动完成后可开始连接远程服务器 * * 参数： lpszBindAddress -- 绑定地址（默认：nullptr，绑定 0.0.0.0） * bAsyncConnect -- 是否采用异步 Connect * 返回值： TRUE -- 成功 * FALSE -- 失败，可通过 GetLastError() 获取错误代码 */ virtual BOOL Start (LPCTSTR lpszBindAddress = nullptr, BOOL bAsyncConnect = TRUE) = 0; /* * 名称：连接服务器 * 描述：连接服务器，连接成功后 IAgentListener 会接收到 OnConnect() / OnHandShake() 事件 * * 参数： lpszRemoteAddress -- 服务端地址 * usPort -- 服务端端口 * pdwConnID -- 连接 ID（默认：nullptr，不获取连接 ID） * 返回值： TRUE -- 成功 * FALSE -- 失败，可通过 Windows API 函数 ::GetLastError() 获取 Windows 错误代码 */ virtual BOOL Connect(LPCTSTR lpszRemoteAddress, USHORT usPort, CONNID* pdwConnID = nullptr) = 0; public: /***********************************************************************/ /***************************** 属性访问方法 *****************************/ }; /************************************************************************ 名称：TCP 通信代理组件接口 描述：定义 TCP 通信代理组件的所有操作方法和属性访问方法 ************************************************************************/ class ITcpAgent : public IAgent { public: /***********************************************************************/ /***************************** 组件操作方法 *****************************/ /* * 名称：发送小文件 * 描述：向指定连接发送 4096 KB 以下的小文件 * * 参数： dwConnID -- 连接 ID * lpszFileName -- 文件路径 * pHead -- 头部附加数据 * pTail -- 尾部附加数据 * 返回值： TRUE -- 成功 * FALSE -- 失败，可通过 Windows API 函数 ::GetLastError() 获取 Windows 错误代码 */ virtual BOOL SendSmallFile (CONNID dwConnID, LPCTSTR lpszFileName, const LPWSABUF pHead = nullptr, const LPWSABUF pTail = nullptr) = 0; public: /***********************************************************************/ /***************************** 属性访问方法 *****************************/ /* 设置是否启用地址重用机制（默认：不启用） */ virtual void SetReuseAddress (BOOL bReuseAddress) = 0; /* 检测是否启用地址重用机制 */ virtual BOOL IsReuseAddress () = 0; /* 设置通信数据缓冲区大小（根据平均通信数据包大小调整设置，通常设置为 1024 的倍数） */ virtual void SetSocketBufferSize (DWORD dwSocketBufferSize) = 0; /* 设置正常心跳包间隔（毫秒，0 则不发送心跳包，默认：30 * 1000） */ virtual void SetKeepAliveTime (DWORD dwKeepAliveTime) = 0; /* 设置异常心跳包间隔（毫秒，0 不发送心跳包，，默认：10 * 1000，如果超过若干次 [默认：WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线） */ virtual void SetKeepAliveInterval (DWORD dwKeepAliveInterval) = 0; /* 获取通信数据缓冲区大小 */ virtual DWORD GetSocketBufferSize () = 0; /* 获取正常心跳包间隔 */ virtual DWORD GetKeepAliveTime () = 0; /* 获取异常心跳包间隔 */ virtual DWORD GetKeepAliveInterval () = 0; }; /************************************************************************ 名称：通信客户端组件接口 描述：定义通信客户端组件的所有操作方法和属性访问方法 ************************************************************************/ class IClient { public: /***********************************************************************/ /***************************** 组件操作方法 *****************************/ /* * 名称：启动通信组件 * 描述：启动客户端通信组件并连接服务端，启动完成后可开始收发数据 * * 参数： lpszRemoteAddress -- 服务端地址 * usPort -- 服务端端口 * bAsyncConnect -- 是否采用异步 Connect * lpszBindAddress -- 绑定地址（默认：nullptr，TcpClient/UdpClient -> 不执行绑定操作，UdpCast 绑定 -> 0.0.0.0） * 返回值： TRUE -- 成功 * FALSE -- 失败，可通过 GetLastError() 获取错误代码 */ virtual BOOL Start (LPCTSTR lpszRemoteAddress, USHORT usPort, BOOL bAsyncConnect = TRUE, LPCTSTR lpszBindAddress = nullptr) = 0; /* * 名称：关闭通信组件 * 描述：关闭客户端通信组件，关闭完成后断开与服务端的连接并释放所有资源 * * 参数： * 返回值： TRUE -- 成功 * FALSE -- 失败，可通过 GetLastError() 获取错误代码 */ virtual BOOL Stop () = 0; /* * 名称：发送数据 * 描述：向服务端发送数据 * * 参数： pBuffer -- 发送缓冲区 * iLength -- 发送缓冲区长度 * iOffset -- 发送缓冲区指针偏移量 * 返回值： TRUE -- 成功 * FALSE -- 失败，可通过 Windows API 函数 ::GetLastError() 获取 Windows 错误代码 */ virtual BOOL Send (const BYTE* pBuffer, int iLength, int iOffset = 0) = 0; /* * 名称：发送多组数据 * 描述：向服务端发送多组数据 * TCP - 顺序发送所有数据包 * UDP - 把所有数据包组合成一个数据包发送（数据包的总长度不能大于设置的 UDP 包最大长度） * * 参数： pBuffers -- 发送缓冲区数组 * iCount -- 发送缓冲区数目 * 返回值： TRUE -- 成功 * FALSE -- 失败，可通过 Windows API 函数 ::GetLastError() 获取 Windows 错误代码 */ virtual BOOL SendPackets(const WSABUF pBuffers[], int iCount) = 0; public: /***********************************************************************/ /***************************** 属性访问方法 *****************************/ /* 设置连接的附加数据 */ virtual void SetExtra (PVOID pExtra) = 0; /* 获取连接的附加数据 */ virtual PVOID GetExtra () = 0; /* 检查通信组件是否已启动 */ virtual BOOL HasStarted () = 0; /* 查看通信组件当前状态 */ virtual EnServiceState GetState () = 0; /* 获取最近一次失败操作的错误代码 */ virtual EnSocketError GetLastError () = 0; /* 获取最近一次失败操作的错误描述 */ virtual LPCTSTR GetLastErrorDesc() = 0; /* 获取该组件对象的连接 ID */ virtual CONNID GetConnectionID () = 0; /* 获取 Client Socket 的地址信息 */ virtual BOOL GetLocalAddress (TCHAR lpszAddress[], int& iAddressLen, USHORT& usPort) = 0; /* 获取连接中未发出数据的长度 */ virtual BOOL GetPendingDataLength (int& iPending) = 0; /* 设置内存块缓存池大小（通常设置为 -> PUSH 模型：5 - 10；PULL 模型：10 - 20 ） */ virtual void SetFreeBufferPoolSize (DWORD dwFreeBufferPoolSize) = 0; /* 设置内存块缓存池回收阀值（通常设置为内存块缓存池大小的 3 倍） */ virtual void SetFreeBufferPoolHold (DWORD dwFreeBufferPoolHold) = 0; /* 获取内存块缓存池大小 */ virtual DWORD GetFreeBufferPoolSize () = 0; /* 获取内存块缓存池回收阀值 */ virtual DWORD GetFreeBufferPoolHold () = 0; public: virtual ~IClient() {} }; /************************************************************************ 名称：TCP 通信客户端组件接口 描述：定义 TCP 通信客户端组件的所有操作方法和属性访问方法 ************************************************************************/ class ITcpClient : public IClient { public: /***********************************************************************/ /***************************** 组件操作方法 *****************************/ /* * 名称：发送小文件 * 描述：向服务端发送 4096 KB 以下的小文件 * * 参数： lpszFileName -- 文件路径 * pHead -- 头部附加数据 * pTail -- 尾部附加数据 * 返回值： TRUE -- 成功 * FALSE -- 失败，可通过 Windows API 函数 ::GetLastError() 获取 Windows 错误代码 */ virtual BOOL SendSmallFile (LPCTSTR lpszFileName, const LPWSABUF pHead = nullptr, const LPWSABUF pTail = nullptr) = 0; public: /***********************************************************************/ /***************************** 属性访问方法 *****************************/ /* 设置通信数据缓冲区大小（根据平均通信数据包大小调整设置，通常设置为：(N * 1024) - sizeof(TBufferObj)） */ virtual void SetSocketBufferSize (DWORD dwSocketBufferSize) = 0; /* 设置正常心跳包间隔（毫秒，0 则不发送心跳包，默认：30 * 1000） */ virtual void SetKeepAliveTime (DWORD dwKeepAliveTime) = 0; /* 设置异常心跳包间隔（毫秒，0 不发送心跳包，，默认：10 * 1000，如果超过若干次 [默认：WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线） */ virtual void SetKeepAliveInterval (DWORD dwKeepAliveInterval) = 0; /* 获取通信数据缓冲区大小 */ virtual DWORD GetSocketBufferSize () = 0; /* 获取正常心跳包间隔 */ virtual DWORD GetKeepAliveTime () = 0; /* 获取异常心跳包间隔 */ virtual DWORD GetKeepAliveInterval () = 0; }; /************************************************************************ 名称：UDP 通信客户端组件接口 描述：定义 UDP 通信客户端组件的所有操作方法和属性访问方法 ************************************************************************/ class IUdpClient : public IClient { public: /***********************************************************************/ /***************************** 组件操作方法 *****************************/ public: /***********************************************************************/ /***************************** 属性访问方法 *****************************/ /* 设置数据报文最大长度（建议在局域网环境下不超过 1472 字节，在广域网环境下不超过 548 字节） */ virtual void SetMaxDatagramSize (DWORD dwMaxDatagramSize) = 0; /* 获取数据报文最大长度 */ virtual DWORD GetMaxDatagramSize() = 0; /* 设置监测包尝试次数（0 则不发送监测跳包，如果超过最大尝试次数则认为已断线） */ virtual void SetDetectAttempts (DWORD dwDetectAttempts) = 0; /* 设置监测包发送间隔（秒，0 不发送监测包） */ virtual void SetDetectInterval (DWORD dwDetectInterval) = 0; /* 获取心跳检查次数 */ virtual DWORD GetDetectAttempts () = 0; /* 获取心跳检查间隔 */ virtual DWORD GetDetectInterval () = 0; }; /************************************************************************ 名称：UDP 传播组件接口 描述：定义 UDP 传播（组播或广播）组件的所有操作方法和属性访问方法 ************************************************************************/ class IUdpCast : public IClient { public: /***********************************************************************/ /***************************** 组件操作方法 *****************************/ public: /***********************************************************************/ /***************************** 属性访问方法 *****************************/ /* 设置数据报文最大长度（建议在局域网环境下不超过 1472 字节，在广域网环境下不超过 548 字节） */ virtual void SetMaxDatagramSize (DWORD dwMaxDatagramSize) = 0; /* 获取数据报文最大长度 */ virtual DWORD GetMaxDatagramSize() = 0; /* 设置是否启用地址重用机制（默认：不启用） */ virtual void SetReuseAddress (BOOL bReuseAddress) = 0; /* 检测是否启用地址重用机制 */ virtual BOOL IsReuseAddress () = 0; /* 设置传播模式（组播或广播） */ virtual void SetCastMode (EnCastMode enCastMode) = 0; /* 获取传播模式 */ virtual EnCastMode GetCastMode () = 0; /* 设置组播报文的 TTL（0 - 255） */ virtual void SetMultiCastTtl (int iMCTtl) = 0; /* 获取组播报文的 TTL */ virtual int GetMultiCastTtl () = 0; /* 设置是否启用组播环路（TRUE or FALSE） */ virtual void SetMultiCastLoop (BOOL bMCLoop) = 0; /* 检测是否启用组播环路 */ virtual BOOL IsMultiCastLoop () = 0; /* 获取当前数据报的远程地址信息（通常在 OnReceive 事件中调用） */ virtual BOOL GetRemoteAddress (TCHAR lpszAddress[], int& iAddressLen, USHORT& usPort) = 0; }; /************************************************************************ 名称：Server/Agent PULL 模型组件接口 描述：定义 Server/Agent 组件的 PULL 模型组件的所有操作方法 ************************************************************************/ class IPullSocket { public: /* * 名称：抓取数据 * 描述：用户通过该方法从 Socket 组件中抓取数据 * * 参数： dwConnID -- 连接 ID * pData -- 抓取缓冲区 * iLength -- 抓取数据长度 * 返回值： EnFetchResult */ virtual EnFetchResult Fetch (CONNID dwConnID, BYTE* pData, int iLength) = 0; /* * 名称：窥探数据（不会移除缓冲区数据） * 描述：用户通过该方法从 Socket 组件中窥探数据 * * 参数： dwConnID -- 连接 ID * pData -- 窥探缓冲区 * iLength -- 窥探数据长度 * 返回值： EnFetchResult */ virtual EnFetchResult Peek (CONNID dwConnID, BYTE* pData, int iLength) = 0; public: virtual ~IPullSocket() {} }; /************************************************************************ 名称：Client PULL 模型组件接口 描述：定义 Client 组件的 PULL 模型组件的所有操作方法 ************************************************************************/ class IPullClient { public: /* * 名称：抓取数据 * 描述：用户通过该方法从 Socket 组件中抓取数据 * * 参数： pData -- 抓取缓冲区 * iLength -- 抓取数据长度 * 返回值： EnFetchResult */ virtual EnFetchResult Fetch (BYTE* pData, int iLength) = 0; /* * 名称：窥探数据（不会移除缓冲区数据） * 描述：用户通过该方法从 Socket 组件中窥探数据 * * 参数： pData -- 窥探缓冲区 * iLength -- 窥探数据长度 * 返回值： EnFetchResult */ virtual EnFetchResult Peek (BYTE* pData, int iLength) = 0; public: virtual ~IPullClient() {} }; /************************************************************************ 名称：TCP Server PULL 模型组件接口 描述：继承了 ITcpServer 和 IPullSocket ************************************************************************/ class ITcpPullServer : public IPullSocket, public ITcpServer { public: /* IServer* 转换为 IPullSocket* */ inline static IPullSocket* ToPull(IServer* pServer) { return (IPullSocket*)((char*)pServer - sizeof(IPullSocket)); } /* IPullSocket* 转换为 ITcpServer* */ inline static ITcpServer* ToServer(IPullSocket* pPullSocket) { return (ITcpServer*)((char*)pPullSocket + sizeof(IPullSocket)); } }; /************************************************************************ 名称：TCP Agent PULL 模型组件接口 描述：继承了 ITcpAgent 和 IPullSocket ************************************************************************/ class ITcpPullAgent : public IPullSocket, public ITcpAgent { public: /* IAgent* 转换为 IPullSocket* */ inline static IPullSocket* ToPull(IAgent* pAgent) { return (IPullSocket*)((char*)pAgent - sizeof(IPullSocket)); } /* IPullSocket* 转换为 ITcpAgent* */ inline static ITcpAgent* ToAgent(IPullSocket* pPullSocket) { return (ITcpAgent*)((char*)pPullSocket + sizeof(IPullSocket)); } }; /************************************************************************ 名称：TCP Client PULL 模型组件接口 描述：继承了 ITcpClient 和 IPullClient ************************************************************************/ class ITcpPullClient : public IPullClient, public ITcpClient { public: /* IClient* 转换为 IPullClient* */ inline static IPullClient* ToPull(IClient* pClient) { return (IPullClient*)((char*)pClient - sizeof(IPullClient)); } /* IPullClient* 转换为 ITcpClient* */ inline static ITcpClient* ToClient(IPullClient* pPullClient) { return (ITcpClient*)((char*)pPullClient + sizeof(IPullClient)); } }; /************************************************************************ 名称：Server/Agent PACK 模型组件接口 描述：定义 Server/Agent 组件的 PACK 模型组件的所有操作方法 ************************************************************************/ class IPackSocket { public: /***********************************************************************/ /***************************** 属性访问方法 *****************************/ /* 设置数据包最大长度（有效数据包最大长度不能超过 4194303/0x3FFFFF 字节，默认：262144/0x40000） */ virtual void SetMaxPackSize (DWORD dwMaxPackSize) = 0; /* 设置包头标识（有效包头标识取值范围 0 ~ 1023/0x3FF，当包头标识为 0 时不校验包头，默认：0） */ virtual void SetPackHeaderFlag (USHORT usPackHeaderFlag) = 0; /* 获取数据包最大长度 */ virtual DWORD GetMaxPackSize () = 0; /* 获取包头标识 */ virtual USHORT GetPackHeaderFlag() = 0; public: virtual ~IPackSocket() {} }; /************************************************************************ 名称：Client PACK 模型组件接口 描述：定义 Client 组件的 PACK 模型组件的所有操作方法 ************************************************************************/ class IPackClient { public: /***********************************************************************/ /***************************** 属性访问方法 *****************************/ /* 设置数据包最大长度（有效数据包最大长度不能超过 4194303/0x3FFFFF 字节，默认：262144/0x40000） */ virtual void SetMaxPackSize (DWORD dwMaxPackSize) = 0; /* 设置包头标识（有效包头标识取值范围 0 ~ 1023/0x3FF，当包头标识为 0 时不校验包头，默认：0） */ virtual void SetPackHeaderFlag (USHORT usPackHeaderFlag) = 0; /* 获取数据包最大长度 */ virtual DWORD GetMaxPackSize () = 0; /* 获取包头标识 */ virtual USHORT GetPackHeaderFlag() = 0; public: virtual ~IPackClient() {} }; /************************************************************************ 名称：TCP Server PACK 模型组件接口 描述：继承了 ITcpServer 和 IPackSocket ************************************************************************/ class ITcpPackServer : public IPackSocket, public ITcpServer { public: /* IServer* 转换为 IPackSocket* */ inline static IPackSocket* ToPack(IServer* pServer) { return (IPackSocket*)((char*)pServer - sizeof(IPackSocket)); } /* IPackSocket* 转换为 ITcpServer* */ inline static ITcpServer* ToServer(IPackSocket* pPackSocket) { return (ITcpServer*)((char*)pPackSocket + sizeof(IPackSocket)); } }; /************************************************************************ 名称：TCP Agent PACK 模型组件接口 描述：继承了 ITcpAgent 和 IPackSocket ************************************************************************/ class ITcpPackAgent : public IPackSocket, public ITcpAgent { public: /* IAgent* 转换为 IPackSocket* */ inline static IPackSocket* ToPack(IAgent* pAgent) { return (IPackSocket*)((char*)pAgent - sizeof(IPackSocket)); } /* IPackSocket* 转换为 ITcpAgent* */ inline static ITcpAgent* ToAgent(IPackSocket* pPackSocket) { return (ITcpAgent*)((char*)pPackSocket + sizeof(IPackSocket)); } }; /************************************************************************ 名称：TCP Client PACK 模型组件接口 描述：继承了 ITcpClient 和 IPackClient ************************************************************************/ class ITcpPackClient : public IPackClient, public ITcpClient { public: /* IClient* 转换为 IPackClient* */ inline static IPackClient* ToPack(IClient* pClient) { return (IPackClient*)((char*)pClient - sizeof(IPackClient)); } /* IPackClient* 转换为 ITcpClient* */ inline static ITcpClient* ToClient(IPackClient* pPackClient) { return (ITcpClient*)((char*)pPackClient + sizeof(IPackClient)); } }; /*****************************************************************************************************************************************************/ /****************************************************************** HTTP Interfaces ******************************************************************/ /*****************************************************************************************************************************************************/ /************************************************************************ 名称：IComplexHttp 组件监听器基接口 描述：定义 IComplexHttp 组件监听器的所有事件 ************************************************************************/ class IComplexHttpListener { public: /* * 名称：开始解析通知 * 描述：开始解析 HTTP 报文时，向监听器发送该通知 * * 参数： dwConnID -- 连接 ID * 返回值： HPR_OK -- 继续执行 * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接 */ virtual EnHttpParseResult OnMessageBegin(CONNID dwConnID) = 0; /* * 名称：请求行解析完成通知（仅用于 HTTP 服务端） * 描述：请求行解析完成后，向监听器发送该通知 * * 参数： dwConnID -- 连接 ID * lpszMethod -- 请求方法名 * lpszUrl -- 请求行中的 URL 域 * 返回值： HPR_OK -- 继续执行 * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接 */ virtual EnHttpParseResult OnRequestLine(CONNID dwConnID, LPCSTR lpszMethod, LPCSTR lpszUrl) = 0; /* * 名称：状态行解析完成通知（仅用于 HTTP 客户端） * 描述：状态行解析完成后，向监听器发送该通知 * * 参数： dwConnID -- 连接 ID * usStatusCode -- HTTP 状态码 * lpszDesc -- 状态描述 * 返回值： HPR_OK -- 继续执行 * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接 */ virtual EnHttpParseResult OnStatusLine(CONNID dwConnID, USHORT usStatusCode, LPCSTR lpszDesc) = 0; /* * 名称：请求头通知 * 描述：每当解析完成一个请求头后，向监听器发送该通知 * * 参数： dwConnID -- 连接 ID * lpszName -- 请求头名称 * lpszValue -- 请求头值 * 返回值： HPR_OK -- 继续执行 * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接 */ virtual EnHttpParseResult OnHeader(CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue) = 0; /* * 名称：请求头完成通知 * 描述：解析完成所有请求头后，向监听器发送该通知 * * 参数： dwConnID -- 连接 ID * 返回值： HPR_OK -- 继续执行 * HPR_SKIP_BODY -- 跳过当前请求的 HTTP BODY * HPR_UPGRADE -- 升级协议 * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接 */ virtual EnHttpParseResult OnHeadersComplete(CONNID dwConnID) = 0; /* * 名称：BODY 报文通知 * 描述：每当接收到 HTTP BODY 报文，向监听器发送该通知 * * 参数： dwConnID -- 连接 ID * pData -- 数据缓冲区 * iLength -- 数据长度 * 返回值： HPR_OK -- 继续执行 * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接 */ virtual EnHttpParseResult OnBody(CONNID dwConnID, const BYTE* pData, int iLength) = 0; /* * 名称：Chunked 报文头通知 * 描述：每当解析出一个 Chunked 报文头，向监听器发送该通知 * * 参数： dwConnID -- 连接 ID * iLength -- Chunked 报文体数据长度 * 返回值： HPR_OK -- 继续执行 * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接 */ virtual EnHttpParseResult OnChunkHeader(CONNID dwConnID, int iLength) = 0; /* * 名称：Chunked 报文结束通知 * 描述：每当解析完一个 Chunked 报文，向监听器发送该通知 * * 参数： dwConnID -- 连接 ID * 返回值： HPR_OK -- 继续执行 * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接 */ virtual EnHttpParseResult OnChunkComplete(CONNID dwConnID) = 0; /* * 名称：完成解析通知 * 描述：每当解析完成一个完整 HTTP 报文，向监听器发送该通知 * * 参数： dwConnID -- 连接 ID * 返回值： HPR_OK -- 继续执行 * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接 */ virtual EnHttpParseResult OnMessageComplete(CONNID dwConnID) = 0; /* * 名称：升级协议通知 * 描述：当需要升级协议时，向监听器发送该通知 * * 参数： dwConnID -- 连接 ID * enUpgradeType -- 协议类型 * 返回值： HPR_OK -- 继续执行 * HPR_ERROR -- 引发 OnClose() 事件并关闭连接 */ virtual EnHttpParseResult OnUpgrade(CONNID dwConnID, EnHttpUpgradeType enUpgradeType) = 0; /* * 名称：解析错误通知 * 描述：当解析 HTTP 报文错误时，向监听器发送该通知 * * 参数： dwConnID -- 连接 ID * iErrorCode -- 错误代码 * lpszErrorDesc -- 错误描述 * 返回值： HPR_OK -- 继续执行 * HPR_ERROR -- 引发 OnClose() 事件并关闭连接 */ virtual EnHttpParseResult OnParseError(CONNID dwConnID, int iErrorCode, LPCSTR lpszErrorDesc) = 0; public: virtual ~IComplexHttpListener() {} }; /************************************************************************ 名称：IHttpServer 组件端监听器接口 描述：定义 IHttpServer 监听器的所有事件 ************************************************************************/ class IHttpServerListener : public IComplexHttpListener, public ITcpServerListener { public: }; /************************************************************************ 名称：IHttpAgent 组件端监听器接口 描述：定义 IHttpAgent 监听器的所有事件 ************************************************************************/ class IHttpAgentListener : public IComplexHttpListener, public ITcpAgentListener { public: }; /************************************************************************ 名称：IHttpServerListener 监听器抽象基类 描述：定义某些事件的默认处理方法（忽略事件） ************************************************************************/ class CHttpServerListener : public IHttpServerListener { public: virtual EnHandleResult OnPrepareListen(SOCKET soListen) {return HR_IGNORE;} virtual EnHandleResult OnAccept(CONNID dwConnID, SOCKET soClient) {return HR_IGNORE;} virtual EnHandleResult OnHandShake(CONNID dwConnID) {return HR_IGNORE;} virtual EnHandleResult OnReceive(CONNID dwConnID, int iLength) {return HR_IGNORE;} virtual EnHandleResult OnReceive(CONNID dwConnID, const BYTE* pData, int iLength) {return HR_IGNORE;} virtual EnHandleResult OnSend(CONNID dwConnID, const BYTE* pData, int iLength) {return HR_IGNORE;} virtual EnHandleResult OnShutdown() {return HR_IGNORE;} virtual EnHttpParseResult OnMessageBegin(CONNID dwConnID) {return HPR_OK;} virtual EnHttpParseResult OnRequestLine(CONNID dwConnID, LPCSTR lpszMethod, LPCSTR lpszUrl) {return HPR_OK;} virtual EnHttpParseResult OnStatusLine(CONNID dwConnID, USHORT usStatusCode, LPCSTR lpszDesc) {return HPR_OK;} virtual EnHttpParseResult OnHeader(CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue) {return HPR_OK;} virtual EnHttpParseResult OnChunkHeader(CONNID dwConnID, int iLength) {return HPR_OK;} virtual EnHttpParseResult OnChunkComplete(CONNID dwConnID) {return HPR_OK;} virtual EnHttpParseResult OnUpgrade(CONNID dwConnID, EnHttpUpgradeType enUpgradeType) {return HPR_OK;} }; /************************************************************************ 名称：IHttpAgentListener 监听器抽象基类 描述：定义某些事件的默认处理方法（忽略事件） ************************************************************************/ class CHttpAgentListener : public IHttpAgentListener { public: virtual EnHandleResult OnPrepareConnect(CONNID dwConnID, SOCKET socket) {return HR_IGNORE;} virtual EnHandleResult OnConnect(CONNID dwConnID) {return HR_IGNORE;} virtual EnHandleResult OnHandShake(CONNID dwConnID) {return HR_IGNORE;} virtual EnHandleResult OnShutdown() {return HR_IGNORE;} virtual EnHandleResult OnReceive(CONNID dwConnID, int iLength) {return HR_IGNORE;} virtual EnHandleResult OnReceive(CONNID dwConnID, const BYTE* pData, int iLength) {return HR_IGNORE;} virtual EnHandleResult OnSend(CONNID dwConnID, const BYTE* pData, int iLength) {return HR_IGNORE;} virtual EnHttpParseResult OnMessageBegin(CONNID dwConnID) {return HPR_OK;} virtual EnHttpParseResult OnRequestLine(CONNID dwConnID, LPCSTR lpszMethod, LPCSTR lpszUrl) {return HPR_OK;} virtual EnHttpParseResult OnStatusLine(CONNID dwConnID, USHORT usStatusCode, LPCSTR lpszDesc) {return HPR_OK;} virtual EnHttpParseResult OnHeader(CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue) {return HPR_OK;} virtual EnHttpParseResult OnChunkHeader(CONNID dwConnID, int iLength) {return HPR_OK;} virtual EnHttpParseResult OnChunkComplete(CONNID dwConnID) {return HPR_OK;} virtual EnHttpParseResult OnUpgrade(CONNID dwConnID, EnHttpUpgradeType enUpgradeType) {return HPR_OK;} }; /************************************************************************ 名称：IHttp 组件监听器基接口 描述：定义 IHttp 组件监听器的所有事件 ************************************************************************/ class IHttp; class IHttpListener { public: /* * 名称：开始解析通知 * 描述：开始解析 HTTP 报文时，向监听器发送该通知 * * 参数： pHttp -- 组件对象指针 * 返回值： HPR_OK -- 继续执行 * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接 */ virtual EnHttpParseResult OnMessageBegin(IHttp* pHttp) = 0; /* * 名称：请求行解析完成通知（仅用于 HTTP 服务端） * 描述：请求行解析完成后，向监听器发送该通知 * * 参数： pHttp -- 组件对象指针 * lpszMethod -- 请求方法名 * lpszUrl -- 请求行中的 URL 域 * 返回值： HPR_OK -- 继续执行 * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接 */ virtual EnHttpParseResult OnRequestLine(IHttp* pHttp, LPCSTR lpszMethod, LPCSTR lpszUrl) = 0; /* * 名称：状态行解析完成通知（仅用于 HTTP 客户端） * 描述：状态行解析完成后，向监听器发送该通知 * * 参数： pHttp -- 组件对象指针 * usStatusCode -- HTTP 状态码 * lpszDesc -- 状态描述 * 返回值： HPR_OK -- 继续执行 * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接 */ virtual EnHttpParseResult OnStatusLine(IHttp* pHttp, USHORT usStatusCode, LPCSTR lpszDesc) = 0; /* * 名称：请求头通知 * 描述：每当解析完成一个请求头后，向监听器发送该通知 * * 参数： pHttp -- 组件对象指针 * lpszName -- 请求头名称 * lpszValue -- 请求头值 * 返回值： HPR_OK -- 继续执行 * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接 */ virtual EnHttpParseResult OnHeader(IHttp* pHttp, LPCSTR lpszName, LPCSTR lpszValue) = 0; /* * 名称：请求头完成通知 * 描述：解析完成所有请求头后，向监听器发送该通知 * * 参数： pHttp -- 组件对象指针 * 返回值： HPR_OK -- 继续执行 * HPR_SKIP_BODY -- 跳过当前请求的 HTTP BODY * HPR_UPGRADE -- 升级协议 * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接 */ virtual EnHttpParseResult OnHeadersComplete(IHttp* pHttp) = 0; /* * 名称：BODY 报文通知 * 描述：每当接收到 HTTP BODY 报文，向监听器发送该通知 * * 参数： pHttp -- 组件对象指针 * pData -- 数据缓冲区 * iLength -- 数据长度 * 返回值： HPR_OK -- 继续执行 * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接 */ virtual EnHttpParseResult OnBody(IHttp* pHttp, const BYTE* pData, int iLength) = 0; /* * 名称：Chunked 报文头通知 * 描述：每当解析出一个 Chunked 报文头，向监听器发送该通知 * * 参数： pHttp -- 组件对象指针 * iLength -- Chunked 报文体数据长度 * 返回值： HPR_OK -- 继续执行 * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接 */ virtual EnHttpParseResult OnChunkHeader(IHttp* pHttp, int iLength) = 0; /* * 名称：Chunked 报文结束通知 * 描述：每当解析完一个 Chunked 报文，向监听器发送该通知 * * 参数： pHttp -- 组件对象指针 * 返回值： HPR_OK -- 继续执行 * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接 */ virtual EnHttpParseResult OnChunkComplete(IHttp* pHttp) = 0; /* * 名称：完成解析通知 * 描述：每当解析完成一个完整 HTTP 报文，向监听器发送该通知 * * 参数： pHttp -- 组件对象指针 * 返回值： HPR_OK -- 继续执行 * HPR_ERROR -- 引发 OnParserError() 和 OnClose() 事件并关闭连接 */ virtual EnHttpParseResult OnMessageComplete(IHttp* pHttp) = 0; /* * 名称：升级协议通知 * 描述：当需要升级协议时，向监听器发送该通知 * * 参数： pHttp -- 组件对象指针 * enUpgradeType -- 协议类型 * 返回值： HPR_OK -- 继续执行 * HPR_ERROR -- 引发 OnClose() 事件并关闭连接 */ virtual EnHttpParseResult OnUpgrade(IHttp* pHttp, EnHttpUpgradeType enUpgradeType) = 0; /* * 名称：解析错误通知 * 描述：当解析 HTTP 报文错误时，向监听器发送该通知 * * 参数： pHttp -- 组件对象指针 * iErrorCode -- 错误代码 * lpszErrorDesc -- 错误描述 * 返回值： HPR_OK -- 继续执行 * HPR_ERROR -- 引发 OnClose() 事件并关闭连接 */ virtual EnHttpParseResult OnParseError(IHttp* pHttp, int iErrorCode, LPCSTR lpszErrorDesc) = 0; public: virtual ~IHttpListener() {} }; /************************************************************************ 名称：IHttpClient 组件端监听器接口 描述：定义 IHttpClient 监听器的所有事件 ************************************************************************/ class IHttpClientListener : public IHttpListener, public ITcpClientListener { public: }; /************************************************************************ 名称：IHttpClientListener 监听器抽象基类 描述：定义某些事件的默认处理方法（忽略事件） ************************************************************************/ class CHttpClientListener : public IHttpClientListener { public: virtual EnHandleResult OnPrepareConnect(IClient* pClient, SOCKET socket) {return HR_IGNORE;} virtual EnHandleResult OnConnect(IClient* pClient) {return HR_IGNORE;} virtual EnHandleResult OnHandShake(IClient* pClient) {return HR_IGNORE;} virtual EnHandleResult OnReceive(IClient* pClient, int iLength) {return HR_IGNORE;} virtual EnHandleResult OnReceive(IClient* pClient, const BYTE* pData, int iLength) {return HR_IGNORE;} virtual EnHandleResult OnSend(IClient* pClient, const BYTE* pData, int iLength) {return HR_IGNORE;} virtual EnHttpParseResult OnMessageBegin(IHttp* pClient) {return HPR_OK;} virtual EnHttpParseResult OnRequestLine(IHttp* pHttp, LPCSTR lpszMethod, LPCSTR lpszUrl) {return HPR_OK;} virtual EnHttpParseResult OnStatusLine(IHttp* pHttp, USHORT usStatusCode, LPCSTR lpszDesc) {return HPR_OK;} virtual EnHttpParseResult OnHeader(IHttp* pClient, LPCSTR lpszName, LPCSTR lpszValue) {return HPR_OK;} virtual EnHttpParseResult OnChunkHeader(IHttp* pClient, int iLength) {return HPR_OK;} virtual EnHttpParseResult OnChunkComplete(IHttp* pClient) {return HPR_OK;} virtual EnHttpParseResult OnUpgrade(IHttp* pClient, EnHttpUpgradeType enUpgradeType) {return HPR_OK;} }; /************************************************************************ 名称：复合 Http 组件接口 描述：定义复合 Http 组件的所有操作方法和属性访问方法，复合 Http 组件同时管理多个 Http 连接 ************************************************************************/ class IComplexHttp { public: /***********************************************************************/ /***************************** 组件操作方法 *****************************/ public: /***********************************************************************/ /***************************** 属性访问方法 *****************************/ /* 设置本地协议版本 */ virtual void SetLocalVersion(EnHttpVersion usVersion) = 0; /* 获取本地协议版本 */ virtual EnHttpVersion GetLocalVersion() = 0; /* 检查是否升级协议 */ virtual BOOL IsUpgrade(CONNID dwConnID) = 0; /* 检查是否有 Keep-Alive 标识 */ virtual BOOL IsKeepAlive(CONNID dwConnID) = 0; /* 获取协议版本 */ virtual USHORT GetVersion(CONNID dwConnID) = 0; /* 获取内容长度 */ virtual ULONGLONG GetContentLength(CONNID dwConnID) = 0; /* 获取内容类型 */ virtual LPCSTR GetContentType(CONNID dwConnID) = 0; /* 获取协议升级类型 */ virtual EnHttpUpgradeType GetUpgradeType(CONNID dwConnID) = 0; /* 获取解析错误代码 */ virtual USHORT GetParseErrorCode(CONNID dwConnID, LPCSTR* lpszErrorDesc = nullptr) = 0; /* 获取某个请求头（单值） */ virtual BOOL GetHeader(CONNID dwConnID, LPCSTR lpszName, LPCSTR* lpszValue) = 0; /* 获取某个请求头（多值） */ virtual BOOL GetHeaders(CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue[], DWORD& dwCount) = 0; /* 获取所有请求头 */ virtual BOOL GetAllHeaders(CONNID dwConnID, THeader lpHeaders[], DWORD& dwCount) = 0; /* 获取所有请求头名称 */ virtual BOOL GetAllHeaderNames(CONNID dwConnID, LPCSTR lpszName[], DWORD& dwCount) = 0; /* 获取 Cookie */ virtual BOOL GetCookie(CONNID dwConnID, LPCSTR lpszName, LPCSTR* lpszValue) = 0; /* 获取所有 Cookie */ virtual BOOL GetAllCookies(CONNID dwConnID, TCookie lpCookies[], DWORD& dwCount) = 0; /* // !! maybe implemented in future !! // virtual BOOL GetParam(CONNID dwConnID, LPCSTR lpszName, LPCSTR* lpszValue) = 0; virtual BOOL GetParams(CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue[], DWORD& dwCount) = 0; virtual BOOL GetAllParams(CONNID dwConnID, LPPARAM lpszParam[], DWORD& dwCount) = 0; virtual BOOL GetAllParamNames(CONNID dwConnID, LPCSTR lpszName[], DWORD& dwCount) = 0; */ public: virtual ~IComplexHttp() {} }; /************************************************************************ 名称：复合 Http 请求者组件接口 描述：定义复合 Http 请求者组件的所有操作方法和属性访问方法 ************************************************************************/ class IComplexHttpRequester : public IComplexHttp { public: /***********************************************************************/ /***************************** 组件操作方法 *****************************/ /* * 名称：发送请求 * 描述：向服务端发送 HTTP 请求 * * 参数： dwConnID -- 连接 ID * lpszMethod -- 请求方法 * lpszPath -- 请求路径 * lpHeaders -- 请求头 * iHeaderCount -- 请求头数量 * pBody -- 请求体 * iLength -- 请求体长度 * 返回值： TRUE -- 成功 * FALSE -- 失败 */ virtual BOOL SendRequest(CONNID dwConnID, LPCSTR lpszMethod, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0, const BYTE* pBody = nullptr, int iLength = 0) = 0; /* 发送 POST 请求 */ virtual BOOL SendPost(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength) = 0; /* 发送 PUT 请求 */ virtual BOOL SendPut(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength) = 0; /* 发送 PATCH 请求 */ virtual BOOL SendPatch(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength) = 0; /* 发送 GET 请求 */ virtual BOOL SendGet(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0; /* 发送 DELETE 请求 */ virtual BOOL SendDelete(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0; /* 发送 HEAD 请求 */ virtual BOOL SendHead(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0; /* 发送 TRACE 请求 */ virtual BOOL SendTrace(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0; /* 发送 OPTIONS 请求 */ virtual BOOL SendOptions(CONNID dwConnID, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0; /* 发送 CONNECT 请求 */ virtual BOOL SendConnect(CONNID dwConnID, LPCSTR lpszHost, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0; public: /***********************************************************************/ /***************************** 属性访问方法 *****************************/ /* 获取 HTTP 状态码 */ virtual USHORT GetStatusCode(CONNID dwConnID) = 0; /* 添加 Cookie */ virtual BOOL AddCookie(CONNID dwConnID, LPCSTR lpszName, LPCSTR lpszValue, BOOL bRelpace = TRUE) = 0; /* 删除 Cookie */ virtual BOOL DeleteCookie(CONNID dwConnID, LPCSTR lpszName) = 0; /* 删除所有 Cookie */ virtual BOOL DeleteAllCookies(CONNID dwConnID) = 0; }; /************************************************************************ 名称：复合 Http 响应者组件接口 描述：定义复合 Http 响应者组件的所有操作方法和属性访问方法 ************************************************************************/ class IComplexHttpResponder : public IComplexHttp { public: /***********************************************************************/ /***************************** 组件操作方法 *****************************/ /* * 名称：回复请求 * 描述：向客户端回复 HTTP 请求 * * 参数： dwConnID -- 连接 ID * usStatusCode -- HTTP 状态码 * lpszDesc -- HTTP 状态描述 * lpHeaders -- 回复请求头 * iHeaderCount -- 回复请求头数量 * pData -- 回复请求体 * iLength -- 回复请求体长度 * 返回值： TRUE -- 成功 * FALSE -- 失败 */ virtual BOOL SendResponse(CONNID dwConnID, USHORT usStatusCode, LPCSTR lpszDesc = nullptr, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0, const BYTE* pData = nullptr, int iLength = 0) = 0; /* * 名称：释放连接 * 描述：把连接放入释放队列，等待某个时间（通过 SetReleaseDelay() 设置）关闭连接 * * 参数： dwConnID -- 连接 ID * 返回值： TRUE -- 成功 * FALSE -- 失败 */ virtual BOOL Release(CONNID dwConnID) = 0; public: /***********************************************************************/ /***************************** 属性访问方法 *****************************/ /* 设置连接释放延时（默认：3000 毫秒） */ virtual void SetReleaseDelay(DWORD dwReleaseDelay) = 0; /* 获取连接释放延时 */ virtual DWORD GetReleaseDelay() = 0; /* 获取请求行 URL 域掩码（URL 域参考：EnHttpUrlField） */ virtual USHORT GetUrlFieldSet(CONNID dwConnID) = 0; /* 获取某个 URL 域值 */ virtual LPCSTR GetUrlField(CONNID dwConnID, EnHttpUrlField enField) = 0; /* 获取请求方法 */ virtual LPCSTR GetMethod(CONNID dwConnID) = 0; }; /************************************************************************ 名称：简单 HTTP 组件接口 描述：定义 简单 HTTP 组件的所有操作方法和属性访问方法 ************************************************************************/ class IHttp { public: /***********************************************************************/ /***************************** 组件操作方法 *****************************/ public: /***********************************************************************/ /***************************** 属性访问方法 *****************************/ /* 设置本地协议版本 */ virtual void SetLocalVersion(EnHttpVersion usVersion) = 0; /* 获取本地协议版本 */ virtual EnHttpVersion GetLocalVersion() = 0; /* 检查是否升级协议 */ virtual BOOL IsUpgrade() = 0; /* 检查是否有 Keep-Alive 标识 */ virtual BOOL IsKeepAlive() = 0; /* 获取协议版本 */ virtual USHORT GetVersion() = 0; /* 获取内容长度 */ virtual ULONGLONG GetContentLength() = 0; /* 获取内容类型 */ virtual LPCSTR GetContentType() = 0; /* 获取协议升级类型 */ virtual EnHttpUpgradeType GetUpgradeType() = 0; /* 获取解析错误代码 */ virtual USHORT GetParseErrorCode(LPCSTR* lpszErrorDesc = nullptr) = 0; /* 获取 HTTP 状态码 */ virtual USHORT GetStatusCode() = 0; /* 获取某个请求头（单值） */ virtual BOOL GetHeader(LPCSTR lpszName, LPCSTR* lpszValue) = 0; /* 获取某个请求头（多值） */ virtual BOOL GetHeaders(LPCSTR lpszName, LPCSTR lpszValue[], DWORD& dwCount) = 0; /* 获取所有请求头 */ virtual BOOL GetAllHeaders(THeader lpHeaders[], DWORD& dwCount) = 0; /* 获取所有请求头名称 */ virtual BOOL GetAllHeaderNames(LPCSTR lpszName[], DWORD& dwCount) = 0; /* 获取 Cookie */ virtual BOOL GetCookie(LPCSTR lpszName, LPCSTR* lpszValue) = 0; /* 获取所有 Cookie */ virtual BOOL GetAllCookies(TCookie lpCookies[], DWORD& dwCount) = 0; /* 添加 Cookie */ virtual BOOL AddCookie(LPCSTR lpszName, LPCSTR lpszValue, BOOL bRelpace = TRUE) = 0; /* 删除 Cookie */ virtual BOOL DeleteCookie(LPCSTR lpszName) = 0; /* 删除所有 Cookie */ virtual BOOL DeleteAllCookies() = 0; /* // !! maybe implemented in future !! // virtual BOOL GetParam(LPCSTR lpszName, LPCSTR* lpszValue) = 0; virtual BOOL GetParams(LPCSTR lpszName, LPCSTR lpszValue[], DWORD& dwCount) = 0; virtual BOOL GetAllParams(LPPARAM lpszParam[], DWORD& dwCount) = 0; virtual BOOL GetAllParamNames(LPCSTR lpszName[], DWORD& dwCount) = 0; */ public: virtual ~IHttp() {} }; /************************************************************************ 名称：简单 Http 请求者组件接口 描述：定义简单 Http 请求者组件的所有操作方法和属性访问方法 ************************************************************************/ class IHttpRequester : public IHttp { public: /***********************************************************************/ /***************************** 组件操作方法 *****************************/ /* * 名称：发送请求 * 描述：向服务端发送 HTTP 请求 * * 参数： lpszMethod -- 请求方法 * lpszPath -- 请求路径 * lpHeaders -- 请求头 * iHeaderCount -- 请求头数量 * pBody -- 请求体 * iLength -- 请求体长度 * 返回值： TRUE -- 成功 * FALSE -- 失败 */ virtual BOOL SendRequest(LPCSTR lpszMethod, LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0, const BYTE* pBody = nullptr, int iLength = 0) = 0; /* 发送 POST 请求 */ virtual BOOL SendPost(LPCSTR lpszPath, const THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength) = 0; /* 发送 PUT 请求 */ virtual BOOL SendPut(LPCSTR lpszPath, const THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength) = 0; /* 发送 PATCH 请求 */ virtual BOOL SendPatch(LPCSTR lpszPath, const THeader lpHeaders[], int iHeaderCount, const BYTE* pBody, int iLength) = 0; /* 发送 GET 请求 */ virtual BOOL SendGet(LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0; /* 发送 DELETE 请求 */ virtual BOOL SendDelete(LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0; /* 发送 HEAD 请求 */ virtual BOOL SendHead(LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0; /* 发送 TRACE 请求 */ virtual BOOL SendTrace(LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0; /* 发送 OPTIONS 请求 */ virtual BOOL SendOptions(LPCSTR lpszPath, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0; /* 发送 CONNECT 请求 */ virtual BOOL SendConnect(LPCSTR lpszHost, const THeader lpHeaders[] = nullptr, int iHeaderCount = 0) = 0; public: /***********************************************************************/ /***************************** 属性访问方法 *****************************/ }; /************************************************************************ 名称：HTTP Server 组件接口 描述：继承了 ITcpServer 和 IComplexHttpResponder ************************************************************************/ class IHttpServer : public IComplexHttpResponder, public ITcpServer { public: /* IServer* 转换为 IComplexHttpResponder* */ inline static IComplexHttpResponder* ToHttpResponder(IServer* pServer) { return (IComplexHttpResponder*)((char*)pServer - sizeof(IComplexHttpResponder)); } /* IComplexHttpResponder* 转换为 ITcpServer* */ inline static ITcpServer* ToServer(IComplexHttpResponder* pHttpResponder) { return (ITcpServer*)((char*)pHttpResponder + sizeof(IComplexHttpResponder)); } }; /************************************************************************ 名称：HTTP Agent 组件接口 描述：继承了 ITcpAgent 和 IComplexHttpRequester ************************************************************************/ class IHttpAgent : public IComplexHttpRequester, public ITcpAgent { public: /* IAgent* 转换为 IComplexHttpRequester* */ inline static IComplexHttpRequester* ToHttpRequester(IAgent* pAgent) { return (IComplexHttpRequester*)((char*)pAgent - sizeof(IComplexHttpRequester)); } /* IComplexHttpRequester* 转换为 ITcpAgent* */ inline static ITcpAgent* ToAgent(IComplexHttpRequester* pHttpRequester) { return (ITcpAgent*)((char*)pHttpRequester + sizeof(IComplexHttpRequester)); } }; /************************************************************************ 名称：HTTP Client 组件接口 描述：继承了 ITcpClient 和 IHttpRequester ************************************************************************/ class IHttpClient : public IHttpRequester, public ITcpClient { public: /* IClient* 转换为 IHttpRequester* */ inline static IHttpRequester* ToHttpRequester(IClient* pClient) { return (IHttpRequester*)((char*)pClient - sizeof(IHttpRequester)); } /* IHttpRequester* 转换为 ITcpClient* */ inline static ITcpClient* ToClient(IHttpRequester* pHttpRequester) { return (ITcpClient*)((char*)pHttpRequester + sizeof(IHttpRequester)); } };