smppconn.h

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

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

#ifndef _SMPP34_CONNECTION_H
#define _SMPP34_CONNECTION_H

#include <smal.h>
#include <common/util.h>
#include <list>
#include <smpp3/smpp_message.h>
#include <common/tcpsocket.h>
#include <smpp3/smppbase.h>
#include <common/threadpool.h>

class SMPPClient;

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

//##ModelId=46B5D42C02BF
class SMPPConnection : public CSmpp  
{
public:
/**@name Construction	*/
//@{
	/**构造函数
	 */
	//##ModelId=46B5D42C030B
	SMPPConnection(
		SMPPClient				& _client,					///< connection所属的client
		const char * _token,						///< connection的标识
		const char * _serverHost,				///< 网关地址
		const unsigned short & _serverPort,					///< 网关端口
		const ConnectionType & _connectionType,				///< 连接类型
		const char * _systemID,				///< 登录用户名
		const char * _password,				///< 登录口令
		const char * _systemType,				///< 接口类型
		const unsigned char	& _interfaceVersion,			///< 网关版本号
		const int & _nActivetestInterval,	///< 活动测试间隔
		BOOL sync = TRUE						///< 是否同步,直到连接建立
		);

	/**打印统计信息
	*/
	//##ModelId=46B5D42C0329
	virtual void DumpStatus();

	/**析构函数
	 */
	//##ModelId=46B5D42C0347
	virtual ~SMPPConnection();
	//@}

/**@name GetFunctions	*/
//@{
	/**得到连接所属的client 
	*/
	//##ModelId=46B5D42C0365
	SMPPClient & GetClient() const
	{		return client;	}

	/**得到连接标识 
	*/
	//##ModelId=46B5D42C036F
	const char * GetToken() const
	{		return token;		}

	/**得到短信中心地址 
	*/
	//##ModelId=46B5D42C0371
	const char * GetSmscHost() const
	{		return server_host;		}

	/**得到短信中心端口 
	*/
	//##ModelId=46B5D42C0379
	int GetSmscPort() const
	{		return (int)server_port;	}

	/**得到登录用户名 
	*/
	//##ModelId=46B5D42C037B
	const char * GetSystemID() const
	{		return system_id;	}

	/**得到登录口令 
	*/
	//##ModelId=46B5D42C0384
	const char * GetPassword() const
	{		return password;	}

	/**得到接口类型 
	*/
	//##ModelId=46B5D42C038E
	const char * GetSystemType() const
	{		return system_type;		}

	/**得到连接类型 
	*/
	//##ModelId=46B5D42C0390
	ConnectionType GetConnectionType() const
	{		return conntype;	}

	/** 得到系统版本号
	*/
	//##ModelId=46B5D42C0398
	int GetInterfacVersion() const
	{	return (int)interface_version;	}

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

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

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

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

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

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

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

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

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

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

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

	//@}

	/**@name SMPP Command Function */
	//@{
	/**发送SUBMIT消息 
	*/
	//##ModelId=46B5D42C03DE
	inline int Submit(
		PDU_SMPP_SUBMIT_SM & _message
	);

	//@}

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

	/**登录网关失败时调用 
	*/
	//##ModelId=46B5D42D0014
	virtual void OnLoginFailed(int errorCode);

	/**同网关连接断开时调用 
	*/
	//##ModelId=46B5D42D0028
	virtual void OnCleared();

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

	/**发送SUBMIT消息成功时调用 
	*/
	//##ModelId=46B5D42D003C
	virtual void OnSubmited(PDU_SMPP_SUBMIT_SM _message);

	/**发送SUBMIT消息失败时调用 
	*/
	//##ModelId=46B5D42D0046
	virtual void OnSubmitFailed(PDU_SMPP_SUBMIT_SM _message/*,	unsigned nResult*/);

	/**收到CONNECT_RESPONSE时调用 
	*/
	//##ModelId=46B5D42D0050
	virtual void OnReceivedConnectResponse(PDU_SMPP_BIND_RESP _message);

	/**收到Terminate消息时调用 
	*/
	//##ModelId=46B5D42D005B
	virtual void OnReceivedTerminate();

	/**收到SUBMIT_RESPONSE时调用 
	*/
	//##ModelId=46B5D42D0064
	virtual void OnReceivedSubmitResponse(PDU_SMPP_SUBMIT_SM_RESP _message);

