SAMPHubServer#

class astropy.samp.SAMPHubServer(secret=None, addr=None, port=0, lockfile=None, timeout=0, client_timeout=0, mode='single', label='', web_profile=True, web_profile_dialog=None, web_port=21012, pool_size=20)[源代码]#

基类:object

SAMP集线器服务器。

参数:
secret : str ,可选Python:字符串,可选

用于SAMP锁文件的密码。如果未指定,则 uuid.uuid1() 函数用于生成一个。

addr : str ,可选Python:字符串,可选

监听地址(或IP)。如果无法访问internet,则默认为127.0.0.1,否则默认为主机名。

port : int ,可选PYTHON:int,可选

正在侦听XML-RPC服务器套接字端口。如果left设置为0(默认值),操作系统将选择一个空闲端口。

lockfile : str ,可选Python:字符串,可选

自定义锁文件名。

timeout : int ,可选PYTHON:int,可选

集线器不活动超时。如果 timeout > 0 然后,在不活动时间超过 timeout 秒。默认情况下 timeout 设置为0(集线器永不过期)。

client_timeout : int ,可选PYTHON:int,可选

客户端不活动超时。如果 client_timeout > 0 然后,集线器会自动注销导致不活动时间超过 client_timeout 秒。默认情况下 client_timeout 设置为0(客户端永不过期)。

mode : str ,可选Python:字符串,可选

定义集线器运行模式。如果 mode'single' 然后集线器使用标准 .samp 锁定文件,为用户桌面会话提供一个实例。否则,如果 mode'multiple' ,则集线器使用非标准锁文件运行,该文件位于 .samp-1 目录,窗体的 samp-hub-<UUID> 在哪里 <UUID> 是分配给集线器的唯一UUID。

label : str ,可选Python:字符串,可选

一个字符串,用于用人类可读的名称标记集线器。此字符串将写入分配给 hub.label 令牌。

web_profile : bool ,可选可选的布尔

启用或禁用Web配置文件支持。

web_profile_dialog可选类

允许使用指定类实例 web_profile_dialog 将基于终端的消息替换为GUI弹出窗口。二 queue.Queue 实例将作为属性添加到实例中 queue_requestqueue_result . 当通过 queue_request 队列,则应显示弹出窗口,并且值为 TrueFalse 应添加到 queue_result 取决于用户是接受还是拒绝连接。

web_port : int ,可选PYTHON:int,可选

用于web SAMP的端口。除非出于web测试目的,否则不应更改端口210P。

pool_size : int ,可选PYTHON:int,可选

为与客户端通信而打开的套接字连接数。

属性摘要

id 

唯一的集线器ID。

is_running 

返回有关集线器运行状态的信息。

params 

集线器参数(写入日志文件)。

方法总结

get_mtype_subtypes \(mtype)

返回一个包含MType所有可能的通配符子类型的列表。

start([wait])

启动当前的samphub实例并创建锁文件。

stop \()

停止当前的SAMP Hub实例并删除锁文件。

属性文档

id#

唯一的集线器ID。

is_running#

返回有关集线器运行状态的信息。

返回:
running : bool布尔

集线器在运行吗?

params#

集线器参数(写入日志文件)。

方法文件

static get_mtype_subtypes(mtype)[源代码]#

返回一个包含MType所有可能的通配符子类型的列表。

参数:
mtype : strPython :字符串

要分析的MType。

返回:
types : listPython :列表

子类型列表

实例

>>> from astropy.samp import SAMPHubServer
>>> SAMPHubServer.get_mtype_subtypes("samp.app.ping")
['samp.app.ping', 'samp.app.*', 'samp.*', '*']
start(wait=False)[源代码]#

启动当前的samphub实例并创建锁文件。集线器启动可以是阻塞式或非阻塞式,具体取决于 wait 参数。

参数:
wait : bool布尔

如果 True 然后Hub进程与调用者连接,阻塞代码流。通常 True 选项用于在可执行脚本中运行独立集线器。如果 False (默认),然后集线器进程在单独的线程中运行。 False 通常在Python shell中使用。

stop()[源代码]#

停止当前的SAMP Hub实例并删除锁文件。