event.h

linux-下的fetion-0.8.1。包括所有源代码

/**
* \file event.h
* \author dengdd <[e-mail]>
* \date 2008/1/1
* 
* This file includes fetion event definitions
* by libfetion.
*
\verbatim

Copyright (C) 2008 dengdd.

All rights reserved by dengdd.

This file is part of libfetion, a cross-operating-system library to operate China mobile's fetion IM.

\endverbatim
*/

#ifndef _LIBFETION_EVENT_H_
#define _LIBFETION_EVENT_H_

#ifdef __cplusplus 
extern "C" { 
#endif 

/**
 * \defgroup events LibFetion Event Define
 * @{
 * \sa	cb_func
 */


/**
* \def FX_EVENT_BASE
* \brief the fetion event base value
* 
*/
#define FX_EVENT_BASE   0x0000

/**
* \def FX_EVENT_SPARE
* \brief the spare fetion event base value
* 
*/
#define FX_EVENT_SPARE   0x00F0


	
/**
 * \defgroup login_event Login Event
 * @{
 */

/**
* \def FX_LOGIN_CONNECTING
* \brief login state is connecting service. 
* 
*/
#define FX_LOGIN_CONNECTING      FX_EVENT_BASE + 0x0001

/**
* \def FX_LOGIN_WAIT_AUTH
* \brief login state is waiting service auth the password and id.  
* 
*/
#define FX_LOGIN_WAIT_AUTH       FX_EVENT_BASE + 0x0002//等待认证

/**
* \def FX_LOGIN_AUTH_OK
* \brief login state is service auth ok.  
* 
*/
#define FX_LOGIN_AUTH_OK         FX_EVENT_BASE + 0x0003//认证成功

/**
* \def FX_LOGIN_FAIL
* \brief login state is login fail, password is invalidity.  
* 
*/
#define FX_LOGIN_FAIL            FX_EVENT_BASE + 0x0004//登陆失败

/**
* \def FX_LOGIN_NETWORK_ERROR
* \brief login state is login fail of network error.  
* 
*/
#define FX_LOGIN_NETWORK_ERROR   FX_EVENT_BASE + 0x0005//网络错误

/**
* \def FX_LOGIN_UNKOWN_ERROR
* \brief login state is login fail of unkown error.  
* 
*/
#define FX_LOGIN_UNKOWN_ERROR    FX_EVENT_BASE + 0x0006//未知错误

/**
* \def FX_LOGIN_UNKOWN_USR
* \brief login state is login fail of the user id is invalidity.  
* 
*/
#define FX_LOGIN_UNKOWN_USR      FX_EVENT_BASE + 0x0007//用户不存在  

/**
* \def FX_LOGIN_GCL_GETTING
* \brief login state is getting the connection list.  
* 
*/
#define FX_LOGIN_GCL_GETTING     FX_EVENT_BASE + 0x0008//正在获取联系人列表

/**
* \def FX_LOGIN_GCL_OK
* \brief login state is get the connection list ok .  
* 
*/
#define FX_LOGIN_GCL_OK          FX_EVENT_BASE + 0x0009//获取联系人列表成功

/**
* \def FX_LOGIN_GCL_FAIL
* \brief login state is login fail of  getting the connection list fail.  
* 
*/
#define FX_LOGIN_GCL_FAIL        FX_EVENT_BASE + 0x000A//获取联系人列表失败

/**
* \def FX_LOGIN_GP_GETTING
* \brief login state is getting the presence info.  
* 
*/
#define FX_LOGIN_GP_GETTING      FX_EVENT_BASE + 0x000B//正在获取联系人状态

/**
* \def FX_LOGIN_GP_OK
* \brief login state is getting the presence info ok .  
* 
*/
#define FX_LOGIN_GP_OK           FX_EVENT_BASE + 0x000C//获取联系人状态成功

/**
* \def FX_LOGIN_GP_FAIL
* \brief login state is login fail of getting the presence info fail.  
* 
*/
#define FX_LOGIN_GP_FAIL         FX_EVENT_BASE + 0x000D//获取联系人状态失败

/**
* \def FX_LOGIN_OK 
* \brief login state is login ok.  
* 
*/
#define FX_LOGIN_OK              FX_EVENT_BASE + 0x000E//登陆成功

/**
* \def FX_LOGIN_TIMEOUT
* \brief login state is login fail of login timeout.  
* 
*/
#define FX_LOGIN_TIMEOUT         FX_EVENT_BASE + 0x000F//登陆超时 ? need it.. have a UNKOWN_ERROR

/**
* \def FX_LOGIN_URI_ERROR
* \brief login state is login fail of get the user's uri fail.  
* 
*/
#define FX_LOGIN_URI_ERROR       FX_EVENT_SPARE  + 0x0001

/**
* \def FX_LOGIN_SERVER_ERROR
* \brief login state is login fail of your login error fetion server.  
* 
*/
#define FX_LOGIN_SERVER_ERROR       FX_EVENT_SPARE  + 0x0002

/**
* \def FX_LOGIN_SERVER_REFUSE
* \brief login state is fetion server refuse, you should relogin again.  
* 
*/
#define FX_LOGIN_SERVER_REFUSE       FX_EVENT_SPARE  + 0x0003

/** @} end of login_event */

	
/**
 * \defgroup recv_msg_event Receive Message Event
 * @{
 */


/**
* \def FX_NEW_MESSAGE
* \brief a new message received
*
* This message is posted when the client receive a new message..
 *\code
 * case FX_NEW_MESSAGE:
 * long who = (long)lParam;
 *
 * printf("the usr [%ld] send a message to you \n, ", who );
 *
 * \endcode
 *
 * \param lParam The message sender.
 * 
 * \sa fx_get_msg Fetion_MSG
*/
#define FX_NEW_MESSAGE            FX_EVENT_BASE + 0x0010

/**
* \def FX_NEW_QUN_MESSAGE
* \brief a new qun message received
*
* This message is posted when the client receive a new message..
 *\code
 * case FX_NEW_QUN_MESSAGE:
 * long qun_id = (long)lParam;
 *
 * printf("the qun [%ld] have a new message \n, ", qun_id );
 *
 * \endcode
 *
 * \param lParam The message sender.
* 
  * \sa fx_get_msg Fetion_MSG
*/
#define FX_NEW_QUN_MESSAGE            FX_EVENT_BASE + 0x0011

/**
* \def FX_SYS_MESSAGE
* \brief a system message received
*
* This message is posted when the client receive a new message..
 *\code
 * case FX_SYS_MESSAGE:
 * long sys_id = (long)lParam;
 *
 * \endcode
 *
 * \param lParam The message sender.
* 
  * \sa fx_get_msg Fetion_MSG
*/
#define FX_SYS_MESSAGE            FX_EVENT_BASE + 0x0012

/**
* \def FX_UNDGE_MESSAGE
* \brief a undge message received
*
* This message is posted when the client receive a undge message..
 *
 * \param lParam The message sender.
* 
*/
#define FX_UNDGE_MESSAGE           FX_EVENT_BASE + 0x0013
/** @} end of recv_msg_event */


/**
 * \defgroup sendsms_event Send SMS Event
 * @{
 */
/**
* \def FX_SMS_OK
* \brief send sms state is ok.  
* 
*/
#define FX_SMS_OK                FX_EVENT_BASE + 0x0020//发送短消息成功

/**
* \def FX_SMS_FAIL
* \brief send sms state is fail.  
* 
*/
#define FX_SMS_FAIL              FX_EVENT_BASE + 0x0021//发送短消息失败（服务器）

/**
* \def FX_SMS_TIMEOUT
* \brief send sms state is fail of time out.  
* 
*/
#define FX_SMS_TIMEOUT           FX_EVENT_BASE + 0x0022//发送短消息超时

/**
* \def FX_SMS_UNKOWN_ERROR
* \brief send sms state is fail of unkown error.  
* 
*/
#define FX_SMS_UNKOWN_ERROR      FX_EVENT_BASE + 0x0023//发送短消息未知错误. this message may be noever happened.

/**
* \def FX_SMS_FAIL_LIMIT
* \brief send sms state is fail of unkown error.  
* 
*/
#define  FX_SMS_FAIL_LIMIT      FX_EVENT_BASE + 0x0024//sms-daily-limit
/** @} end of sendsms_event */

/**
 * \defgroup dialog_event Dialog Event
 * @{
 */

/**
* \def FX_DIA_BG_TRYING
* \brief a dialog begin ok 
*
*/
#define FX_DIA_BG_TRYING         FX_EVENT_BASE + 0x0030//begin dialog trying.... 

/**
* \def FX_DIA_BG_OK
* \brief a dialog begin ok 
*
*/
#define FX_DIA_BG_OK             FX_EVENT_BASE + 0x0031//begin dialog ok

/**
* \def FX_DIA_BG_FAIL
* \brief a dialog begin fail 
*
*/
#define FX_DIA_BG_FAIL           FX_EVENT_BASE + 0x0032//begin dialog fail

/**
* \def FX_DIA_BG_FAIL
* \brief a dialog begin fail 
*
*/
#define FX_DIA_BG_TIMEOUT        FX_EVENT_BASE + 0x0033//begin dialog timeout


/**
* \def FX_DIA_SEND_OK
* \brief a dialog send message ok
*
*/
#define FX_DIA_SEND_OK           FX_EVENT_BASE + 0x0032//发送消息成功

/**
* \def FX_DIA_SEND_FAIL
* \brief a dialog send message fail
*
*/
#define FX_DIA_SEND_FAIL         FX_EVENT_BASE + 0x0033//发送消息失败


/**
* \def FX_DIA_SEND_TIMEOUT
* \brief a dialog send message timeout
*
*/
#define FX_DIA_SEND_TIMEOUT      FX_EVENT_BASE + 0x0034//发送消息失败


/**
* \def FX_DIA_UNKOWN_ERROR
* \brief a dialog unkown error message
*
*/
#define FX_DIA_UNKOWN_ERROR      FX_EVENT_BASE + 0x0035//发送消息未知错误. this message may be noever happened.

/** @} end of dialog_event */


/**
 * \defgroup online_event USER STATUS Event
 * @{
 */

/**
* \def FX_STATUS_UNSET
* \brief user status is unset.
*
*/
#define FX_STATUS_UNSET           FX_EVENT_BASE + 0x0040   //未设置

//#define FX_STATUS_OFFLINE         FX_EVENT_BASE + 0x0041   //离线

/**
* \def FX_STATUS_ONLINE
* \brief user status is online.
*
*/
#define FX_STATUS_ONLINE          FX_EVENT_BASE + 0x0042   //在线

/**
* \def FX_STATUS_BUSY
* \brief user status is busy.
*
*/
#define FX_STATUS_BUSY            FX_EVENT_BASE + 0x0043   //忙碌

/**
* \def FX_STATUS_OFFLINE
* \brief user status is offline.
*
*/
#define FX_STATUS_OFFLINE        FX_EVENT_BASE + 0x0044    //隐身  

/**
* \def FX_STATUS_AWAY
* \brief user status is away.
*
*/
#define FX_STATUS_AWAY            FX_EVENT_BASE + 0x0045   //马上回来

/**
* \def FX_STATUS_MEETING
* \brief user status is meeting.
*
*/
#define FX_STATUS_MEETING         FX_EVENT_BASE + 0x0046   //会议中

/**
* \def FX_STATUS_PHONE
* \brief user status is phone.
*
*/
#define FX_STATUS_PHONE           FX_EVENT_BASE + 0x0047   //电话中

/**
* \def FX_STATUS_DINNER
* \brief user status is dinner.
*
*/
#define FX_STATUS_DINNER          FX_EVENT_BASE + 0x0048   //外出用餐

/**
* \def FX_STATUS_EXTENDED_AWAY 
* \brief user status is extended away.
*
*/
#define FX_STATUS_EXTENDED_AWAY   FX_EVENT_BASE + 0x0049   //离开 

/**
* \def FX_STATUS_NUM_PRIMITIVES
* \brief user status is primitives num.
*
*/
#define FX_STATUS_NUM_PRIMITIVES  FX_EVENT_BASE + 0x004A   //自定义