#include <socket.h>

Public 成员函数
	Socket ()

virtual	~Socket ()

int	socketOpen (const std::string &address, int port, const std::string &socket_name="socket_0")
	打开TCP/IP以太网通信socket

int	socketClose (const std::string &socket_name="socket_0")
	关闭TCP/IP socket 通信关闭与服务器的 socket 连接。

int	socketReadAsciiFloat (int number, const std::string &variable, const std::string &socket_name="socket_0")
	从socket读取指定数量的ASCII格式浮点数。一次最多可读取30个值。读取到的数字列表（浮点数列表，长度=number+1）

int	socketReadBinaryInteger (int number, const std::string &variable, const std::string &socket_name="socket_0")
	从socket读取指定数量的32位整数。字节为网络字节序。一次最多可读取30个值。读取到的数字列表（整数列表，长度=number+1）

int	socketReadByteList (int number, const std::string &variable, const std::string &socket_name="socket_0")
	从socket读取指定数量的字节。字节为网络字节序。一次最多可读取30个值。读取到的数字列表（整数列表，长度=number+1）

int	socketReadString (const std::string &variable, const std::string &socket_name="socket_0", const std::string &prefix="", const std::string &suffix="", bool interpret_escape=false)
	从socket读取所有数据并将其作为字符串返回。字节为网络字节序。

int	socketReadAllString (const std::string &variable, const std::string &socket_name="socket_0")
	从socket读取所有数据并将其作为char向量返回。

int	socketSendByte (char value, const std::string &socket_name="socket_0")
	发送一个字节到服务器通过socket发送字节<value>，不期望响应。可用于发送特殊ASCII字符；10为换行符，2为文本开始，3为文本结束。

int	socketSendInt (int value, const std::string &socket_name="socket_0")
	发送一个int（int32_t）到服务器通过socket发送int ，以网络字节序发送。不期望响应。

int	socketSendLine (const std::string &str, const std::string &socket_name="socket_0")
	发送带有换行符的字符串到服务器.

int	socketSendString (const std::string &str, const std::string &socket_name="socket_0")
	发送字符串到服务器通过socket以ASCII编码发送字符串<str>，不期望响应。

int	socketSendAllString (bool is_check, const std::vector< char > &str, const std::string &socket_name="socket_0")
	发送给定char向量中的所有数据到服务器。

bool	socketHasConnected (const std::string &socket_name="socket_0")
	检测 socket 连接是否成功

Protected 属性
void *	d_

详细描述

在文件 socket.h 第 16 行定义.

构造及析构函数说明

◆ Socket()

arcs::common_interface::Socket::Socket ( )

◆ ~Socket()

virtual arcs::common_interface::Socket::~Socket ( )

virtual

成员函数说明

◆ socketClose()

int arcs::common_interface::Socket::socketClose ( const std::string & socket_name = "socket_0" )

关闭TCP/IP socket 通信关闭与服务器的 socket 连接。

指令

参数

socket_name 套接字名称

返回: 返回值

Python函数原型: socketClose(self: pyaubo_sdk.Socket, arg0: str) -> int

Lua函数原型: socketClose(socket_name: string) -> nil

JSON-RPC请求示例: {"jsonrpc":"2.0","method":"Socket.socketClose","params":["socket_0"],"id":1}

JSON-RPC响应示例: {"id":1,"jsonrpc":"2.0","result":0}

◆ socketHasConnected()

bool arcs::common_interface::Socket::socketHasConnected ( const std::string & socket_name = "socket_0" )

检测 socket 连接是否成功

◆ socketOpen()

int arcs::common_interface::Socket::socketOpen	(	const std::string &	address,
		int	port,
		const std::string &	socket_name = `"socket_0"`
	)

打开TCP/IP以太网通信socket

指令

参数

address	地址
port	端口
socket_name	套接字名称

返回: 返回值

Python函数原型: socketOpen(self: pyaubo_sdk.Socket, arg0: str, arg1: int, arg2: str) -> int

Lua函数原型: socketOpen(address: string, port: number, socket_name: string) -> nil

JSON-RPC请求示例: {"jsonrpc":"2.0","method":"Socket.socketOpen","params":["172.16.26.248",8000,"socket_0"],"id":1}

JSON-RPC响应示例: {"id":1,"jsonrpc":"2.0","result":0}

