ALSON::Client类 参考

#include <Client.h>

Public 成员函数
	Client ()
	~Client ()
	Client (const Client &)=delete
Client &	operator= (const Client &)=delete
	Client (Client &&)=delete
Client &	operator= (Client &&)=delete
void	connect (const std::string &serverIp, int serverPort)
void	disconnect ()
bool	isConnected ()
template<typename T >
T	createDeviceController ()
DeviceParameterManager	createDeviceParameterManager ()
std::string	getServerIp ()
int	getServerPort ()
std::string	getServerAddress ()
int	getHeartbeatTimeout ()
void	setHeartbeatTimeout (int heartbeatTimeout)
void	updateClock ()
void	setClientEventListener (const BaseClientEventListenerPtr &listenerPtr)
void	destroyServer ()

静态 Public 成员函数
static void	initLog (const std::string &configurationFilePath)

Protected 属性
ClientContextPtr	m_clientContextPtr

详细描述

客户端接口

Alson SDK 是一种 CS 架构，硬件设备由服务端直接控制，我们通过客户端与服务端进行通信可以间接控制硬件设备

自从

0.1.0

在文件 Client.h 第 38 行定义.

构造及析构函数说明

Client() [1/3]

ALSON::Client::Client

(

)

~Client()

ALSON::Client::~Client

(

)

Client() [2/3]

ALSON::Client::Client ( const Client & )

delete

Client() [3/3]

ALSON::Client::Client ( Client && )

delete

成员函数说明

operator=() [1/2]

Client & ALSON::Client::operator= ( const Client & )

delete

operator=() [2/2]

Client & ALSON::Client::operator= ( Client && )

delete

connect()

void ALSON::Client::connect	(	const std::string &	serverIp,
		int	serverPort )

连接到指定地址的服务端

参数

serverIp	服务端IP地址
serverPort	服务端端口号

异常

ClientException

自从

0.1.0

disconnect()

void ALSON::Client::disconnect

(

)

从服务端断开连接

异常

ClientException

自从

0.1.0

isConnected()

bool ALSON::Client::isConnected

(

)

检查当前客户端是否连接到服务端

返回

true 表示已连接，false 表示未连接

异常

ClientException

自从

0.1.0

createDeviceController()

template<typename T >

T ALSON::Client::createDeviceController ( )

inline

由该客户端对象创建一个设备控制器对象

模板参数

T	必须是 BaseDeviceController 的子类

返回

设备控制器对象

异常

ClientException

自从

0.1.0

在文件 Client.h 第 115 行定义.

createDeviceParameterManager()

DeviceParameterManager ALSON::Client::createDeviceParameterManager ( )

inline

获取设备参数管理器

返回

设备参数管理器

异常

ClientException

自从

0.1.0

在文件 Client.h 第 133 行定义.

getServerIp()

std::string ALSON::Client::getServerIp

(

)

获取服务端IP

返回

服务端IP

异常

ClientException

自从

0.1.0

getServerPort()

int ALSON::Client::getServerPort

(

)

获取服务端端口号

返回

服务端端口号

异常

ClientException

自从

0.1.0

getServerAddress()

std::string ALSON::Client::getServerAddress

(

)

获取服务端地址，地址格式为 ip:port

返回

服务端地址

异常

ClientException

自从

0.1.0

getHeartbeatTimeout()

int ALSON::Client::getHeartbeatTimeout

(

)

获取心跳超时时间

返回

心跳超时时间

异常

ClientException

自从

0.1.0

setHeartbeatTimeout()

void ALSON::Client::setHeartbeatTimeout

(

int

heartbeatTimeout

)

设置心跳超时时间，单位是毫秒。

注意

心跳超时时间的最小值是 500 毫秒，小于 500 的参数将会被当作是 500

参数

heartbeatTimeout

心跳超时时间

异常

ClientException

自从

0.1.0

updateClock()

void ALSON::Client::updateClock

(

)

更新嵌入式设备的系统时钟，使其与客户端所在系统时钟同步。

注意

仅在连接嵌入式设备时可以调用该接口，在连接非嵌入式设备时调用该接口将会抛出异常

异常

ClientException

自从

0.1.0

setClientEventListener()

void ALSON::Client::setClientEventListener

(

const BaseClientEventListenerPtr &

listenerPtr

)

设置客户端事件监听器

参数

listenerPtr

客户端事件监听器

异常

ClientException

自从

0.1.0

destroyServer()

void ALSON::Client::destroyServer

(

)

销毁服务端进程

异常

ClientException

自从

0.1.0

initLog()

static void ALSON::Client::initLog ( const std::string & configurationFilePath )

static

初始化客户端日志配置

参数

configurationFilePath

指定日志配置文件所在路径

异常

ClientException

自从

0.1.0

类成员变量说明

m_clientContextPtr

ClientContextPtr ALSON::Client::m_clientContextPtr

protected

在文件 Client.h 第 283 行定义.