基础API¶
枚举常量¶
ConnectFailType - 连接错误码¶
连接错误码
-
enum
ConnectFailType
¶ -
Unknown
¶ 未知错误
-
None
¶ 没有错误
-
CreateFailed
¶ socket创建失败
-
CloseFailed
¶ socket close错误
-
ShutdownFailed
¶
socket shutdown错误
-
GetHostByNameFailed
¶
gethostbyname错误
-
GetHostByNameWrong
¶
gethostbyname调用成功,但返回的结果错误
-
ConnectFailed
¶
连接失败
-
BindFailed
¶
socket bind失败
-
ListenFailed
¶
socket listen失败
-
SelectReturnError
¶
socket select错误
-
SendFailed
¶
socket send失败
-
RecvFailed
¶
socket recv失败
-
InitFailType - 初始化连接协议失败¶
初始化连接协议失败,即InitConnect协议相关的错误
FTAPI_InitFail - 初始化连接协议失败错误值¶
指定初始化连接协议失败,即InitConnect协议相关的错误,错误值:100。
FTAPI - API全局工具类。¶
-
class
FTAPI
¶
API全局工具类,提供API初始化销毁以及接口实例创建销毁接口。
InitFTApi¶
-
static void InitFTApi()
初始化底层通道,程序启动时首先调用
Returns: void
UnInitFTApi¶
-
static void InitFTApi()
清理底层通道,程序结束时调用
Returns: void
CreateQotApi¶
-
FTAPI_Qot* CreateQotApi();
创建行情接口实例
Returns: FTAPI_Qot* 行情接口实例指针
ReleaseQotApi¶
-
void ReleaseQotApi(FTAPI_Qot* pQot);
销毁行情接口实例。
Parameters: pQot – 行情接口实例指针 Returns: void
CreateTrdApi¶
-
FTAPI_Trd* CreateTrdApi();
创建交易接口实例
Returns: FTAPI_Trd* 交易接口实例指针
ReleaseTrdApi¶
-
void ReleaseTrdApi(FTAPI_Trd* pTrd);
销毁交易接口实例。
Parameters: pTrd – 交易接口实例指针 Returns: void
FTAPI_Conn - 连接层基类¶
-
class
FTAPI_Conn
¶
连接层基类,提供连接方面公用的功能,FTAPI_Qot以及FTAPI_Trd都继承于该基类。
SetClientInfo¶
-
void SetClientInfo(const char* szClientID, Futu::i32_t nClientVer)
设置客户端信息
Parameters: - szClientID – 客户端标识
- nClientVer – 客户端版本
Returns: void
SetRSAPrivateKey¶
-
void SetRSAPrivateKey(const char* szRSAPrivateKey)
设置密钥
Parameters: strRSAPrivateKey – 密钥 Returns: void
InitConnect¶
-
bool InitConnect(const char* szIPAddr, Futu::u16_t nPort, bool bEnableEncrypt)
初始化连接
Parameters: - szIPAddr – 地址
- nPort – 端口
- bEnableEncrypt – 启用加密
Returns: bool 是否启动了执行,不代表连接结果,结果通过OnInitConnect回调
GetConnectID¶
-
Futu::u64_t GetConnectID()
此连接的连接ID,连接的唯一标识,InitConnect协议返回,没有初始化前为0
Returns: Futu::u64_t 连接ID
Close¶
-
bool Close()
释放内存。当对象不再使用时调用,否则会有内存泄漏。
Returns: bool 是否成功
RegisterConnSpi¶
-
bool RegisterConnSpi(FTSPI_Conn* pSpi)
注册回调,用于处理连接相关的事件。
Parameters: pSpi – 回调实例,该对象没有反注册前不可销毁 Returns: bool 是否成功
UnregisterConnSpi¶
-
void UnregisterConnSpi()
反注册回调
Returns: bool 是否成功
FTSPI_Conn - 连接状态回调接口¶
-
class
FTSPI_Conn
¶
当与OpenD的连接状态变化时调用此接口。
OnInitConnect¶
-
void OnInitConnect(FTAPI_Conn* pConn, Futu::i64_t nErrCode, const char* strDesc)
初始化连接状态变化。
Parameters: - pConn – 对应连接实例指针
- nErrCode – 错误码。0表示成功,可以进行后续请求。当高32位为 ConnectFailType 类型时,低32位为系统错误码;当高32位等于 FTAPI_InitFail,则低32位为 InitFailType 类型。
- strDesc – 错误描述
Returns: void
OnDisConnect¶
-
void OnDisConnect(FTAPI_Conn* pConn, Futu::i64_t nErrCode)
连接断开。
Parameters: - pConn – 对应连接实例指针
- nErrCode – 错误码。高32位为 ConnectFailType 类型,低32位为系统错误码;
Returns: void