Bit_SetAttr

BIT_STATUS Bit_SetAttr (
    BIT_HANDLE      handle,
    BIT_UINT32      type,
    BIT_VOID        *pValue)

设置全局配置或当前会话的配置。

参数

  • handle - [IN] 通过Login函数返回的上下文句柄。如果传NULL，表示设置全局，不为NULL表示设置该会话。
  • type - [IN] 类型。
类型 值 说明
ATTR_HB_STOPED_CALLBACK（0x1） void (T_HbStopedCallback)(BIT_HANDLE, void pData) 心跳停止回调。
心跳停止后，会回调该函数，开发商可以在该函数里检测是否与授权服务断开
ATTR_WAIT_TIMEOUT(0x2) BIT_UINT32 * 队列等待超时。
最小16秒，最大15天，默认是0，表示无限等待
ATTR_RETRY_COUNT(0x3) BIT_UINT32 * 心跳连接重试次数。
当心跳时候，总的重试次数 0表示无限重试，直到客户端超时，默认是0
ATTR_RETRY_INTERVAL(0x4) BIT_UINT32 * 心跳连接重试间隔。
心跳失败后，下一次的重试的间隔。最小10秒，最大4小时，默认10秒
ATTR_CONNECT_TIMEOUT(0x5) BIT_UINT32 * 建立连接超时。
最小1秒，最大32秒，默认3秒
ATTR_CONNECT_RETRY_COUNT(0x6) BIT_UINT32 * 连接重试次数。
最小0次，最大10次，默认3次
ATTR_HB_RETRY_FAILED_CALLBACK(0x7) void (T_HbRetryFailedCallback)(BIT_HANDLE, BIT_STATUS, void pData) 心跳重试失败回调
ATTR_HB_INTERVAL(0x8) BIT_UINT32 * 心跳间隔。
最小30秒，默认由服务端控制
ATTR_HB_AUTO_ENABLE(0x9) BIT_UINT32 * 是否启动自动心跳
ATTR_HB_TIMEOUT(0x10) BIT_UINT32 * 心跳周期，超过该周期将被踢出。
集团服务端也可以设置心跳周期，该周期会覆盖服务端的设置
最小60秒，最大30天，默认由服务端控制
ATTR_HB_RETRY_FAILED_CALLBACK_DATA(0x11) void * 触发心跳失败回调时，会将该值传递到回调函数的最后一个参数
ATTR_HB_STOPED_CALLBACK_DATA(0x12) void * 触发心跳停止回调时，会将该值传递到回调函数的最后一个参数
ATTR_HB_STOPED_CALLBACK_EX(0x13) void (T_HbStopedCallbackEx)(BIT_HANDLE, BIT_TICKET, BIT_STATUS, void pData); 特征项的心跳失败回调
ATTR_HB_STOPED_CALLBACK_EX_DATA(0x14) void * 触发特征项心跳失败回调时，会将该值传递到回调函数的最后一个参数
ATTR_HB_RETRY_CALLBACK_EX(0x15) void (T_HbRetryFailedCallbackEx)(BIT_HANDLE, BIT_TICKET, BIT_STATUS, void pData); 特征项的心跳停止回调函数
ATTR_HB_RETRY_CALLBACK_EX_DATA(0x16) void * 触发特征项心跳停止回调时，会将该值传递到回调函数的最后一个参数
ATTR_SET_LOGIN_MODE(0x17) BIT_UINT32 * 设置login的mode值
ATTR_UNSET_LOGIN_MODE(0x18) BIT_UINT32 * 取消login的mode值
ATTR_DISABLE_ENV(0x19) BIT_BOOL * 禁用环境变量
传1表示禁用，设置了该属性后，客户端库将不再读取环境变量
ATTR_CURLOPT_TIMEOUT(0x1A) BIT_UINT32 * 自定义receiveTimeout
最小16s，最大64s，默认32s
ATTR_HB_RETRY_FAILED_CALLBACK_EX2(0x1B) void (T_HbRetrySuccessCallback)(BIT_HANDLE, BIT_TICKET, BIT_STATUS, BIT_UINT32, BIT_UINT32, BIT_UINT32 pData) 心跳重试失败回调函数
参数：
BIT_HANDLE handle login 返回的handle
BIT_TICKET ticket query 返回的ticket
BIT_STATUS status 心跳失败返回的错误码
BIT_UINT32 currentNumber 当前是第几次回调
BIT_UINT32 maxNumber 最大回调次数
BIT_UINT32 interval 每次回调的间隔，单位秒
VOID \pData 开发商自定义数据，须通过ATTR_HB_RETRY_CALLBACK_EX2_DATA传入
ATTR_HB_RETRY_FAILED_CALLBACK_EX2_DATA(0x1C) void * 触发Ex2的心跳失败回调时，会将该值传递到回调函数的最后一个参数
ATTR_HB_RETRY_SUCCESS_CALLBACK(0x1D) void (*T_HbRetryFailedCallbackEx2)(BIT_HANDLE, BIT_TICKET, BIT_UINT32, BIT_UINT32, BIT_UINT32 *pate) 心跳重试成功回调函数
参数：
BIT_HANDLE handle login 返回的handle
BIT_TICKET ticket query 返回的ticket
BIT_UINT32 currentNumber 当前是第几次回调
BIT_UINT32 maxNumber 最大回调次数
BIT_UINT32 interval 每次回调的间隔，单位秒
VOID \pData 开发商自定义数据，须通过ATTR_HB_RETRY_SUCCESS_CALLBACK_DATA传入
ATTR_HB_RETRY_SUCCESS_CALLBACK_DATA(0x1E) void * 触发心跳成功回调时，会将该值传递到回调函数的最后一个参数
  • pValue - [IN] 不同类型，对应了不同的值。

