Single threaded event processing loop interface. Implementations accept queue'd actions to be processed within the event loop in serial fashion. More...
Public Member Functions | |
| void | Execute (Action action) |
| Execute some action at a future time in order of submission. The event loop implementation must guarantee that events never execute concurrently or out of order. More... | |
| bool | WaitForTermination (TimeSpan waitTime) |
| Allows a caller to wait the given time span for the service to completely shut down and terminate all service operations. If the wait return before the service has fully shutdown it will return false. More... | |
| void | Shutdown () |
| Requests an orderly shut down of the service whereby previously submitted tasks will still be allowed to execute but any new tasks will be rejected. More... | |
Properties | |
| bool | InEventLoop [get] |
| Returns if the code currently executing is operating within the context of the event loop thread or not. More... | |
| bool | IsShutdown [get] |
| Returns true if the service has been shutdown. More... | |
| bool | IsTerminated [get] |
| Returns true if a service that was shutdown has completed all shutdown operations. More... | |
Detailed Description
Single threaded event processing loop interface. Implementations accept queue'd actions to be processed within the event loop in serial fashion.
Member Function Documentation
◆ Execute()
| void Apache.Qpid.Proton.Client.Concurrent.IEventLoop.Execute | ( | Action | action | ) |
Execute some action at a future time in order of submission. The event loop implementation must guarantee that events never execute concurrently or out of order.
- Parameters
-
action The action to be performed
- Exceptions
-
ArgumentNullException If the provided action is null RejectedExecutionException If the action is rejected
Implemented in Apache.Qpid.Proton.Client.Concurrent.DefaultEventLoop.
◆ Shutdown()
| void Apache.Qpid.Proton.Client.Concurrent.IEventLoop.Shutdown | ( | ) |
Requests an orderly shut down of the service whereby previously submitted tasks will still be allowed to execute but any new tasks will be rejected.
Implemented in Apache.Qpid.Proton.Client.Concurrent.DefaultEventLoop.
◆ WaitForTermination()
| bool Apache.Qpid.Proton.Client.Concurrent.IEventLoop.WaitForTermination | ( | TimeSpan | waitTime | ) |
Allows a caller to wait the given time span for the service to completely shut down and terminate all service operations. If the wait return before the service has fully shutdown it will return false.
- Parameters
-
waitTime The time to wait for complete shutdown
- Returns
- true if the service fully shut down, otherwise returns false.
Implemented in Apache.Qpid.Proton.Client.Concurrent.DefaultEventLoop.
Property Documentation
◆ InEventLoop
|
get |
Returns if the code currently executing is operating within the context of the event loop thread or not.
◆ IsShutdown
|
get |
Returns true if the service has been shutdown.
◆ IsTerminated
|
get |
Returns true if a service that was shutdown has completed all shutdown operations.
The documentation for this interface was generated from the following file:
- src/Proton.Client/Client/Concurrent/IEventLoop.cs