◆ socketReadAllString()

int arcs::common_interface::Socket::socketReadAllString	(	const std::string &	variable,
		const std::string &	socket_name = `"socket_0"`
	)

从socket读取所有数据并将其作为char向量返回。

指令 std::vector<char>

参数

variable	变量名
socket_name	套接字名称

返回: 返回值

Python函数原型: socketReadAllString(self: pyaubo_sdk.Socket, arg0: str, arg1: str) -> int

Lua函数原型: socketReadAllString(variable: string, socket_name: string) -> number

JSON-RPC请求示例: {"jsonrpc":"2.0","method":"Socket.socketReadAllString","params":["camera","socket_0"],"id":1}

JSON-RPC响应示例: {"id":1,"jsonrpc":"2.0","result":0}

◆ socketReadAsciiFloat()

int arcs::common_interface::Socket::socketReadAsciiFloat	(	int	number,
		const std::string &	variable,
		const std::string &	socket_name = `"socket_0"`
	)

从socket读取指定数量的ASCII格式浮点数。一次最多可读取30个值。读取到的数字列表（浮点数列表，长度=number+1）

结果将存储在名为reg_key的寄存器中。使用getFloatVec获取数据

参数

number	数量
variable	变量名
socket_name	套接字名称

返回: 返回值

Python函数原型: socketReadAsciiFloat(self: pyaubo_sdk.Socket, arg0: int, arg1: str, arg2: str) -> int

Lua函数原型: socketReadAsciiFloat(number: number, variable: string, socket_name: string) -> number

◆ socketReadBinaryInteger()

int arcs::common_interface::Socket::socketReadBinaryInteger	(	int	number,
		const std::string &	variable,
		const std::string &	socket_name = `"socket_0"`
	)

从socket读取指定数量的32位整数。字节为网络字节序。一次最多可读取30个值。读取到的数字列表（整数列表，长度=number+1）

指令

std::vector<int>

参数

number	数量
variable	变量名
socket_name	套接字名称

返回: 返回值

Python函数原型: socketReadBinaryInteger(self: pyaubo_sdk.Socket, arg0: int, arg1: str, arg2: str) -> int

Lua函数原型: socketReadBinaryInteger(number: number, variable: string, socket_name: string) -> number

◆ socketReadByteList()

int arcs::common_interface::Socket::socketReadByteList	(	int	number,
		const std::string &	variable,
		const std::string &	socket_name = `"socket_0"`
	)

从socket读取指定数量的字节。字节为网络字节序。一次最多可读取30个值。读取到的数字列表（整数列表，长度=number+1）

指令

std::vector<char>

参数

number	数量
variable	变量名
socket_name	套接字名称

返回: 返回值

Python函数原型: socketReadByteList(self: pyaubo_sdk.Socket, arg0: int, arg1: str, arg2: str) -> int

Lua函数原型: socketReadByteList(number: number, variable: string, socket_name: string) -> number

◆ socketReadString()

int arcs::common_interface::Socket::socketReadString	(	const std::string &	variable,
		const std::string &	socket_name = `"socket_0"`,
		const std::string &	prefix = `""`,
		const std::string &	suffix = `""`,
		bool	interpret_escape = `false`
	)

从socket读取所有数据并将其作为字符串返回。字节为网络字节序。

可选参数"prefix"和"suffix"可用于指定从socket中提取的内容。 "prefix"指定提取子字符串（消息）的起始位置。直到"prefix"结尾的数据将被忽略并从socket中移除。 "suffix"指定提取子字符串（消息）的结束位置。"suffix"之后的任何剩余数据将保留在socket中。例如，如果socket服务器发送字符串"noise>hello<"，控制器可以通过调用此脚本函数并设置prefix=">"和suffix="<"来接收"hello"。通过使用"prefix"和"suffix"，还可以一次向控制器发送多条字符串，因为"suffix"定义了消息的结束位置。例如发送">hello<>world<"

指令

std::string

参数

variable	变量名
socket_name	套接字名称
prefix	前缀
suffix	后缀
interpret_escape	是否解释转义字符

返回: 返回值

Python函数原型: socketReadString(self: pyaubo_sdk.Socket, arg0: str, arg1: str, arg2: str, arg3: str, arg4: bool) -> int

Lua函数原型: socketReadString(variable: string, socket_name: string, prefix: string, suffix: string, interpret_escape: boolean) -> number

