~smgpconn.~h

SMAL是short message abstract library的缩写,是由风起水流软件工作室（www.zealware.com）开发的一个支持短信网关系统开发的C++底层抽象接口库

/**
*	smgpconn.h
*	
*	Short Message Abstractive Library.(SMAL)
*
*	Copyright 2003-2006	北京风起水流软件工作室
*	
*	http://www.zealware.com
*	
*	[e-mail]
*
*/

#ifndef _SMGP_CONNECTION_H
#define _SMGP_CONNECTION_H

#include <smal.h>
#include <common/util.h>
#include <list>
#include <smgp/smgp_message.h>
#include <common/tcpsocket.h>
#include <smgp/smgpbase.h>
#include <common/threadpool.h>

class SMGPClient;

/// SMGP连接类
/** 实现了一个SMGP连接,用户可以通过一个连接进行消息收发,连接本身具有活动测试,断开自动重连等功能.
*/
class SMGPConnection : public CSmgp  
{
public:
/**@name Construction	*/
//@{
	/**构造函数
	 */
	SMGPConnection(
		SMGPClient           & _client,	                ///< connection所属的client
		const char           * _token,	                ///< connection的标识
		const char           * _smghost,                ///< 网关地址
		const unsigned short & _smgport,                ///< 网关端口
		const unsigned char	 & _smgversion,
		const char           * _username,               ///< 登录用户名
		const char           * _password,               ///< 登录口令
		const ConnectionType & _conntype,               ///< 连接类型
		const int            & _nActivetestInterval,    ///< 活动测试间隔
		const char           * _localhost = "",	        ///< 本地绑定地址
		const unsigned short & _localport = 0,	        ///< 本地绑定端口
		BOOL                 sync = TRUE		        ///< 是否同步,知道连接结束
		);

	/**初始化变量 
	*/
	void Initialize();

	/**打印统计信息
	*/
	virtual void DumpStatus();

	/**析构函数
	 */
	virtual ~SMGPConnection();
	//@}

/**@name GetFunctions	*/
//@{
	/**得到所属的client 
	*/
	SMGPClient & GetClient() const
	{		return client;	}

	/**得到连接标识 
	*/
	const char * GetToken() const
	{		return token;		}

	/**得到网关地址 
	*/
	const char * GetSmgHost() const
	{		return smghost;		}

	/**得到网关端口 
	*/
	int GetSmgPort() const
	{		return (int)smgport;	}

	/**得到登录用户名 
	*/
	const char * GetUserName() const
	{		return username;	}

	/**得到登录口令 
	*/
	const char * GetPassword() const
	{		return password;	}

	/**得到连接类型 
	*/
	ConnectionType GetConnectionType() const
	{		return conntype;	}

	/**得到发送的SUBMIT消息数 
	*/
	long GetSubmitCount() const
	{	return submitCount;		}

	/**得到发送成功的SUBMIT消息数 
	*/
	long GetSubmitSucceedCount() const
	{	return submitSucceedCount;		}

	/**得到发送失败的SUBMIT消息数 
	*/
	long GetSubmitFailedCount() const
	{	return submitFailedCount;		}

	/**得到失败的SUBMITResponse消息数 
	*/
	long GetRespFailedCount() const
	{	return respFailedCount;		}

	/**得到成功的SUBMITResponse消息数 
	*/
	long GetRespSucceedCount() const
	{	return respSucceedCount;		}

	/**得到收到的Deliver消息数 
	*/
	long GetDeliverCount() const
	{	return deliverCount;		}

	/**得到收到的StatusReport消息数 
	*/
	long GetStatusReportCount() const
	{	return sreportCount;		}

	/**当前连接是否忙碌 
	*/
	BOOL IsBusy() const
	{	return m_fBusy;		}

	/**设置当前连接忙闲状态 
	*/
	void SetBusy(BOOL status)
	{	m_fBusy = status;	}

	/**连接是否已经启动 
	*/
	BOOL IsOpened()
	{		return m_fLogined/* && m_fStarted*/;	}

	/**连接是否可用 
	*/
	BOOL IsReady()
	{		return IsOpened() && !IsBusy();	}

	/**是否可以发送消息 
	*/
	BOOL CanMakeSubmit()
	{		return (conntype != e_RecvOnly) && IsReady();	}

	//@}

	/**@name SMGP Command Function */
	//@{

	/**清除连接 */
	void Clear();

	/**发送SUBMIT消息 
	*/
	inline int Submit(
		smgp_submit & _message
	);

	/**主动发活动测试包 
	*/
	inline int ActiveTest();
	//@}

	/**@name Callback functions */
	//@{
	/**登录网关成功时调用 
	*/
	virtual void OnLogined();

	/**登录网关失败时调用 
	*/
	virtual void OnLoginFailed( int errorCode );

	/**同网关连接断开时调用 
	*/
	virtual void OnCleared();

	/**发送SUBMIT消息前调用,如果返回失败,则停止发送SUBMIT消息.
		在这里,只是简单地返回TRUE.
	 */
	virtual BOOL OnSubmiting( smgp_submit _message );

	/**发送SUBMIT消息成功时调用 
	*/
	virtual void OnSubmited( smgp_submit _message );

	/**发送SUBMIT消息失败时调用 */
	virtual void OnSubmitFailed( smgp_submit _message );

