123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040 |
- /*
- * 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 <winsock2.h>
- #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));
- }
- };
|