UniPRT SDK v1.0.0.0
 
载入中...
搜索中...
未找到
TcpComm.TcpComm类 参考

Public 成员函数

None __init__ (self, str ipAddress, int port)
 初始化一个新的实例,使用指定的 IP 地址和端口号。
 
"TcpComm" from_descriptor (cls, str descriptor, DescriptorPortType port_type)
 从描述符字符串和端口类型创建一个 TcpComm 对象。
 
None open (self)
 打开与TCP服务器的连接。
 
str get_ip_address (self)
 获取远程服务器的IP地址。
 
 connection_settings (self, ip_address, port)
 使用指定的IP地址和端口配置连接设置。
 
bool is_connected (self)
 指示连接是否已建立的标志。
 
None close (self)
 关闭与TCP服务器的连接。
 
None write (self, bytes text)
 将数据写入TCP服务器。
 
Optional[bytes] read (self)
 从TCP服务器读取数据。
 
None wait_for_data (self, int msTimeout)
 等待TCP连接上有数据可用。
 
Optional[bytes] write_and_wait_for_response (self, bytes text, int responseStartTimeout, int responseEndTimeout, str completionToken="")
 将数据写入TCP服务器并等待响应。
 
Optional[bytes] write_and_wait_for_response_json (self, bytes text, int responseStartTimeout, int responseEndTimeout, str completionToken="")
 将JSON数据写入TCP服务器并等待响应。
 
 write_printer_file (self, str fileName)
 将文件写入印表机。
 
None send_printer_file (self, str ipAddress, str fileName)
 发送打印文件到指定的IP地址。
 
None send_print_string (self, str ipAddress, bytes data)
 使用 TSPLPGL 将打印字符串发送到指定的IP地址。
 

静态 Public 成员函数

Tuple[str, int] parse_descriptor (str descriptor, DescriptorPortType port_type)
 
str descriptor_validate (str descriptor_hint, DescriptorPortType port_type_hint)
 使用指定的提示和端口类型验证描述符。
 
str descriptor_use_ip (str ip, int port)
 使用指定的IP和端口返回一个描述符字符串。
 

Protected 属性

 _socket
 
 _ip
 
 _port
 
 _connected
 

构造及析构函数说明

◆ __init__()

None TcpComm.TcpComm.__init__ ( self,
str ipAddress,
int port )

初始化一个新的实例,使用指定的 IP 地址和端口号。

参数
ipAddressTCP 服务器的 IP 地址。
portTCP 服务器的端口号。

成员函数说明

◆ close()

None TcpComm.TcpComm.close ( self)

关闭与TCP服务器的连接。

◆ connection_settings()

TcpComm.TcpComm.connection_settings ( self,
ip_address,
port )

使用指定的IP地址和端口配置连接设置。

参数
ip_address远程服务器的IP地址。
port连接到远程服务器的端口号。

◆ descriptor_use_ip()

str TcpComm.TcpComm.descriptor_use_ip ( str ip,
int port )
static

使用指定的IP和端口返回一个描述符字符串。

参数
ip用于描述符的IP地址。
port用于描述符的端口。
返回
一个描述符字符串。

◆ descriptor_validate()

str TcpComm.TcpComm.descriptor_validate ( str descriptor_hint,
DescriptorPortType port_type_hint )
static

使用指定的提示和端口类型验证描述符。

参数
descriptor_hint描述符的提示。
port_type_hint要验证的端口类型。
返回
一个验证后的描述符字符串。

◆ from_descriptor()

"TcpComm" TcpComm.TcpComm.from_descriptor ( cls,
str descriptor,
DescriptorPortType port_type )

从描述符字符串和端口类型创建一个 TcpComm 对象。

参数
descriptor表示连接的描述符字符串。
port_type要用于连接的端口类型。
返回
TcpComm 类的一个实例。

◆ get_ip_address()

str TcpComm.TcpComm.get_ip_address ( self)

获取远程服务器的IP地址。

返回
远程服务器的IP地址。

◆ is_connected()

bool TcpComm.TcpComm.is_connected ( self)

指示连接是否已建立的标志。

返回
如果连接已打开,则返回True,否则返回False。

◆ open()

None TcpComm.TcpComm.open ( self)

打开与TCP服务器的连接。

◆ parse_descriptor()

Tuple[str, int] TcpComm.TcpComm.parse_descriptor ( str descriptor,
DescriptorPortType port_type )
static

◆ read()

Optional[bytes] TcpComm.TcpComm.read ( self)

从TCP服务器读取数据。

返回
从服务器读取的数据。

◆ send_print_string()

None TcpComm.TcpComm.send_print_string ( self,
str ipAddress,
bytes data )

使用 TSPLPGL 将打印字符串发送到指定的IP地址。

参数
ipAddress印表机的IP地址。
data要打印的数据。

◆ send_printer_file()

None TcpComm.TcpComm.send_printer_file ( self,
str ipAddress,
str fileName )

发送打印文件到指定的IP地址。

参数
ipAddress印表机的IP地址。
fileName要打印的文件名。

◆ wait_for_data()

None TcpComm.TcpComm.wait_for_data ( self,
int msTimeout )

等待TCP连接上有数据可用。

参数
msTimeout超时间隔(毫秒)。

◆ write()

None TcpComm.TcpComm.write ( self,
bytes text )

将数据写入TCP服务器。

参数
text要写入服务器的数据。

◆ write_and_wait_for_response()

Optional[bytes] TcpComm.TcpComm.write_and_wait_for_response ( self,
bytes text,
int responseStartTimeout,
int responseEndTimeout,
str completionToken = "" )

将数据写入TCP服务器并等待响应。

参数
text要写入服务器的数据。
responseStartTimeout响应开始的超时间隔。
responseEndTimeout响应结束的超时间隔。
completionToken表示响应完成的令牌。
返回
从服务器接收到的响应数据。

◆ write_and_wait_for_response_json()

Optional[bytes] TcpComm.TcpComm.write_and_wait_for_response_json ( self,
bytes text,
int responseStartTimeout,
int responseEndTimeout,
str completionToken = "" )

将JSON数据写入TCP服务器并等待响应。

参数
text要写入服务器的JSON数据。
responseStartTimeout响应开始的超时间隔。
responseEndTimeout响应结束的超时间隔。
completionToken表示响应完成的令牌。
返回
从服务器接收到的响应数据。

◆ write_printer_file()

TcpComm.TcpComm.write_printer_file ( self,
str fileName )

将文件写入印表机。

参数
fileName要写入印表机的文件名。

类成员变量说明

◆ _connected

TcpComm.TcpComm._connected
protected

◆ _ip

TcpComm.TcpComm._ip
protected

◆ _port

TcpComm.TcpComm._port
protected

◆ _socket

TcpComm.TcpComm._socket
protected

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