Instance Methodswift-nio 2.72.0NIOCore
scheduleRepeatedTask(initialDelay:delay:maximumAllowableJitter:notifying:_:)
Schedule a repeated task to be executed by the EventLoop with a fixed delay between the end and start of each task.
@discardableResult func scheduleRepeatedTask(initialDelay: TimeAmount, delay: TimeAmount, maximumAllowableJitter: TimeAmount, notifying promise: EventLoopPromise<Void>? = nil, _ task: @escaping (RepeatedTask) throws -> Void) -> RepeatedTask Parameters
- initialDelay
The delay after which the first task is executed.
- delay
The delay between the end of one task and the start of the next.
- maximumAllowableJitter
Exclusive upper bound of jitter range added to the
delayparameter.- promise
If non-nil, a promise to fulfill when the task is cancelled and all execution is complete.
- task
The closure that will be executed.
return:
RepeatedTask
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 flatScheduleTask<T>(in: TimeAmount, file: StaticString, line: UInt, @escaping () throws -> EventLoopFuture<T>) -> Scheduled<T> Schedule a
taskthat is executed by thisEventLoopafter the given amount of 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, 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.