行情客戶端系統(tǒng)

1、中國金融期貨交易所技術(shù)文檔行情客戶端應(yīng)用程序接口版權(quán)所有中國金融期貨交易所 第 PAGE III頁 行情客戶端應(yīng)用程序接口2006年10月19日文件版本號修正日期備 注V1.012007-03-28首次發(fā)布V1.022009-08-07修改示例程序，添加Join等待目錄TOC o 1-3 h z u HYPERLINK l _Toc161567872 第1章介紹 PAGEREF _Toc161567872 h 1 HYPERLINK l _Toc161567873 第2章體系結(jié)構(gòu) PAGEREF _Toc161567873 h 1 HYPERLINK l _Toc161567874 2.1通訊

2、模式 PAGEREF _Toc161567874 h 1 HYPERLINK l _Toc161567875 2.2數(shù)據(jù)流 PAGEREF _Toc161567875 h 2 HYPERLINK l _Toc161567876 第3章運(yùn)行模式 PAGEREF _Toc161567876 h 1 HYPERLINK l _Toc161567877 3.1工作線程 PAGEREF _Toc161567877 h 1 HYPERLINK l _Toc161567878 3.2本地文件 PAGEREF _Toc161567878 h 1 HYPERLINK l _Toc161567879 第4章開發(fā)接

3、口 PAGEREF _Toc161567879 h 1 HYPERLINK l _Toc161567880 4.1CFfexFtdcMduserSpi 接口 PAGEREF _Toc161567880 h 1 HYPERLINK l _Toc161567881 4.1.1OnFrontConnected 方法 PAGEREF _Toc161567881 h 1 HYPERLINK l _Toc161567882 4.1.2OnFrontDisconnected 方法 PAGEREF _Toc161567882 h 1 HYPERLINK l _Toc161567883 4.1.3OnHeart

4、BeatWarning方法 PAGEREF _Toc161567883 h 2 HYPERLINK l _Toc161567884 4.1.4OnRspUserLogin方法 PAGEREF _Toc161567884 h 2 HYPERLINK l _Toc161567885 4.1.5OnRspUserLogout 方法 PAGEREF _Toc161567885 h 3 HYPERLINK l _Toc161567886 4.1.6OnRtnDepthMarketData方法 PAGEREF _Toc161567886 h 4 HYPERLINK l _Toc161567887 4.1.

5、7OnRspError 方法 PAGEREF _Toc161567887 h 6 HYPERLINK l _Toc161567888 4.2CFfexFtdcMduserApi接口 PAGEREF _Toc161567888 h 7 HYPERLINK l _Toc161567889 4.2.1CreateFtdcMduserApi方法 PAGEREF _Toc161567889 h 7 HYPERLINK l _Toc161567890 4.2.2Release 方法 PAGEREF _Toc161567890 h 7 HYPERLINK l _Toc161567891 4.2.3Init

6、方法 PAGEREF _Toc161567891 h 8 HYPERLINK l _Toc161567892 4.2.4Join 方法 PAGEREF _Toc161567892 h 8 HYPERLINK l _Toc161567893 4.2.5GetTradingDay方法 PAGEREF _Toc161567893 h 8 HYPERLINK l _Toc161567894 4.2.6RegisterSpi 方法 PAGEREF _Toc161567894 h 8 HYPERLINK l _Toc161567895 4.2.7RegisterFront 方法 PAGEREF _Toc1

7、61567895 h 9 HYPERLINK l _Toc161567896 4.2.8SubscribeMarketDataTopic方法 PAGEREF _Toc161567896 h 9 HYPERLINK l _Toc161567897 4.2.9ReqUserLogin 方法 PAGEREF _Toc161567897 h 9 HYPERLINK l _Toc161567898 4.2.10ReqUserLogout 方法 PAGEREF _Toc161567898 h 10 HYPERLINK l _Toc161567899 第5章開發(fā)示例 PAGEREF _Toc16156789

