Instance Methodswift-nio 2.72.0NIOCore
flatScheduleTask(in:file:line:_:)
Schedule a task that is executed by this EventLoop after the given amount of time.
@discardableResult @preconcurrency func flatScheduleTask<T>(in delay: TimeAmount, file: StaticString = #fileID, line: UInt = #line, _ task: @escaping () throws -> EventLoopFuture<T>) -> Scheduled<T> Parameters
- task
The asynchronous task to run. As everything that runs on the
EventLoop, it must not block.
Returns
A Scheduled object which may be used to cancel the task if it has not yet run, or to wait on the full execution of the task, including its returned EventLoopFuture.
Other members in extension
Instance members
var executor: any SerialExecutorfunc any() -> EventLoop An
EventLoopforms a singularEventLoopGroup, returning itself as ‘any’EventLoop.func assertInEventLoop(file: StaticString, line: UInt) Asserts that the current thread is the one tied to this
EventLoop. Otherwise, if running in debug mode, the process will be abnormally terminated as per the semantics ofpreconditionFailure(_:file:line:). Never has any effect in release mode.func assertNotInEventLoop(file: StaticString, line: UInt) Asserts that the current thread is not the one tied to this
EventLoop. Otherwise, if running in debug mode, the process will be abnormally terminated as per the semantics ofpreconditionFailure(_:file:line:). Never has any effect in release mode.func close() throws Close this
EventLoop.func enqueue(consuming ExecutorJob) func flatScheduleTask<T>(deadline: NIODeadline, file: StaticString, line: UInt, @escaping () throws -> EventLoopFuture<T>) -> Scheduled<T> Schedule a
taskthat is executed by thisEventLoopat the given time.func flatSubmit<T>(@escaping () -> EventLoopFuture<T>) -> EventLoopFuture<T> Submit
taskto be run on thisEventLoop.func makeCompletedFuture<Success>(Result<Success, Error>) -> EventLoopFuture<Success> Creates and returns a new
EventLoopFuturethat is marked as succeeded or failed with the value held byresult.func makeCompletedFuture<Success>(withResultOf: () throws -> Success) -> EventLoopFuture<Success> Creates and returns a new
EventLoopFuturethat is marked as succeeded or failed with the value returned bybody.func makeFailedFuture<T>(Error) -> EventLoopFuture<T> Creates and returns a new
EventLoopFuturethat is already marked as failed. Notifications will be done using thisEventLoopas executionNIOThread.func makeFutureWithTask<Return>(@escaping () async throws -> Return) -> EventLoopFuture<Return> func makeIterator() -> EventLoopIterator Returns an
EventLoopIteratorover thisEventLoop.func makePromise<T>(of: T.Type, file: StaticString, line: UInt) -> EventLoopPromise<T> Creates and returns a new
EventLoopPromisethat will be notified using thisEventLoopas executionNIOThread.func makeSucceededFuture<Success>(Success) -> EventLoopFuture<Success> Creates and returns a new
EventLoopFuturethat is already marked as success. Notifications will be done using thisEventLoopas executionNIOThread.func makeSucceededVoidFuture() -> EventLoopFuture<Void> Default implementation of
makeSucceededVoidFuture: Return a fresh future (which will allocate).func next() -> EventLoop An
EventLoopforms a singularEventLoopGroup, returning itself as the ‘next’EventLoop.func preconditionInEventLoop(file: StaticString, line: UInt) Checks the necessary condition of currently running on the called
EventLoopfor making forward progress.func preconditionNotInEventLoop(file: StaticString, line: UInt) Checks the necessary condition of currently not running on the called
EventLoopfor making forward progress.func scheduleRepeatedAsyncTask(initialDelay: TimeAmount, delay: TimeAmount, maximumAllowableJitter: TimeAmount, notifying: EventLoopPromise<Void>?, @escaping (RepeatedTask) -> EventLoopFuture<Void>) -> RepeatedTask Schedule a repeated asynchronous task to be executed by the
EventLoopwith a fixed delay between the end and start of each task.func scheduleRepeatedAsyncTask(initialDelay: TimeAmount, delay: TimeAmount, notifying: EventLoopPromise<Void>?, @escaping (RepeatedTask) -> EventLoopFuture<Void>) -> RepeatedTask Schedule a repeated asynchronous task to be executed by the
EventLoopwith a fixed delay between the end and start of each task.func scheduleRepeatedTask(initialDelay: TimeAmount, delay: TimeAmount, maximumAllowableJitter: TimeAmount, notifying: EventLoopPromise<Void>?, @escaping (RepeatedTask) throws -> Void) -> RepeatedTask Schedule a repeated task to be executed by the
EventLoopwith a fixed delay between the end and start of each task.func scheduleRepeatedTask(initialDelay: TimeAmount, delay: TimeAmount, notifying: EventLoopPromise<Void>?, @escaping (RepeatedTask) throws -> Void) -> RepeatedTask Schedule a repeated task to be executed by the
EventLoopwith a fixed delay between the end and start of each task.func submit<T>(@escaping () throws -> T) -> EventLoopFuture<T> Submit
taskto be run on thisEventLoop.
Show implementation details (3)
Hide implementation details
func _preconditionSafeToWait(file: StaticString, line: UInt) func _promiseCompleted(futureIdentifier: _NIOEventLoopFutureIdentifier) -> (file: StaticString, line: UInt)? Default implementation of
_promiseCompleted: does nothing.func _promiseCreated(futureIdentifier: _NIOEventLoopFutureIdentifier, file: StaticString, line: UInt) Default implementation of
_promiseCreated: does nothing.