JSON-RPC请求示例: {"jsonrpc":"2.0","method":"Socket.socketReadString","params":["camera","socket_0","","",false],"id":1}

JSON-RPC响应示例: {"id":1,"jsonrpc":"2.0","result":0}

◆ socketSendAllString()

int arcs::common_interface::Socket::socketSendAllString	(	bool	is_check,
		const std::vector< char > &	str,
		const std::string &	socket_name = `"socket_0"`
	)

发送给定char向量中的所有数据到服务器。

参数

is_check	是否检查发送状态
str	要发送的数据，char向量
socket_name	套接字名称

返回: 状态码

Python函数原型: socketSendAllString(self: pyaubo_sdk.Socket, arg0: bool, arg1: List[str], arg2: str) -> int

Lua函数原型: socketSendAllString(is_check: boolean, str: table, socket_name: string) -> nil

◆ socketSendByte()

int arcs::common_interface::Socket::socketSendByte	(	char	value,
		const std::string &	socket_name = `"socket_0"`
	)

发送一个字节到服务器通过socket发送字节<value>，不期望响应。可用于发送特殊ASCII字符；10为换行符，2为文本开始，3为文本结束。

指令

参数

value	字节值
socket_name	套接字名称

返回: 返回值

Python函数原型: socketSendByte(self: pyaubo_sdk.Socket, arg0: str, arg1: str) -> int

Lua函数原型: socketSendByte(value: string, socket_name: string) -> nil

◆ socketSendInt()

int arcs::common_interface::Socket::socketSendInt	(	int	value,
		const std::string &	socket_name = `"socket_0"`
	)

发送一个int（int32_t）到服务器通过socket发送int ，以网络字节序发送。不期望响应。

指令

参数

value	整数值
socket_name	套接字名称

返回: 返回值

Python函数原型: socketSendInt(self: pyaubo_sdk.Socket, arg0: int, arg1: str) -> int

Lua函数原型: socketSendInt(value: number, socket_name: string) -> nil

◆ socketSendLine()

int arcs::common_interface::Socket::socketSendLine	(	const std::string &	str,
		const std::string &	socket_name = `"socket_0"`
	)

发送带有换行符的字符串到服务器.

通过socket以ASCII编码发送字符串<str>，不期望响应。

指令

参数

str	字符串
socket_name	套接字名称

返回: 返回值

Python函数原型: socketSendLine(self: pyaubo_sdk.Socket, arg0: str, arg1: str) -> int

Lua函数原型: socketSendLine(str: string, socket_name: string) -> nil

JSON-RPC请求示例: {"jsonrpc":"2.0","method":"Socket.socketSendLine","params":["abcd","socket_0"],"id":1}

JSON-RPC响应示例: {"id":1,"jsonrpc":"2.0","result":0}

◆ socketSendString()

int arcs::common_interface::Socket::socketSendString	(	const std::string &	str,
		const std::string &	socket_name = `"socket_0"`
	)

发送字符串到服务器通过socket以ASCII编码发送字符串<str>，不期望响应。

指令

参数

str	字符串
socket_name	套接字名称

返回: 返回值

Python函数原型: socketSendString(self: pyaubo_sdk.Socket, arg0: str, arg1: str) -> int

Lua函数原型: socketSendString(str: string, socket_name: string) -> nil

JSON-RPC请求示例: {"jsonrpc":"2.0","method":"Socket.socketSendString","params":["abcd","socket_0"],"id":1}

JSON-RPC响应示例: {"id":1,"jsonrpc":"2.0","result":0}

类成员变量说明

◆ d_

void* arcs::common_interface::Socket::d_

protected

在文件 socket.h 第 621 行定义.

该类的文档由以下文件生成:

include/aubo/socket.h

Public 成员函数

Protected 属性

详细描述

构造及析构函数说明

◆ Socket()

◆ ~Socket()

成员函数说明

◆ socketClose()

◆ socketHasConnected()

◆ socketOpen()

◆ socketReadAllString()

◆ socketReadAsciiFloat()

◆ socketReadBinaryInteger()

◆ socketReadByteList()

◆ socketReadString()

◆ socketSendAllString()

◆ socketSendByte()

◆ socketSendInt()

◆ socketSendLine()

◆ socketSendString()

类成员变量说明

◆ d_