8、9 h 12中國金融期貨交易所技術(shù)文檔行情客戶端應(yīng)用程序接口版權(quán)所有中國金融期貨交易所 第16頁，共29頁 介紹行情客戶端系統(tǒng)API是一個基于C+的類庫, 通過使用和擴(kuò)展類庫提供的接口來實(shí)現(xiàn)行情數(shù)據(jù)的接收。該類庫包含以下5個文件：文件名版本文件大小文件描述CFfexFtdcMduserApi.hV1.0211,441 字節(jié)行情接口頭文件CFfexFtdcUserApiStruct.hV1.0240,238字節(jié)定義了UserAPI所需的一系列數(shù)據(jù)類型的頭文件CffexFtdcUserApiDataType.hV1.02142,601 字節(jié)定義了一系列業(yè)務(wù)相關(guān)的數(shù)據(jù)結(jié)構(gòu)的頭文件CFfexmduse

9、rapi.dllV1.02983,121 字節(jié)動態(tài)鏈接庫二進(jìn)制文件Cffexmduserapi.libV1.023,530 字節(jié)導(dǎo)入庫文件支持MS VC 6.0，MS VC.NET 2003編譯器。需要打開多線程編譯選項(xiàng)/MT。體系結(jié)構(gòu)行情API使用建立在TCP協(xié)議之上FTD協(xié)議與交易所的行情發(fā)布服務(wù)器進(jìn)行通訊。行情發(fā)布服務(wù)器負(fù)責(zé)行情信息的產(chǎn)生與發(fā)布，但不參與交易過程。參與交易需要使用另外的“交易員API”。通訊模式FTD協(xié)議中的所有通訊都基于某個通訊模式。通訊模式實(shí)際上就是通訊雙方協(xié)同工作的方式。行情發(fā)布涉及的通訊模式共有二種：對話通訊模式廣播通訊模式對話通訊模式是指由會員端主動發(fā)起的通訊請

10、求。該請求被交易所端接收和處理，并給予響應(yīng)。例如登入與登出。這種通訊模式與普通的客戶/服務(wù)器模式相同。廣播通訊模式是指交易所端主動，向市場中的相關(guān)會員發(fā)出相同的信息。例如行情等。通訊模式和網(wǎng)絡(luò)的連接不一定存在簡單的一對一的關(guān)系。也就是說，一個網(wǎng)絡(luò)連接中可能傳送多種不同通訊模式的報(bào)文，一種通訊模式的報(bào)文也可以在多個不同的連接中傳送。無論哪種通訊模式，其通訊過程都如圖1所示：各通訊模式的工作過程數(shù)據(jù)流行情發(fā)布支持對話通訊模式、廣播通訊模式：對話通訊模式下支持對話數(shù)據(jù)流：對話數(shù)據(jù)流是一個雙向數(shù)據(jù)流，會員系統(tǒng)發(fā)送請求，行情發(fā)布系統(tǒng)反饋應(yīng)答。交易系統(tǒng)不維護(hù)對話流的狀態(tài)。系統(tǒng)故障時，對話數(shù)據(jù)流會重置，通訊

11、途中的數(shù)據(jù)可能會丟失。廣播通訊模式下支持行情數(shù)據(jù)流：行情數(shù)據(jù)流是一個單向數(shù)據(jù)流，由行情發(fā)布系統(tǒng)發(fā)向會員系統(tǒng)，用于發(fā)送行情信息；行情流是一個可靠的數(shù)據(jù)流，行情系統(tǒng)維護(hù)整個系統(tǒng)的行情流，在一個交易日內(nèi)，會員系統(tǒng)斷線恢復(fù)連接時，可以請求行情系統(tǒng)發(fā)送指定序號之后的行情流數(shù)據(jù)。行情服務(wù)所提供的行情內(nèi)容是按照主題組織的。每個主題包括一組合約的行情，還包括了行情發(fā)布內(nèi)容和發(fā)布方式，包括行情深度、采樣頻率、延遲時間等。交易所會公布各行情主題的具體內(nèi)容，并設(shè)定每個行情用戶所能訂閱的行情主題。每個行情主題對應(yīng)著一個行情流。要獲得行情通知，客戶端必需在連接行情服務(wù)器時，訂閱一個或多個行情發(fā)布主題。運(yùn)行模式工作線程交

