61 lines
1.7 KiB
C++
61 lines
1.7 KiB
C++
/*!
|
||
* \created : 2017/3/17
|
||
* \author : M.Yang
|
||
* \purpose : 提供UCI的C++版本接口
|
||
*/
|
||
#ifndef uci_cpp_h__
|
||
#define uci_cpp_h__
|
||
#include "uci.h"
|
||
|
||
namespace uci {
|
||
class Session;
|
||
}
|
||
|
||
//@brief : UCI 会话类
|
||
//@remark: 最uci_前缀的C语言规范的接口做简单封装，带来的好处是：
|
||
// 1、在Session对象析构时，会自动关闭会话是，使得的使用时更关注使用逻辑而不是错误处理逻辑；
|
||
// 2、在每一个接口上，可以省去一个Session ID的入参，且可以设定形参的默认值（在某些C语言编译器不支持），使得接口更简单；
|
||
// 但注意：
|
||
// 本类不做全部接口的适配，如有需要，可以自行适配。
|
||
class uci::Session {
|
||
public:
|
||
Session() : m_Session(INVALID_SESSION) {}
|
||
virtual ~Session() {
|
||
if (m_Session != INVALID_SESSION) {
|
||
uci_Close(m_Session);
|
||
m_Session = INVALID_SESSION;
|
||
}
|
||
}
|
||
|
||
u_status Open(u_cstring _addr, u_uint32 _timeout = 2000) {
|
||
u_status r = uci_OpenX(_addr, _timeout);
|
||
if (UCISUCCESS(r))
|
||
m_Session = (u_session)r;
|
||
return r;
|
||
}
|
||
|
||
u_status Write(u_cstring _msg,u_uint32 _timeout = 1000, const u_byte* _data = NULL, u_size _len = 0) {
|
||
return uci_WriteX(m_Session, _msg, _timeout, _data, _len);
|
||
}
|
||
|
||
u_status Read(u_cstring _msg,u_uint32 _timeout, u_byte* _data, u_size _dataLen) {
|
||
return uci_ReadX(m_Session, _msg, _timeout, _data, _dataLen);
|
||
}
|
||
|
||
u_status WriteFromFile(u_cstring _msg, u_cstring _filePath, u_uint32 _timeout) {
|
||
return uci_WriteFromFileX(m_Session, _msg, _filePath, _timeout);
|
||
}
|
||
|
||
u_status ReadToFile(u_cstring _msg, u_cstring _filePath, u_uint32 _timeout,
|
||
u_tchar *_filePathFinal, u_int32 _filePathFinalLength) {
|
||
return uci_ReadToFileX(m_Session, _msg, _filePath, _timeout, _filePathFinal, _filePathFinalLength);
|
||
}
|
||
|
||
u_status Close() { return uci_Close(m_Session); }
|
||
u_session GetSession() const { return m_Session; }
|
||
protected:
|
||
u_session m_Session;
|
||
};
|
||
|
||
#endif // uci_cpp_h__
|