	/**收到CONNECT_RESPONSE时调用 
	*/
	virtual void OnReceivedConnectResponse( smgp_connect_resp _message );

	/**收到Terminate消息时调用 
	*/
	virtual void OnReceivedTerminate();

	/**收到SUBMIT_RESPONSE时调用 
	*/
	virtual void OnReceivedSubmitResponse( smgp_submit_deliver_resp _message );

	/**收到Deliver消息时调用 
	*/
	virtual void OnReceivedDeliver( smgp_deliver _message );

	/**收到STATUS_REPORT时调用 
	*/
	virtual void OnReceivedStatusReport( smgp_deliver _message );

	/**收到活动测试消息时调用 
	*/
	virtual void OnReceivedActiveTest();

	/**收到活动测试回复消息时调用 
	*/
	virtual void OnReceivedActiveTestResponse();

	/**输出日志时调用
		格式化输出日志,默认是把内容//TRACE出来
	 */
	virtual void OnLogWrite( LPCTSTR pchFmt, ... );
	//@}

	BOOL isOK;

protected:

	/**建立网关连接,启动消息接收模块 
	*/
	int CreateConnection();

	/**连接网关,登录网关 
	*/
	int Connect( BOOL outputdebug = TRUE );

	/**断开连接 
	*/
	void Terminate();

	/**接收SMG方面的所有消息 
	*/
	inline int RecvSmgMsg(
		smgp_smgtosp * css, 
		unsigned int & nResult
		);

	/**用于接收消息 
	*/
	static DWORD WINAPI RecvFunc( LPVOID pParam );

	virtual DWORD RecvProc();
	//virtual DWORD RecvProcMO();

protected:
	SMGPClient     & client;					///< 所属client
	char           token[MAX_PATH];					///< 连接ID(YYMMDDhhmmsslll)
	char           localhost[MAX_PATH];			///< 本地绑定地址
	unsigned short localport;			///< 本地绑定端口
	char           smghost[MAX_PATH];				///< 网关地址
	unsigned short smgport;				///< 网关端口
	unsigned char  smgversion;			///< 网关支持的最高版本号
	char           username[MAX_PATH];				///< 网关登录用户名
	char           password[MAX_PATH];				///< 网关登录口令
	ConnectionType conntype;				///< 网关连接类型

	TCPSocket      m_socket;				///< TCPSOCKET类
	BOOL           m_fStop;				///< 停止标志.
	BOOL           m_fLogined;			///< 是否成功登录
	BOOL           m_fStarted;			///< 是否成功启动
	BOOL           m_fBusy;				///< 是否正在发送消息

	int            m_RetryInterval;///< 重试时间间隔(ms)
	BOOL           m_fAutoResp;		///< 是否自动回复
	MyCriticalSection m_socketCS;		///< socket句柄锁
	HANDLE         m_hRecvThread;	///< 接收线程句柄.

	char           connectTime[MAX_PATH];		///< 成功连接网关的时间
	char           loginTime[MAX_PATH];			///< 成功登录时间
	char           disconnectTime[MAX_PATH];	///< 断开时间

	long           submitCount;		///< 提交的SUBMIT消息数
	long           submitSucceedCount;	///< SUBMIT发送成功消息数
	long           submitFailedCount;///< SUBMIT发送失败消息数
	long           respSucceedCount;///< 收到的submitresponse消息数
	long           respFailedCount;///< 收到的submitresponse消息数
	long           deliverCount;		///< 收到的Deliver消息数
	long           sreportCount;		///< 状态报告数
};

typedef std::list<SMGPConnection*> aList;

//
//用于处理消息和事件的线程池
//
class CJobSmgp : public IJobDesc {
public:
	CJobSmgp(SMGPClient	& _client, SMGPConnection	& _connection, JobType _type);

	CJobSmgp(SMGPClient	& _client, SMGPConnection	& _connection, JobType _type, smgp_submit_deliver_resp _message);

	CJobSmgp(SMGPClient	& _client, SMGPConnection	& _connection, JobType _type, smgp_deliver _message);

	CJobSmgp(SMGPClient	& _client, SMGPConnection	& _connection, JobType _type, smgp_submit _message, int nResult = 0);

	~CJobSmgp();

	void	OnSendSubmit();
	void	OnSubmitSucceed();
	void	OnDeliver();
	void	OnStatusReport();
	void	OnActiveTestResponse();
	void	OnActiveTest();
	void	OnCancelResponse();
	void	OnTerminate();
	void	OnConnectResponse();
	void	OnSubmitFailed();
	void	OnSubmitResponse();
	void	OnSubmiting();
	JobType						type;

protected:
	SMGPClient				& client;
	SMGPConnection		& connection;
	smgp_submit				submitMsg;
	smgp_deliver			deliverMsg;
	smgp_connect_resp	connectRespMsg;
	smgp_submit_deliver_resp submitRespMsg;
	int								nResult;

};

class CWorkerSmgp : public IWorker {
	virtual void ProcessJob( IJobDesc* pJobDesc );
};

/// SMGP客户端实现类
/** SP客户端实现,一个SMGPClient类可以创建和管理多个SMGPConnection类.用户开发短信网关程序只需要从CLIENT类派生即可.
*/
class SMGPClient 
{
public:
	/**@name Construction */
	//@{