12、易員客戶端應(yīng)用程序至少由兩個線程組成，一個是應(yīng)用程序主線程，一個是交易員API工作線程。應(yīng)用程序與交易系統(tǒng)的通訊是由API工作線程驅(qū)動的。CFfexFtdcMduserApi提供的接口是線程安全的，可以有多個應(yīng)用程序線程同時發(fā)出請求。CFfexFtdcMduserSpi提供的接口回調(diào)是由API工作線程驅(qū)動，如果重載的某個回調(diào)函數(shù)阻塞，則等于阻塞了API工作線程，API與交易系統(tǒng)的通訊會停止。因此，在CFfexFtdcTraderSpi派生類的回調(diào)函數(shù)中，通常應(yīng)迅速返回，可以利用將數(shù)據(jù)放入緩沖區(qū)或通過Windows的消息機(jī)制來實(shí)現(xiàn)。本地文件交易員API在運(yùn)行過程中，會將一些數(shù)據(jù)寫入本地文件中。調(diào)

13、用CreateFtdcMduserApi函數(shù)，可以傳遞一個參數(shù)，指明存貯本地文件的路徑。該路徑必須在運(yùn)行前已創(chuàng)建好。本地文件的擴(kuò)展名都是”.con”。開發(fā)接口行情客戶端系統(tǒng)API提供了二個接口，分別為CFfexFtdcMduserApi和CFfexFtdcMduserSpi。CFfexFtdcMduserSpi 接口CFfexFtdcMduserSpi實(shí)現(xiàn)了事件通知接口。用戶必需派生CFfexFtdcMduserSpi接口，編寫事件處理方法來處理感興趣的事件。OnFrontConnected 方法當(dāng)客戶端與行情發(fā)布服務(wù)器建立起通信連接時（還未登錄前），該方法被調(diào)用。函數(shù)原型：void OnFr

14、ontConnected()；本方法在完成初始化后調(diào)用，可以在其中完成用戶登錄任務(wù)。OnFrontDisconnected 方法當(dāng)客戶端與交易后臺通信連接斷開時，該方法被調(diào)用。當(dāng)發(fā)生這個情況后，API會自動重新連接，客戶端可不做處理。函數(shù)原型：void OnFrontDisconnected (int nReason)；參數(shù)：nReason：連接斷開原因0 x1001 網(wǎng)絡(luò)讀失敗0 x1002 網(wǎng)絡(luò)寫失敗0 x2001 接收心跳超時0 x2002 發(fā)送心跳失敗0 x2003 收到錯誤報(bào)文OnHeartBeatWarning方法心跳超時警告。當(dāng)長時間未收到報(bào)文時，該方法被調(diào)用。函數(shù)原型：void

15、 OnHeartBeatWarning(int nTimeLapse)；參數(shù)：nTimeLapse：距離上次接收報(bào)文的時間OnRspUserLogin方法當(dāng)客戶端發(fā)出登錄請求之后，該方法會被調(diào)用，通知客戶端登錄是否成功。函數(shù)原型：void OnRspUserLogin(CFfexFtdcRspUserLoginField *pRspUserLogin, CFfexFtdcRspInfoField *pRspInfo, int nRequestID, bool bIsLast)；參數(shù)：pRspUserLogin：返回用戶登錄信息的地址。用戶登錄信息結(jié)構(gòu)：struct CFfexFtdcRspUs

16、erLoginField/交易日TFfexFtdcDateTypeTradingDay;/登錄成功時間TFfexFtdcTimeTypeLoginTime;/最大本地報(bào)單號TFfexFtdcOrderLocalIDTypeMaxOrderLocalID;/交易用戶代碼TFfexFtdcUserIDTypeUserID;/會員代碼TFfexFtdcParticipantIDTypeParticipantID;pRspInfo：返回用戶響應(yīng)信息的地址。特別注意在有連續(xù)的成功的響應(yīng)數(shù)據(jù)時，中間有可能返回NULL，但第一次不會，以下同。錯誤代碼為0時，表示操作成功，以下同。響應(yīng)信息結(jié)構(gòu)：struct

