cmppconn.h

CMPP 客户端接口API 符合中国移动CMPP3.0 2.0 适用于SP端客户端的开发

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

#ifndef _CMPP3_CONNECTION_H
#define _CMPP3_CONNECTION_H

#include <smal.h>
#include <common/util.h>
#include <list>
#include <cmpp3/cmpp_message.h>
#include <common/tcpsocket.h>
#include <cmpp3/cmppbase.h>
#include <common/threadpool.h>

#pragma warning(disable : 4018)
#pragma warning(disable : 4100)

///**Global functions
//*/
//inline CString GetSubStr(void* pchBuf, int nLen);
//CString GetDateTime();
//unsigned _int64 hton64(unsigned _int64 ui64Src);

/**连接类型
*/
enum ConnectionType {
	e_RecvOnly,
	e_SendOnly,
	e_SendAndRecv,
	NumOfConnectionType
};

class CMPPClient;

///////////////////////////////////////////////////////////////////////////////
//

class CMPPConnection : public CCmpp  
{
public:
/**@name Construction	*/
//@{
	/**构造函数
	 */
	CMPPConnection(
		CMPPClient				& _client,							///< connection所属的client
		CString							_token,								///< connection的标识
		const CString			& _smghost,							///< 网关地址
		const unsigned short & _smgport,					///< 网关端口
		const unsigned char	& _smgversion,				///< 网关版本号
		const CString			& _username,						///< 登录用户名
		const CString			& _password,						///< 登录口令
		const CString			& _icpid,								///< 企业代码
		const ConnectionType & _conntype,					///< 连接类型
		const BOOL				& _isAsiaInfoSmg,				///< 是否是亚信网关
		const int					& _nActivetestInterval,	///< 活动测试间隔
		BOOL								sync = TRUE						///< 是否同步,直到连接建立
		);

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

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

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

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

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

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

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

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

	/**得到企业代码(ICPID) 
	*/
	CString GetICPID() const
	{		return icpid;		}

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

	/**是否是亚信网关 
	*/
	BOOL IsAisaInfoSmg() const
	{	return isAsiaInfoSmg;	}

	/**得到发送的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 CMPP Command Function */
	//@{
	/**发送SUBMIT消息 
	*/
	inline int Submit(
		cmpp_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(cmpp_submit _message);

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

	/**发送SUBMIT消息失败时调用 
	*/
	virtual void OnSubmitFailed(cmpp_submit _message/*,	unsigned nResult*/);

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

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

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

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

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

	/**收到QueryResponse时调用 
	*/
	virtual void OnReceivedQueryResponse(cmpp_query_resp _message);

	/**收到CancelResponse时调用 
	*/
	virtual void OnReceivedCancelResponse(cmpp_cancel_resp _message);

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

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

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

protected:

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

	/**建立网关连接 
	*/
	int CreateConnection();

	/**连接并尝试登录网关 
	*/
	int Connect();

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

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

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

	virtual DWORD RecvProc();

	private:
//protected:
	CMPPClient		& client;					///< 所属client
	CString					token;					///< 连接ID(YYMMDDhhmmsslll)
	CString					smghost;				///< 网关地址
	unsigned short	smgport;				///< 网关端口
	unsigned char		smgversion;			///< 网关支持的最高版本号
	CString					username;				///< 网关登录用户名
	CString					password;				///< 网关登录口令
	CString					icpid;					///< 企业代码
	ConnectionType	conntype;				///< 网关连接类型
	BOOL						isAsiaInfoSmg;	///< 是否是亚信网关

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

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

	CString					connectTime;		///< 成功连接网关的时间
	CString					loginTime;			///< 成功登录时间
	CString					disconnectTime;	///< 断开时间

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

///////////////////////////////////////////////////////////////////////////////
//

class CJob : public IJobDesc {
public:
	CJob(CMPPClient	& _client, CMPPConnection	& _connection, JobType _type);

	CJob(CMPPClient	& _client, CMPPConnection	& _connection, JobType _type, cmpp_cancel_resp _message);

	CJob(CMPPClient	& _client, CMPPConnection	& _connection, JobType _type, cmpp_submit_deliver_resp _message);

	CJob(CMPPClient	& _client, CMPPConnection	& _connection, JobType _type, cmpp_query_resp _message);

	CJob(CMPPClient	& _client, CMPPConnection	& _connection, JobType _type, cmpp_deliver _message);

	CJob(CMPPClient	& _client, CMPPConnection	& _connection, JobType _type, cmpp_submit _message, /*int*/PINTResult nResult = 0);

	~CJob();

	void	OnSendSubmit();
	void	OnSubmitSucceed();
	void	OnDeliver();
	void	OnStatusReport();
	void	OnActiveTestResponse();
	void	OnActiveTest();
	void	OnCancelResponse();
	void	OnQueryResponse();
	void	OnTerminate();
	void	OnConnectResponse();