register_listener

ansys.optislang.core.tcp.server_commands.register_listener(id: str | None = None, host: str | None = None, port: int | None = None, timeout: int | None = None, notifications: Iterable[str] | None = None, password: str | None = None, listener_uid: str | None = None) → str

Generate JSON string of register_listener command.

Parameters:

id: Optional[str], optional

Id of the local listener, by default None.

host: Optional[str], optional

IP of the TCP listener, by default None.

port: Optional[int], optional

Port of the TCP listener, by default None.

timeout: Optional[int], optional

Unregister policy timeout in ms, default 60000 ms, by default None.

notifications: Optional[Sequence], optional

Notifications, by default None.

passwordOptional[str], optional

Password, by default None.

listener_uidOptional[str], optional

Listener UID, by default None.

Returns:

str

JSON string of register_listener command.