17、CFfexFtdcRspInfoField/錯誤代碼TFfexFtdcErrorIDTypeErrorID;/錯誤信息TFfexFtdcErrorMsgTypeErrorMsg;nRequestID：返回用戶登錄請求的ID，該ID由用戶在登錄時指定。bIsLast：指示該次返回是否為針對nRequestID的最后一次返回。OnRspUserLogout 方法當(dāng)客戶端發(fā)出登出請求之后，該方法會被調(diào)用，通知客戶端登出是否成功。函數(shù)原型：void OnRspUserLogout(CFfexFtdcRspUserLogoutField *pRspUserLogout, CFfexFtdcRspInfo

18、Field *pRspInfo, int nRequestID, bool bIsLast)；參數(shù)：pRspUserLogout：返回用戶登出信息的地址。用戶登出信息結(jié)構(gòu)：struct CFfexFtdcRspUserLogoutField/交易用戶代碼TFfexFtdcUserIDTypeUserID;/會員代碼TFfexFtdcParticipantIDTypeParticipantID;pRspInfo：返回用戶響應(yīng)信息的地址。響應(yīng)信息結(jié)構(gòu)：struct CFfexFtdcRspInfoField/錯誤代碼TFfexFtdcErrorIDTypeErrorID;/錯誤信息TFfexFtd

19、cErrorMsgTypeErrorMsg;nRequestID：返回用戶登出請求的ID，該ID由用戶在登出時指定。bIsLast：指示該次返回是否為針對nRequestID的最后一次返回。OnRtnDepthMarketData方法行情通知，行情服務(wù)器會主動通知客戶端。函數(shù)原型：void OnRtnDepthMarketData(CFfexFtdcDepthMarketDataField *pDepthMarketData)；參數(shù)：pDepthMarketData：返回市場行情信息的地址。深度市場行情信息結(jié)構(gòu)：struct CFfexFtdcDepthMarketDataField/交易日T

20、FfexFtdcDateTypeTradingDay;/結(jié)算組代碼TFfexFtdcSettlementGroupIDTypeSettlementGroupID;/結(jié)算編號TFfexFtdcSettlementIDTypeSettlementID;/最新價TFfexFtdcPriceTypeLastPrice;/昨結(jié)算TFfexFtdcPriceTypePreSettlementPrice;/昨收盤TFfexFtdcPriceTypePreClosePrice;/昨持倉量TFfexFtdcLargeVolumeTypePreOpenInterest;/今開盤TFfexFtdcPriceType

21、OpenPrice;/最高價TFfexFtdcPriceTypeHighestPrice;/最低價TFfexFtdcPriceTypeLowestPrice;/數(shù)量TFfexFtdcVolumeTypeVolume;/成交金額TFfexFtdcMoneyTypeTurnover;/持倉量TFfexFtdcLargeVolumeTypeOpenInterest;/今收盤TFfexFtdcPriceTypeClosePrice;/今結(jié)算TFfexFtdcPriceTypeSettlementPrice;/漲停板價TFfexFtdcPriceTypeUpperLimitPrice;/跌停板價TFfe

22、xFtdcPriceTypeLowerLimitPrice;/昨虛實(shí)度TFfexFtdcRatioTypePreDelta;/今虛實(shí)度TFfexFtdcRatioTypeCurrDelta;/最后修改時間TFfexFtdcTimeTypeUpdateTime;/最后修改毫秒TFfexFtdcMillisecTypeUpdateMillisec;/合約代碼TFfexFtdcInstrumentIDTypeInstrumentID;/申買價一TFfexFtdcPriceTypeBidPrice1;/申買量一TFfexFtdcVolumeTypeBidVolume1;/申賣價一TFfexFtdcPr

