易盛期货交易软件开包使用手册.doc

易盛期货交易软件开发包使用手册 版本：1.1 作者： 创建时间：2012年5月1号  修订记录 修改时间 修改内容 修改人 说明 2011-01-01 创建 2011-04-12 增加1,2,3,4章的详细描述 2012-05-01 增加部分回调接口 目录： 易盛期货交易软件开发包使用手册 1 修订记录 2 1. 易盛开发包基本构架说明 4 1.1. 开发包接口 4 1.2. 开发包文件说明 4 2. 开发包提供API说明 4 2.1. 类接口及函数接口 4 2.2. 接口使用约束 5 3. 开发包使用举例(参见Demo.h,Demo.cpp) 6 3.1. 使用开发包开发流程 6 3.2. Demo代码示例 7 4. 报单处理流程 7 4.1. 字段说明 7 4.2. 报单流程说明 8 4.3. 撤单流程说明 9 缩略语 11 易盛开发包基本构架说明 开发包接口 EsunnyApi接口采用C++语言开发，提供的接口按照交易功能和行情功能划分，对应为交易类和行情类，开发用户使用本开发包开发交易软件时根据需要实现的功能分别调用对应功能的类接口。 开发包文件说明 开发包包括以下五个文件： EsunnyApi.h //开发包对外提供的接口 EsunnyApiStruct.h //业务处理数据域定义 EsunnyApiType.h //基本数据类型定义 EsunnyApiErrcode //函数调用返回错误代码定义 EsunnyApi.lib //dll导入库，编译时用到 EsunnyApi.dll //api执行库，程序运行时用到 开发包提供API说明 类接口及函数接口 类接口 API中提供类一共四个，分别为IEsunnyTradeApi， IEsunnyTradeSpi，IEsunnyQuoteApi和IEsunnyQuoteSpi。其中IEsunnyTradeApi和IEsunnyTradeSpi两个类为交易处理类，提供交易相关功能，IEsunnyQuoteApi和IEsunnyQuoteSpi两个类为行情处理类，提供行情查询功能。 类名中以Api结尾的类的成员函数为应用程序开发者的调用函数，实现发起请求的功能。类名中以Spi结尾的类的成员函数需要应用程序开发者重写，这些函数为动态库的回调函数，当数据接收完成时会被调用。 函数接口 API提供的全局函数接口包括CertEsunnyApi，GetEsunnyApiVersion，CreateEsunnyTradeApi和CreateEsunnyQuoteApi四个，功能如下： CertEsunnyApi 开发商认证函数，使用本开发包的开发需要通过认证； GetEsunnyApiVersion 获取当前开发包版本； CreateEsunnyTradeApi 创建交易处理API实例； CreateEsunnyQuoteApi 创建行情处理API实例。 接口使用约束 易盛针对本开发包的开发者提供认证码，以便于识别不同的开发者，只有通过开发商认证函数认证后，开发包提供的各项功能才能正常使用。 调用行情处理类连接之前必须保证交易处理类已经登录成功。 交易连接成功后，需要调用登录请求。 交易登录成功后，方可获取当前交易日。 交易登录成功后，方可进行相应的查询，资金，委托，成交，持仓，交易状态，商品，合约，组合合约，每一个查询数据结束后，方可进行后续查询，查询结束由该查询对应的回调函数的参数islast判定（1结束，0未结束）。 调用动态库接口查询相应数据后，动态库开始进行主动的数据推送，如：资金、委托、成交、持仓、交易状态，回调函数名称中包含Qry的为查询应答，包含Rtn的为推送数据，是在条件满足时动态库主动发起的。 对于Api调用返回值，bool类型true为成功，int类型0为成功。 开发包使用举例(参见Demo.h,Demo.cpp) 使用开发包开发流程 根据交易类和行情类创建自己的交易业务类(CTrade)和行情业务类(CQuote)，CTrade类从IEsunnyTradeSpi类继承，重写关注的接口，需要关联IEsunnyTradeApi类。CQuote类需要从IEsunnyQuoteSpi类继承，重写关注的接口，需要关联IEsunnyQuoteApi类。 创建业务类对象之前，先调用认证函数认证，传入易盛授权的认证码。 生成行情业务处理类和交易业务处理类的实例，连接至交易服务器。 进入程序主循环。应用开发可以主动发起请求进行相关业务操作，当有数据接收时动态库会调用对应处理函数；或者有满足条件的业务状态发生变化时，应用开发无需主动发起，动态库会调用该回调函数。