Events#

High-level events wrappers.

This module owns the business-logic layer on top of the Events gRPC service. The grpc service implementation lives in:

  • ansys.fluent.core._grpc_services.events_service (v1 proto API)

  • ansys.fluent.core._grpc_services.events_service_v0 (v0 proto API)

Class hierarchy#

Events

gRPC-based implementation (v1 proto API).

EventsV261

Hybrid implementation for 26R1: event streaming over gRPC and pause/resume registration delegated to application runtime.

EventsV251

Hybrid implementation for 25R1: event streaming over gRPC and pause/resume registration delegated to Scheme.

Classes:

Events(service)

Events backed by the Events gRPC service.

EventsV251(service, scheme_interpreter_service)

Events backed by the Events gRPC service.

EventsV261(service, application_runtime_service)

Events backed by the Events gRPC service.
class ansys.fluent.core.services.events.Events(service)#

Bases: AbstractEvents

Events backed by the Events gRPC service.

Methods:

__init__(service)

Initialize Events.

begin_streaming(request, started_evt, id, ...)

Begin streaming from Fluent.

end_streaming(id, stream_begin_method)

End streaming from Fluent.

event_from_proto_field(field_name)

Convert a proto oneof field name to canonical event enum value.

register_pause_on_solution_events(solution_event)

Register pause on solution events.

resume_on_solution_event(registration_id)

Resume on solution event.

unregister_pause_on_solution_events(...)

Unregister pause on solution events.
__init__(service)#

Initialize Events.

begin_streaming(request, started_evt, id, stream_begin_method)#

Begin streaming from Fluent.

end_streaming(id, stream_begin_method)#

End streaming from Fluent.

event_from_proto_field(field_name)#

Convert a proto oneof field name to canonical event enum value.

register_pause_on_solution_events(solution_event)#

Register pause on solution events.

resume_on_solution_event(registration_id)#

Resume on solution event.

unregister_pause_on_solution_events(registration_id)#

Unregister pause on solution events.

class ansys.fluent.core.services.events.EventsV251(service, scheme_interpreter_service)#

Bases: AbstractEvents

Events backed by the Events gRPC service.

Methods:

__init__(service, scheme_interpreter_service)

Initialize ApplicationRuntime.

begin_streaming(request, started_evt, id, ...)

Begin streaming from Fluent.

end_streaming(id, stream_begin_method)

End streaming from Fluent.

event_from_proto_field(field_name)

Convert a proto oneof field name to canonical event enum value.

register_pause_on_solution_events(solution_event)

Register pause on solution events.

resume_on_solution_event(registration_id)

Resume on solution event.

unregister_pause_on_solution_events(...)

Unregister pause on solution events.
__init__(service, scheme_interpreter_service)#

Initialize ApplicationRuntime.

begin_streaming(request, started_evt, id, stream_begin_method)#

Begin streaming from Fluent.

end_streaming(id, stream_begin_method)#

End streaming from Fluent.

event_from_proto_field(field_name)#

Convert a proto oneof field name to canonical event enum value.

register_pause_on_solution_events(solution_event)#

Register pause on solution events.

resume_on_solution_event(registration_id)#

Resume on solution event.

unregister_pause_on_solution_events(registration_id)#

Unregister pause on solution events.

class ansys.fluent.core.services.events.EventsV261(service, application_runtime_service)#

Bases: AbstractEvents

Events backed by the Events gRPC service.

Methods:

__init__(service, application_runtime_service)

Initialize ApplicationRuntime.

begin_streaming(request, started_evt, id, ...)

Begin streaming from Fluent.

end_streaming(id, stream_begin_method)

End streaming from Fluent.

event_from_proto_field(field_name)

Convert a proto oneof field name to canonical event enum value.

register_pause_on_solution_events(solution_event)

Register pause on solution events.

resume_on_solution_event(registration_id)

Resume on solution event.

unregister_pause_on_solution_events(...)

Unregister pause on solution events.
__init__(service, application_runtime_service)#

Initialize ApplicationRuntime.

begin_streaming(request, started_evt, id, stream_begin_method)#

Begin streaming from Fluent.

end_streaming(id, stream_begin_method)#

End streaming from Fluent.

event_from_proto_field(field_name)#

Convert a proto oneof field name to canonical event enum value.

register_pause_on_solution_events(solution_event)#

Register pause on solution events.

resume_on_solution_event(registration_id)#

Resume on solution event.

unregister_pause_on_solution_events(registration_id)#

Unregister pause on solution events.