示例

// 设置队列等待超时为20秒

BIT_UINT32 value = 20;
BIT_STATUS status = Bit_SetAttr (handle, ATTR_WAIT_TIMEOUT, &value);
if (status == BIT_SUCCESS) {
    // 设置成功
}

Bit_SetProxy

BIT_STATUS Bit_SetProxy (
    BIT_UCHAR      *pApplicationData,
    BIT_PCSTR      szHostName,
    BIT_UINT32     nPort,
    BIT_PCSTR      szUserID,
    BIT_PCSTR      szPassword)

设置代理服务的地址和端口。

参数

  • pApplicationData - [IN] 产品识别码。记录在接口定义文件中，与产品一一对应。
  • szHostName - [IN] 代理服务所在机器的IP地址。
  • nPort - [IN] 客户端应用程序的通讯端口，默认为8273。
  • szUserID - [IN] 代理服务所在机器的用户名。
  • szPassword - [IN] 代理服务所在机器的密码。

Bit_SetCustomInfo

BIT_STATUS Bit_SetCustomInfo (
    BIT_UINT32      infoId,
    BIT_PCSTR       pInfoData,
    BIT_UINT32      infoDataSize)

设置客户端运行自定义信息，需要在程序的最开始调用。

参数

  • infoId - [IN] 自定义信息类型。
类型 值 说明
CUSTOM_CLIENT_ID（0x1） 字符串 自定义终端标识，该自定义标识会发送给服务器并用于今后的机器指纹匹配
CUSTOM_ACCOUNT_LOCAL(0x2) 字符串 自定义客户端用户帐号，用于集团服务标识客户端用户
CUSTOM_COMMENT(0x3) 字符串 自定义客户端登录注释，用于集团服务管理员获取用户登录请求信息
CUSTOM_OPTION(0x4) BIT_UINT32 按位进行操作
- CUSTOM_OPTION_SD1_FIRST (0x1) - 仅限Android选项，只检查第一张SD卡
- CUSTOM_OPTION_HIDE_FOLDER (0x2) - 隐藏默认的BitAnswer文件夹
- CUSTOM_OPTION_SOAP_USERNAME (0x4) - 机器用户信息添加到soap头中
- CUSTOM_OPTION_CONFINED_LINK (0x8) - 取消连接次数限制(1800)
- CUSTOM_OPTION_BINARY_NAME(0x10) – 客户向集团服务发送进程名

示例：
既要取消连接次数限制，又要隐藏BitAnswer目录，则传入： (CUSTOM_OPTION_HIDE_FOLDER| CUSTOM_OPTION_CONFINED_LINK)
CUSTOM_PRODUCT_CODE(0x6) 字符串 自定义授权目录名称
CUSTOM_ACCOUNT_DEVELOPER(0x7) 字符串 自定义登录帐号，用于帐号授权 （既使用account登录，又设置了此选项，则直接忽略）
CUSTOM_VENDOR_CODE(0x8) 字符串 自定义开发商信息目前仅用于自定义环境变量名称
CUSTOM_HTTP_HEADER(0x9) 字符串 类似于“auth:xxxx”，普遍用于自定义认证信息 自定义HTTP头，所有联网的请求都会自带这个请求头
CUSTOM_GROUP_NAME(0xA) 字符串 设置自定义分组名
当开发商需要按照自定义的分组扣点（比如：部门，角色，窗口名等），可以设置此选项，并结合Bit_Login的LOGIN_MODE设置扣点方式
  • pInfoData - [IN] 自定义信息的存储地址。
  • infoDataSize - [IN] 自定义信息长度。

Bit_SetRootPath

BIT_STATUS Bit_SetRootPath (
    BIT_PCSTR szPath)

设置授权文件的存储路径。

参数

  • szPath - [IN] 数据缓存区地址，用于存储授权文件的路径。

Bit_SetLocalServer

BIT_STATUS Bit_SetLocalServer (
    BIT_UCHAR      *pApplicationData,
    BIT_PCSTR       szHostName,
    BIT_UINT32      nPort,
    BIT_UINT32      nTimeoutSecondes)

设置集团服务的地址和端口。

参数

  • pApplicationData - [IN] 产品识别码。记录在接口定义文件中，与产品一一对应。
  • szHostName - [IN] 集团服务所安装机器的IP地址。
  • nPort - [IN] 客户端应用程序的通讯端口，默认为8273。
  • nTimeoutSecondes - [IN] 客户端超时秒数。