	/**收到Deliver消息时调用 
	*/
	//##ModelId=46B5D42D006E
	virtual void OnReceivedDeliver(PDU_SMPP_DELIVER_SM _message);

	/**输出日志时调用
		格式化输出日志,默认是把内容//TRACE出来
	 */
	//##ModelId=46B5D42D0078
	virtual void OnLogWrite(const char * pchFmt, ...);
	//@}
	
	//##ModelId=46B5D42D008C
	BOOL						isOK;
	
	/**清除连接 
	*/
	//##ModelId=46B5D42D008D
	void Clear();

protected:

	/**初始化变量 
	*/
	//##ModelId=46B5D42D0096
	void Initialize();

	/**建立网关连接 
	*/
	//##ModelId=46B5D42D00B4
	int CreateConnection();

	/**连接并尝试登录网关 
	*/
	//##ModelId=46B5D42D00BE
	int Bind();

	/**断开连接 
	*/
	//##ModelId=46B5D42D00D2
	void Unbind();

	/**接收SMG方面的所有消息 
	*/
	//##ModelId=46B5D42D00E6
	inline int RecvSmscMsg(
		PDU_SMPP_SMSC_TO_ESME 	* message, 
		unsigned			long &	nResult
		);

	/**用于接收消息 
	*/
	//##ModelId=46B5D42D00FA
	static DWORD WINAPI RecvFunc(LPVOID pParam);

	//##ModelId=46B5D42D0104
	virtual DWORD RecvProc();

	private:
//protected:
	//##ModelId=46B5D42D0123
	SMPPClient		& client;				///< 所属client
	//##ModelId=46B5D42D0127
	char			token[MAX_PATH];					///< 连接ID(YYMMDDhhmmsslll)
	//##ModelId=46B5D42D012C
	char			server_host[MAX_PATH];			///< 网关地址
	//##ModelId=46B5D42D0136
	unsigned short	server_port;			///< 网关端口
	//##ModelId=46B5D42D0137
	unsigned char	interface_version;		///< 网关支持的最高版本号
	//##ModelId=46B5D42D0140
	char			system_id[MAX_PATH];				///< 网关登录用户名
	//##ModelId=46B5D42D0141
	char			password[MAX_PATH];				///< 网关登录口令
	//##ModelId=46B5D42D014B
	ConnectionType	conntype;				///< 网关连接类型
	//##ModelId=46B5D42D014F
	char		system_type[MAX_PATH];

	//##ModelId=46B5D42D0155
	TCPSocket		m_socket;				///< TCPSOCKET类
	//##ModelId=46B5D42D0159
	BOOL			m_fStop;				///< 停止标志.
	//##ModelId=46B5D42D015E
	BOOL			m_fLogined;				///< 是否成功登录
	//##ModelId=46B5D42D015F
	BOOL			m_fStarted;				///< 是否成功启动
	//##ModelId=46B5D42D0168
	BOOL			m_fBusy;				///< 是否正在发送消息

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

	//##ModelId=46B5D42D0187
	char		connectTime[MAX_PATH];			///< 成功连接网关的时间
	//##ModelId=46B5D42D0190
	char			loginTime[MAX_PATH];				///< 成功登录时间
	//##ModelId=46B5D42D0191
	char			disconnectTime[MAX_PATH];			///< 断开时间

	//##ModelId=46B5D42D019A
	long		submitCount;				///< 提交的SUBMIT消息数
	//##ModelId=46B5D42D019B
	long		submitSucceedCount;			///< SUBMIT发送成功消息数
	//##ModelId=46B5D42D01A4
	long		submitFailedCount;			///< SUBMIT发送失败消息数
	//##ModelId=46B5D42D01AE
	long		respSucceedCount;			///< 收到的submitresponse消息数
	//##ModelId=46B5D42D01AF
	long		respFailedCount;			///< 收到的submitresponse消息数
	//##ModelId=46B5D42D01B8
	long		deliverCount;				///< 收到的Deliver消息数
	//long						sreportCount;		///< 状态报告数
};

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

//##ModelId=46B5D42D01F4
class CJobSmpp : public IJobDesc {
public:
	//##ModelId=46B5D42D01F6
	CJobSmpp(SMPPClient	& _client, SMPPConnection	& _connection, JobType _type);

	//##ModelId=46B5D42D0201
	CJobSmpp(SMPPClient	& _client, SMPPConnection	& _connection, JobType _type, PDU_SMPP_SUBMIT_SM_RESP _message);