基础API


枚举常量

ConnectFailType - 连接错误码

连接错误码

enum ConnectFailType
Unknown

未知错误

None

没有错误

CreateFailed

socket创建失败

CloseFailed

socket close错误

ShutdownFailed

socket shutdown错误

GetHost ByNameFailed

gethostbyname错误

GetHostByNameWrong

gethostbyname调用成功,但返回的结果错误

ConnectFailed

连接失败

BindFailed

socket bind失败

ListenFailed

socket listen失败

SelectReturnError

socket select错误

SendFailed

socket send失败

RecvFailed

socket recv失败


InitFailType - 初始化连接协议失败类型

初始化连接协议失败,即InitConnect协议相关的错误

enum InitFailType
Unknow

未知错误

Timeout

超时

DisConnect

连接断开

SeriaNoNotMatch

序列号不符

SendInitReqFailed

发送初始化协议失败

OpenDReject

FutuOpenD回包指定错误,具体错误看描述


FTAPI_InitFail - 初始化连接协议失败错误值

指定初始化连接协议失败,即InitConnect协议相关的错误,错误值:100。


FTAPI - API全局功能。

class FTAPI

API全局配置类,初始化和全局配置类。


Init

static void Init()

初始化底层通道,程序启动时首先调用

Returns:void

UnInit

static void UnInit()

清理底层通道,程序结束时调用

Returns:void

FTAPI_Conn连接层基类

class FTAPI

API功能基类,提供连接方面公用的功能。FTAPI_Qot(行情)和FTAPI_Trd(交易)都继承该类。


SetConnSpi

void SetConnSpi(FTSPI_Conn callback)

设置连接相关回调。

Parameters:callback – 参加下面 FTSPI_Conn 的说明
Returns:void

SetClientInfo

void SetClientInfo(string clientID, int clientVer)

初始化连接信息。

Parameters:
  • clientID – 连接标识符,请自定义独特的标识符
  • clientVer – 连接版本号,请参考opendapi版本号
Returns:

void


InitConnect

bool InitConnect(string ip, ushort port, bool isEnableEncrypt)

初始化连接信息。

Parameters:
  • ip – 连接地址
  • port – 连接端口号
  • isEnableEncrypt – 是否允许加密
Returns:

bool 初始化失败返回false,其他错误依据callback返回


SetRSAPrivateKey

void SetRSAPrivateKey(string key)

设置密钥。

Parameters:key – 加密密钥。格式见 rsa
Returns:void

GetConnectID

long GetConnectID()

获取此连接的连接ID,连接的唯一标识,InitConnect协议返回,没有初始化前为0

Returns:long

Close

void Close()

释放内存。当对象不再使用时调用,否则会有内存泄漏。

Returns:void

FTSPI_Conn - 连接状态回调接口

interface FTSPI_Conn

当与OpenD的连接状态变化时调用此接口。


OnInitConnect

void OnInitConnect(FTAPI_Conn client, long errCode, String desc)

初始化连接状态变化。

Parameters:
  • client – 对应的FTAPI实例
  • errCode – 错误码。0表示成功,可以进行后续请求。当高32位为 ConnectFailType 类型时,低32位为系统错误码;当高32位等于 FTAPI_InitFail,则低32位为 InitFailType 类型。
  • desc – 错误描述
Returns:

void


OnDisConnect

void OnDisconnect(FTAPI_Conn client, long errCode)

连接断开。

Parameters:
  • client – 对应的FTAPI实例
  • errCode – 错误码。高32位为 ConnectFailType 类型,低32位为系统错误码;
Returns:

void