目錄
第1章 介紹 1
第2章 體系結構 1
2.1 通訊模式 1
2.2 資料流 2
第3章 運行模式 1
3.1 作業執行緒 1
3.2 本地檔案 1
第4章 開發介面 1
4.1 CUstpFtdcMduserSpi 介面 1
4.1.1 OnFrontConnected 方法 1
4.1.2 OnFrontDisconnected 方法 1
4.1.3 OnHeartBeatWarning方法 2
4.1.4 OnRspUserLogin方法 2
4.1.5 OnRspUserLogout 方法 3
4.1.6 OnRtnDepthMarketData方法 4
4.1.7 OnRspError 方法 6
4.1.8 OnRspSubMarketData方法 7
4.1.9 OnRspUnSubMarketData方法 7
4.2 CUstpFtdcMduserApi介面 8
4.2.1 CreateFtdcMduserApi方法 8
4.2.2 Release 方法 8
4.2.3 Init 方法 8
4.2.4 Join 方法 9
4.2.5 GetTradingDay方法 9
4.2.6 RegisterSpi 方法 9
4.2.7 RegisterFront 方法 9
4.2.8 SubscribeMarketDataTopic方法 10
4.2.9 ReqUserLogin 方法 11
4.2.10 ReqUserLogout 方法 11
4.2.11 SubMarketData方法 12
4.2.12 UnSubMarketData方法 12
第5章 開發示例 14
第1章 介紹
行情客戶端系統API是一個基于C++的類別庫, 通過使用和擴展類別庫提供的介面來實作行情資料的接收。該類別庫包含以下5個檔案：
檔案名 版本 檔案大小 檔案描述
UstpFtdcMduserApi.h V1.0 行情介面頭檔案
UstpFtdcUserApiDataType.h V1.0 定義了 API 所需的一系列資料型別的頭檔案
UstpFtdcUserApiStruct.h V1.0 定義了一系列業務相關的資料結構的頭檔案
USTPmduserapi.dll V1.0 元件二進制檔案
USTPmduserapi.lib V1.0 匯入庫檔案
支持MS VC 6.0，MS VC.NET 2003編譯器。需要打開多執行緒編譯選項/MT。
第2章 體系結構
行情API使用建立在TCP協議之上FTD協議與飛馬的行情發布服務器進行通訊。行情發布服務器負責行情資訊的產生與發布，但不參與交易程序。參與交易需要使用另外的“交易員API”。
2.1 通訊模式
FTD協議中的所有通訊都基于某個通訊模式。通訊模式實際上就是通訊雙方協同作業的方式。
行情發布涉及的通訊模式共有二種：
? 對話通訊模式
? 廣播通訊模式
對話通訊模式是指由會員端主動發起的通訊請求。該請求被飛馬服務端接收和處理，并給予回應。例如登入與登出。這種通訊模式與普通的客戶/服務器模式相同。
廣播通訊模式是指飛馬服務端主動，向市場中的相關會員發出相同的資訊。例如行情等。
通訊模式和網路的連接不一定存在簡單的一對一的關系。也就是說，一個網路連接中可能傳送多種不同通訊模式的報文，一種通訊模式的報文也可以在多個不同的連接中傳送。
無論哪種通訊模式，其通訊程序都如圖1所示：
圖1) 各通訊模式的作業程序
2.2 資料流
行情發布支持對話通訊模式、廣播通訊模式：
對話通訊模式下支持對話資料流：
對話資料流是一個雙向資料流，會員系統發送請求，行情發布系統反饋應答。交易系統不維護對話流的狀態。系統故障時，對話資料流會重置，通訊途中的資料可能會丟失。
廣播通訊模式下支持行情資料流：
行情資料流是一個單向資料流，由行情發布系統發向會員系統，用于發送行情資訊；行情流是一個可靠的資料流，行情系統維護整個系統的行情流，在一個交易日內，會員系統斷線恢復連接時，可以請求行情系統發送指定序號之后的行情流資料。
行情服務所提供的行情內容是按照主題組織的。每個主題包括一組合約的行情，還包括了行情發布內容和發布方式，包括行情深度、采樣頻率、延遲時間等。目前是飛馬行情系統參考中金所公布的各行情主題，設定行情主題。每個行情主題對應著一個行情流。
要獲得行情通知，客戶端必需在連接行情服務器時，訂閱一個或多個行情發布主題。
第3章 運行模式
3.1 作業執行緒
交易員客戶端應用程式至少由兩個執行緒組成，一個是應用程式主執行緒，一個是交易員API作業執行緒。應用程式與交易系統的通訊是由API作業執行緒驅動的。
UstpFtdcMduserApi提供的介面是執行緒安全的，可以有多個應用程式執行緒同時發出請求。
UstpFtdcMduserSpi提供的介面回呼是由API作業執行緒驅動，如果多載的某個回呼函式阻塞，則等于阻塞了API作業執行緒，API與交易系統的通訊會停止。因此，在UstpFtdcTraderSpi派生類的回呼函式中，通常應迅速回傳，可以利用將資料放入緩沖區或通過Windows的訊息機制來實作。
3.2 本地檔案
交易員API在運行程序中，會將一些資料寫入本地檔案中。呼叫CreateFtdcMduserApi函式，可以傳遞一個引數，指明存貯本地檔案的路徑。該路徑必須在運行前已創建好。本地檔案的擴展名都是”.con”。
第4章 開發介面
行情客戶端系統API提供了二個介面，分別為CUstpFtdcMduserApi和CUstpFtdcMduserSpi。
4.1 CUstpFtdcMduserSpi 介面
CUstpFtdcMduserSpi實作了事件通知介面。用戶必需派生CUstpFtdcMduserSpi介面，撰寫事件處理方法來處理感興趣的事件。
4.1.1 OnFrontConnected 方法
當客戶端與行情發布服務器建立起通信連接時（還未登錄前），該方法被呼叫。
函式原型：
void OnFrontConnected()；
本方法在完成初始化后呼叫，可以在其中完成用戶登錄任務。
4.1.2 OnFrontDisconnected 方法
當客戶端與交易后臺通信連接斷開時，該方法被呼叫。當發生這個情況后，API會自動重新連接，客戶端可不做處理。
函式原型：
void OnFrontDisconnected (int nReason)；
引數：
nReason：連接斷開原因
0x1001 網路讀失敗
0x1002 網路寫失敗
0x2001 接收心跳超時
0x2002 發送心跳失敗
0x2003 收到錯誤報文
4.1.3 OnHeartBeatWarning方法
心跳超時警告。當長時間未收到報文時，該方法被呼叫。
函式原型：
void OnHeartBeatWarning(int nTimeLapse)；
引數：
nTimeLapse：距離上次接收報文的時間
4.1.4 OnRspUserLogin方法
當客戶端發出登錄請求之后，該方法會被呼叫，通知客戶端登錄是否成功。
函式原型：
void OnRspUserLogin(
CUstpFtdcRspUserLoginField *pRspUserLogin,
CUstpFtdcRspInfoField *pRspInfo,
int nRequestID,
bool bIsLast)；
引數：
pRspUserLogin：回傳用戶登錄資訊的地址。
用戶登錄資訊結構：
struct CUstpFtdcRspUserLoginField
{
///交易日
TUstpFtdcDateType TradingDay;
///登錄成功時間
TUstpFtdcTimeType LoginTime;
///最大本地報單號
TUstpFtdcOrderLocalIDType MaxOrderLocalID;
///交易用戶代碼
TUstpFtdcUserIDType UserID;
///會員代碼
TUstpFtdcParticipantIDType ParticipantID;
};
pRspInfo：回傳用戶回應資訊的地址。特別注意在有連續的成功的回應資料時，中間有可能回傳NULL，但第一次不會，以下同。錯誤代碼為0時，表示操作成功，以下同。
回應資訊結構：
struct CUstpFtdcRspInfoField
{
///錯誤代碼
TUstpFtdcErrorIDType ErrorID;
///錯誤資訊
TUstpFtdcErrorMsgType ErrorMsg;
};
nRequestID：回傳用戶登錄請求的ID，該ID由用戶在登錄時指定。
bIsLast：指示該次回傳是否為針對nRequestID的最后一次回傳。
4.1.5 OnRspUserLogout 方法
當客戶端發出登出請求之后，該方法會被呼叫，通知客戶端登出是否成功。
函式原型：
void OnRspUserLogout(
CUstpFtdcRspUserLogoutField *pRspUserLogout,
CUstpFtdcRspInfoField *pRspInfo,
int nRequestID,
bool bIsLast)；
引數：
pRspUserLogout：回傳用戶登出資訊的地址。
用戶登出資訊結構：
struct CUstpFtdcRspUserLogoutField
{
///交易用戶代碼
TUstpFtdcUserIDType UserID;
///會員代碼
TUstpFtdcParticipantIDType ParticipantID;
};
pRspInfo：回傳用戶回應資訊的地址。
回應資訊結構：
struct CUstpFtdcRspInfoField
{
///錯誤代碼
TUstpFtdcErrorIDType ErrorID;
///錯誤資訊
TUstpFtdcErrorMsgType ErrorMsg;
};
nRequestID：回傳用戶登出請求的ID，該ID由用戶在登出時指定。
bIsLast：指示該次回傳是否為針對nRequestID的最后一次回傳。
4.1.6 OnRtnDepthMarketData方法
行情通知，行情服務器會主動通知客戶端。
函式原型：
void OnRtnDepthMarketData(CUstpFtdcDepthMarketDataField *pDepthMarketData)；
引數：
pDepthMarketData：回傳市場行情資訊的地址。
深度市場行情資訊結構：
struct CUstpFtdcDepthMarketDataField
{
///交易日
TUstpFtdcDateType TradingDay;
///結算組代碼
TUstpFtdcSettlementGroupIDType SettlementGroupID;
///結算編號
TUstpFtdcSettlementIDType SettlementID;
///最新價
TUstpFtdcPriceType LastPrice;
///昨結算
TUstpFtdcPriceType PreSettlementPrice;
///昨收盤
TUstpFtdcPriceType PreClosePrice;
///昨持倉量
TUstpFtdcLargeVolumeType PreOpenInterest;
///今開盤
TUstpFtdcPriceType OpenPrice;
///最高價
TUstpFtdcPriceType HighestPrice;
///最低價
TUstpFtdcPriceType LowestPrice;
///數量
TUstpFtdcVolumeType Volume;
///成交金額
TUstpFtdcMoneyType Turnover;
///持倉量
TUstpFtdcLargeVolumeType OpenInterest;
///今收盤
TUstpFtdcPriceType ClosePrice;
///今結算
TUstpFtdcPriceType SettlementPrice;
///漲停板價
TUstpFtdcPriceType UpperLimitPrice;
///跌停板價
TUstpFtdcPriceType LowerLimitPrice;
///昨虛實度
TUstpFtdcRatioType PreDelta;
///今虛實度
TUstpFtdcRatioType CurrDelta;
///最后修改時間
TUstpFtdcTimeType UpdateTime;
///最后修改毫秒
TUstpFtdcMillisecType UpdateMillisec;
///合約代碼
TUstpFtdcInstrumentIDType InstrumentID;
///申買價一
TUstpFtdcPriceType BidPrice1;
///申買量一
TUstpFtdcVolumeType BidVolume1;
///申賣價一
TUstpFtdcPriceType AskPrice1;
///申賣量一
TUstpFtdcVolumeType AskVolume1;
///申買價二
TUstpFtdcPriceType BidPrice2;
///申買量二
TUstpFtdcVolumeType BidVolume2;
///申賣價二
TUstpFtdcPriceType AskPrice2;
///申賣量二
TUstpFtdcVolumeType AskVolume2;
///申買價三
TUstpFtdcPriceType BidPrice3;
///申買量三
TUstpFtdcVolumeType BidVolume3;
///申賣價三
TUstpFtdcPriceType AskPrice3;
///申賣量三
TUstpFtdcVolumeType AskVolume3;
///申買價四
TUstpFtdcPriceType BidPrice4;
///申買量四
TUstpFtdcVolumeType BidVolume4;
///申賣價四
TUstpFtdcPriceType AskPrice4;
///申賣量四
TUstpFtdcVolumeType AskVolume4;
///申買價五
TUstpFtdcPriceType BidPrice5;
///申買量五
TUstpFtdcVolumeType BidVolume5;
///申賣價五
TUstpFtdcPriceType AskPrice5;
///申賣量五
TUstpFtdcVolumeType AskVolume5;
};
4.1.7 OnRspError 方法
針對用戶請求的出錯通知。
函式原型：
void OnRspError(
CUstpFtdcRspInfoField *pRspInfo,
int nRequestID,
bool bIsLast)
引數：
pRspInfo：回傳用戶回應資訊的地址。
回應資訊結構：
struct CUstpFtdcRspInfoField
{
///錯誤代碼
TUstpFtdcErrorIDType ErrorID;
///錯誤資訊
TUstpFtdcErrorMsgType ErrorMsg;
};
nRequestID：回傳用戶登出請求的ID，該ID由用戶在登出時指定。
4.1.8 OnRspSubMarketData方法
針對用戶請求的訂閱的合約回傳已經訂閱的合約結果。
函式原型：
void OnRspSubMarketData(CUstpFtdcSpecificInstrumentField *pSpecificInstrument, CUstpFtdcRspInfoField *pRspInfo, int nRequestID, bool bIsLast)
引數：
pSpecificInstrument：回傳用戶成功訂閱的合約。
nRequestID：回傳用戶登出請求的ID，該ID由用戶在登出時指定。這里無效。
bIsLast：指示該次回傳是否為針對nRequestID的最后一次回傳。
4.1.9 OnRspUnSubMarketData方法
針對用戶請求的訂閱的合約回傳已經訂閱的合約結果。
函式原型：
void OnRspUnSubMarketData(CUstpFtdcSpecificInstrumentField *pSpecificInstrument, CUstpFtdcRspInfoField *pRspInfo, int nRequestID, bool bIsLast)
引數：
pSpecificInstrument：回傳用戶成功訂閱的合約。
nRequestID：回傳用戶登出請求的ID，該ID由用戶在登出時指定。這里無效。
bIsLast：指示該次回傳是否為針對nRequestID的最后一次回傳。
4.2 CUstpFtdcMduserApi介面
CUstpFtdcMduserApi介面提供給客戶登陸、登出行情查詢服務器，進行行情查詢等功能。
4.2.1 CreateFtdcMduserApi方法
產生一個CUstpFtdcMduserApi的一個實體，不能通過new來產生。
函式原型：
static CUstpFtdcMduserApi *CreateFtdcMduserApi(const char *pszFlowPath = "");
引數：
pszFlowPath：常量字符指標，用于指定一個檔案目錄來存貯行情服務發布訊息的狀態。 默認值代表當前目錄。
回傳值：
回傳一個指向CUstpFtdcMduserApi實體的指標。
4.2.2 Release 方法
釋放一個CUstpFtdcMduserApi實體。
函式原型：
void Release()；
4.2.3 Init 方法
使客戶端開始與行情發布服務器建立連接，連接成功后可以進行登陸。
函式原型：
void Init()；
4.2.4 Join 方法
客戶端等待一個介面實體執行緒的結束。
函式原型：
void Join()；
4.2.5 GetTradingDay方法
獲得當前交易日。只有當與服務器連接建立后才會取到正確的值。
函式原型：
const char *GetTradingDay()；
回傳值：
回傳一個指向日期資訊字串的常量指標。
4.2.6 RegisterSpi 方法
注冊一個派生自CUstpFtdcMduserSpi介面類的實體，該實體將完成事件處理。
函式原型：
void RegisterSpi(CUstpFtdcMduserSpi *pSpi) ;
引數：
pSpi：實作了CUstpFtdcMduserSpi介面的實體指標。
4.2.7 RegisterFront 方法
設定行情發布服務器的地址。
函式原型：
void RegisterFront(char *pszFrontAddress);
引數：
pszFrontAddress：指向后臺服務器地址的指標。服務器地址的格式為：“protocol://ipaddress:port”，如：”tcp://127.0.0.1:17001”。 “tcp”代表傳輸協議，“127.0.0.1”代表服務器地址。”17001”代表服務器埠號。
4.2.8 RegisterNameServer 方法
設定飛馬NameServer的網路通訊地址，用于獲取行情服務串列。交易系統擁有多個NameServer，用戶可以同時注冊多個NameServer的網路通訊地址。
該方法要在Init方法之前呼叫。
函式原型：
void RegisterNameServer (char *pszNsAddress);
引數：
pszNsAddress：指向交易所服務端NameServer網路通訊地址的指標。網路地址的格式為：“protocol://ipaddress:port”，如：“tcp://127.0.0.1:17001”。 “tcp”代表傳輸協議，“127.0.0.1”代表服務器地址。”17001”代表服務器埠號。
注意：此介面保留，但目前并未啟用！
4.2.9 SubscribeMarketDataTopic方法
客戶端訂閱自己需要的行情。訂閱后行情服務器會自動發出行情通知給客戶端。
函式原型：
void SubscribeMarketDataTopic (int nTopicID, TE_RESUME_TYPE nResumeType)；
引數：
nTopicID：代表深度行情的主題，由中金所公布，飛馬采用其主題。
nResumeType：市場行情重傳方式
TERT_RESTART:從本交易日開始重傳
TERT_RESUME:從上次收到的續傳(非訂閱全部合約時，不支持續傳模式)
TERT_QUICK:先傳送當前行情快照,再傳送登錄后市場行情的內容
4.2.10 ReqUserLogin 方法
用戶發出登陸請求。
函式原型：
int ReqUserLogin(
CUstpFtdcReqUserLoginField *pReqUserLoginField,
int nRequestID)；
引數：
pReqUserLoginField：指向用戶登錄請求結構的地址。
用戶登錄請求結構：
struct CUstpFtdcReqUserLoginField
{
///交易日
TUstpFtdcDateType TradingDay;
///交易用戶代碼
TUstpFtdcUserIDType UserID;
///會員代碼
TUstpFtdcParticipantIDType ParticipantID;
///密碼
TUstpFtdcPasswordType Password;
};
nRequestID：用戶登錄請求的ID，該ID由用戶指定，管理。
回傳值：
0，代表成功。其它值代表失敗。
4.2.11 ReqUserLogout 方法
用戶發出登出請求。
函式原型：
int ReqUserLogout(
CUstpFtdcReqUserLogoutField *pReqUserLogout,
int nRequestID)；
引數：
pReqUserLogout：指向用戶登出請求結構的地址。
用戶登出請求結構：
struct CUstpFtdcReqUserLogoutField
{
///交易用戶代碼
TUstpFtdcUserIDType UserID;
///會員代碼
TUstpFtdcParticipantIDType ParticipantID;
};
nRequestID：用戶登出請求的ID，該ID由用戶指定，管理。
回傳值：
0，代表成功。其它值代表失敗。
4.2.12 SubMarketData方法
用戶請求訂閱的合約號。
函式原型：
int SubMarketData(char *ppInstrumentID[], int nCount)
引數：
ppInstrumentID：合約ID陣列地址。
nCount：合約的個數。
回傳值：
uj5u.com熱心網友回復：
uj5u.com熱心網友回復：
WTF？
轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/50647.html
標籤：網絡及通訊開發