23、iceTypeAskPrice1;/申賣量一TFfexFtdcVolumeTypeAskVolume1;/申買價二TFfexFtdcPriceTypeBidPrice2;/申買量二TFfexFtdcVolumeTypeBidVolume2;/申賣價二TFfexFtdcPriceTypeAskPrice2;/申賣量二TFfexFtdcVolumeTypeAskVolume2;/申買價三TFfexFtdcPriceTypeBidPrice3;/申買量三TFfexFtdcVolumeTypeBidVolume3;/申賣價三TFfexFtdcPriceTypeAskPrice3;/申賣量三TFfexF

24、tdcVolumeTypeAskVolume3;/申買價四TFfexFtdcPriceTypeBidPrice4;/申買量四TFfexFtdcVolumeTypeBidVolume4;/申賣價四TFfexFtdcPriceTypeAskPrice4;/申賣量四TFfexFtdcVolumeTypeAskVolume4;/申買價五TFfexFtdcPriceTypeBidPrice5;/申買量五TFfexFtdcVolumeTypeBidVolume5;/申賣價五TFfexFtdcPriceTypeAskPrice5;/申賣量五TFfexFtdcVolumeTypeAskVolume5;OnRs

25、pError 方法針對用戶請求的出錯通知。函數(shù)原型：void OnRspError(CFfexFtdcRspInfoField *pRspInfo, int nRequestID, bool bIsLast)參數(shù)：pRspInfo：返回用戶響應(yīng)信息的地址。響應(yīng)信息結(jié)構(gòu)：struct CFfexFtdcRspInfoField/錯誤代碼TFfexFtdcErrorIDTypeErrorID;/錯誤信息TFfexFtdcErrorMsgTypeErrorMsg;nRequestID：返回用戶登出請求的ID，該ID由用戶在登出時指定。bIsLast：指示該次返回是否為針對nRequestID的最后一

26、次返回。CFfexFtdcMduserApi接口CFfexFtdcMduserApi接口提供給客戶登陸、登出行情查詢服務(wù)器，進(jìn)行行情查詢等功能。CreateFtdcMduserApi方法產(chǎn)生一個CFfexFtdcMduserApi的一個實(shí)例，不能通過new來產(chǎn)生。函數(shù)原型：static CFfexFtdcMduserApi *CreateFtdcMduserApi(const char *pszFlowPath = );參數(shù)：pszFlowPath：常量字符指針，用于指定一個文件目錄來存貯行情服務(wù)發(fā)布消息的狀態(tài)。 默認(rèn)值代表當(dāng)前目錄。返回值：返回一個指向CFfexFtdcMduserApi實(shí)例

27、的指針。Release 方法釋放一個CFfexFtdcMduserApi實(shí)例。函數(shù)原型：void Release()；Init 方法使客戶端開始與行情發(fā)布服務(wù)器建立連接，連接成功后可以進(jìn)行登陸。函數(shù)原型：void Init()；Join 方法客戶端等待一個接口實(shí)例線程的結(jié)束。函數(shù)原型：void Join()；GetTradingDay方法獲得當(dāng)前交易日。只有當(dāng)與服務(wù)器連接建立后才會取到正確的值。函數(shù)原型：const char *GetTradingDay()；返回值：返回一個指向日期信息字符串的常量指針。RegisterSpi 方法注冊一個派生自CFfexFtdcMduserSpi接口類的實(shí)例

28、，該實(shí)例將完成事件處理。函數(shù)原型：void RegisterSpi(CFfexFtdcMduserSpi *pSpi) ;參數(shù)：pSpi：實(shí)現(xiàn)了CFfexFtdcMduserSpi接口的實(shí)例指針。RegisterFront 方法設(shè)置行情發(fā)布服務(wù)器的地址。函數(shù)原型：void RegisterFront(char *pszFrontAddress);參數(shù)：pszFrontAddress：指向后臺服務(wù)器地址的指針。服務(wù)器地址的格式為：“protocol:/ipaddress:port”，如：”tcp:/:17001”。 “tcp”代表傳輸協(xié)議，“”代表服務(wù)器地址。

