events_streaming

Module for events management.

Classes:

EventsManager(session_events_service, ...)

Manages server-side events.

class ansys.cfx.core.streaming_services.events_streaming.EventsManager(session_events_service, cfx_error_state, session_id)

Bases: StreamingService

Manages server-side events.

This class allows the client to register and unregister callbacks with server events.

Parameters:

sessionBaseSession

CFX session object.

Attributes:

events_listList[str]

List of supported events.

Methods:

__init__(session_events_service, ...)	Initialize an instance of the EventsManager class.
register_callback(event_name, callback, ...)	Register the callback.
unregister_callback(callback_id)	Unregister the callback.

Attributes:

events_list

List of supported events.

__init__(session_events_service, cfx_error_state, session_id)

Initialize an instance of the EventsManager class.

property events_list: List[str]

List of supported events.

Parameters:

None

Returns:

List[str]

List of supported events.

register_callback(event_name: str, callback: Callable, *args, **kwargs)

Register the callback.

Parameters:

event_namestr

Event name to register the callback to.

callbackCallable

Callback to register.

argsAny

Arguments.

kwargsAny

Keyword arguments.

Returns:

str

Registered callback ID.

Raises:

InvalidArgument

If event name is not valid.

DisallowedValuesError

If an argument value is not in the allowed values.

unregister_callback(callback_id: str)

Unregister the callback.

Parameters:

callback_idstr

ID of the registered callback.