EmbeddedEventLoop

public final class EmbeddedEventLoop : EventLoop

An EventLoop that is embedded in the current running context with no external control.

Unlike more complex EventLoops, such as SelectableEventLoop, the EmbeddedEventLoop has no proper eventing mechanism. Instead, reads and writes are fully controlled by the entity that instantiates the EmbeddedEventLoop. This property makes EmbeddedEventLoop of limited use for many application purposes, but highly valuable for testing and other kinds of mocking.

Time is controllable on an EmbeddedEventLoop. It begins at NIODeadline.uptimeNanoseconds(0) and may be advanced by a fixed amount by using advanceTime(by:), or advanced to a point in time with advanceTime(to:).

Warning

Unlike SelectableEventLoop, EmbeddedEventLoop is not thread-safe. This is because it is intended to be run in the thread that instantiated it. Users are responsible for ensuring they never call into the EmbeddedEventLoop in an unsynchronized fashion.

Show on GitHub

inEventLoop
See
EventLoop.inEventLoop
Declaration
Swift

public var inEventLoop: Bool { get }
Show on GitHub
init()
Initialize a new EmbeddedEventLoop.
Declaration
Swift

public init()
Show on GitHub


                    
                    
                    scheduleTask(deadline:_:)

See

EventLoop.scheduleTask(deadline:_:)

Declaration

Swift

@discardableResult
public func scheduleTask<T>(deadline: NIODeadline, _ task: @escaping () throws -> T) -> Scheduled<T>

Show on GitHub


                    
                    
                    scheduleTask(in:_:)

See

EventLoop.scheduleTask(in:_:)

Declaration

Swift

@discardableResult
public func scheduleTask<T>(in: TimeAmount, _ task: @escaping () throws -> T) -> Scheduled<T>

Show on GitHub

execute(_:)
On an EmbeddedEventLoop, execute will simply use scheduleTask with a deadline of now. This means that task will be run the next time you call EmbeddedEventLoop.run.
Declaration
Swift

public func execute(_ task: @escaping () -> Void)
Show on GitHub
run()
Run all tasks that have previously been submitted to this EmbeddedEventLoop, either by calling execute or events that have been enqueued using scheduleTask/scheduleRepeatedTask/scheduleRepeatedAsyncTask and whose deadlines have expired.

Seealso
EmbeddedEventLoop.advanceTime.
Declaration
Swift

public func run()
Show on GitHub
advanceTime(by:)
Runs the event loop and moves “time” forward by the given amount, running any scheduled tasks that need to be run.
Declaration
Swift

public func advanceTime(by increment: TimeAmount)
Show on GitHub
advanceTime(to:)
Runs the event loop and moves “time” forward to the given point in time, running any scheduled tasks that need to be run.

Note
If deadline is before the current time, the current time will not be advanced.
Declaration
Swift

public func advanceTime(to deadline: NIODeadline)
Show on GitHub


                    
                    
                    shutdownGracefully(queue:_:)

See

EventLoop.shutdownGracefully

Declaration

Swift

public func shutdownGracefully(queue: DispatchQueue, _ callback: @escaping (Error?) -> Void)

Show on GitHub