29、”17001”代表服務(wù)器端口號。SubscribeMarketDataTopic方法客戶端訂閱自己需要的行情。訂閱后行情服務(wù)器會自動發(fā)出行情通知給客戶端。函數(shù)原型：void SubscribeMarketDataTopic(int nTopicID, TE_RESUME_TYPE nResumeType)；參數(shù)：nTopicID：代表深度行情的主題，由交易所公布。nResumeType：市場行情重傳方式 TERT_RESTART:從本交易日開始重傳 TERT_RESUME:從上次收到的續(xù)傳 TERT_QUICK:先傳送當(dāng)前行情快照,再傳送登錄后市場行情的內(nèi)容ReqUserLogin 方法用戶發(fā)

30、出登陸請求。函數(shù)原型：int ReqUserLogin(CFfexFtdcReqUserLoginField *pReqUserLoginField, int nRequestID)；參數(shù)：pReqUserLoginField：指向用戶登錄請求結(jié)構(gòu)的地址。用戶登錄請求結(jié)構(gòu)：struct CFfexFtdcReqUserLoginField/交易日TFfexFtdcDateTypeTradingDay;/交易用戶代碼TFfexFtdcUserIDTypeUserID;/會員代碼TFfexFtdcParticipantIDTypeParticipantID;/密碼TFfexFtdcPassword

31、TypePassword;nRequestID：用戶登錄請求的ID，該ID由用戶指定，管理。返回值：0，代表成功。其它值代表失敗。ReqUserLogout 方法用戶發(fā)出登出請求。函數(shù)原型：int ReqUserLogout(CFfexFtdcReqUserLogoutField *pReqUserLogout, int nRequestID)；參數(shù)：pReqUserLogout：指向用戶登出請求結(jié)構(gòu)的地址。用戶登出請求結(jié)構(gòu)：struct CFfexFtdcReqUserLogoutField/交易用戶代碼TFfexFtdcUserIDTypeUserID;/會員代碼TFfexFtdcPart

32、icipantIDTypeParticipantID;nRequestID：用戶登出請求的ID，該ID由用戶指定，管理。返回值：0，代表成功。其它值代表失敗。版權(quán)所有中國金融期貨交易所 第21頁，共29頁 開發(fā)示例/ mdusertest.cpp : /一個簡單的例子，介紹CFfexFtdcMduserApi和CFfexFtdcMduserSpi接口的使用。#include stdio.h#include FtdcMduserApi.hclass CSimpleHandler : public CFfexFtdcMduserSpipublic:/ 構(gòu)造函數(shù)，需要一個有效的指向CFfexFtdc

33、MduserApi實(shí)例的指針CSimpleHandler(CFfexFtdcMduserApi *pUserApi) : m_pUserApi(pUserApi) CSimpleHandler() / 當(dāng)客戶端與行情發(fā)布服務(wù)器建立起通信連接，客戶端需要進(jìn)行登錄void OnFrontConnected() CFfexFtdcReqUserLoginField reqUserLogin;strcpy(reqUserLogin.TradingDay, m_pUserApi-GetTradingDay();strcpy(reqUserLogin.ParticipantID, P001);strcpy

34、(reqUserLogin.UserID, U001);strcpy(reqUserLogin.Password, P001);m_pUserApi-ReqUserLogin(&reqUserLogin, 0);/ 當(dāng)客戶端與行情發(fā)布服務(wù)器通信連接斷開時，該方法被調(diào)用void OnFrontDisconnected() / 當(dāng)發(fā)生這個情況后，API會自動重新連接，客戶端可不做處理printf(OnFrontDisconnected.n);/ 當(dāng)客戶端發(fā)出登錄請求之后，該方法會被調(diào)用，通知客戶端登錄是否成功void OnRspUserLogin(CFfexFtdcRspUserLoginField *pRspUserLogin, CFfexFtdcRspInfoField *pRspInfo, int nRequestID, bool bIsLast) printf(OnRspUserLogin:n);printf(ErrorCode=%d, ErrorMsg=%sn, pRspInfo-ErrorID, pRspInfo-ErrorMsg);printf(RequestID=%d, Chain=%dn, nRequest