SC::AsyncLoopTimeout Struct Reference

Starts a Timeout that is invoked only once after expiration (relative) time has passed. More...

#include <Async.h>

Inheritance diagram for SC::AsyncLoopTimeout:

Public Types
using	CompletionData = AsyncCompletionData
	Completion data for AsyncLoopTimeout. More...
using	Result = AsyncResultOf< AsyncLoopTimeout, CompletionData >
	Callback result for AsyncLoopTimeout. More...
Public Types inherited from SC::AsyncRequest
enum class	Type : uint8_t {   LoopTimeout ,   LoopWakeUp ,   LoopWork ,   ProcessExit ,   SocketAccept ,   SocketConnect ,   SocketSend ,   SocketReceive ,   SocketClose ,   FileRead ,   FileWrite ,   FileClose ,   FilePoll }
	Type of async request. More...

Public Member Functions
SC::Result	start (AsyncEventLoop &eventLoop, Time::Milliseconds relativeTimeout)
	Starts a Timeout that is invoked (only once) after the specific relative expiration time has passed. More...
Public Member Functions inherited from SC::AsyncRequest
void	setDebugName (const char *newDebugName)
AsyncEventLoop *	getEventLoop () const
	Get the event loop associated with this AsyncRequest. More...
void	cacheInternalEventLoop (AsyncEventLoop &loop)
	Caches the event loop associated with this AsyncRequest. More...
Result	setThreadPoolAndTask (ThreadPool &pool, AsyncTask &task)
	Sets the thread pool and task to use for this request. More...
void	resetThreadPoolAndTask ()
	Resets anything previously set with setThreadPoolAndTask. More...
	AsyncRequest (Type type)
	Constructs a free async request of given type. More...
Result	stop ()
	Stops the async operation. More...
bool	isFree () const

Public Attributes
Function< void(Result &)>	callback
	Called after given expiration time since AsyncLoopTimeout::start has passed. More...
Time::Milliseconds	relativeTimeout
	Timer expiration (relative) time in milliseconds. More...
Public Attributes inherited from SC::AsyncRequest
AsyncRequest *	next = nullptr
AsyncRequest *	prev = nullptr

Friends
struct	AsyncEventLoop

Additional Inherited Members
Protected Member Functions inherited from SC::AsyncRequest
Result	validateAsync ()
void	queueSubmission (AsyncEventLoop &eventLoop)
Protected Attributes inherited from SC::AsyncRequest
AsyncEventLoop *	eventLoop = nullptr
AsyncTask *	asyncTask = nullptr

Detailed Description

Starts a Timeout that is invoked only once after expiration (relative) time has passed.

Note

For a periodic timeout, call AsyncLoopTimeout::Result::reactivateRequest(true) in the completion callback

// Create a timeout that will be called after 200 milliseconds
// AsyncLoopTimeout must be valid until callback is called
AsyncLoopTimeout timeout;
timeout.callback = [&](AsyncLoopTimeout::Result& res)
{
    console.print("My timeout has been called!");
    if (someCondition) // Optionally re-activate the timeout if needed
    {
        // Schedule the timeout callback to fire again 100 ms from now
        res.getAsync().relativeTimeout = Time::Milliseconds(100);
        res.reactivateRequest(true);
    }
};
// Start the timeout, that will be called 200 ms from now
SC_TRY(timeout.start(eventLoop, Time::Milliseconds(200)));

Member Typedef Documentation

CompletionData

using SC::AsyncLoopTimeout::CompletionData = AsyncCompletionData

Completion data for AsyncLoopTimeout.

Result

using SC::AsyncLoopTimeout::Result = AsyncResultOf<AsyncLoopTimeout, CompletionData>

Callback result for AsyncLoopTimeout.

Member Function Documentation

start()

SC::Result SC::AsyncLoopTimeout::start	(	AsyncEventLoop &	eventLoop,
		Time::Milliseconds	relativeTimeout
	)

Starts a Timeout that is invoked (only once) after the specific relative expiration time has passed.

Parameters

eventLoop	The event loop where queuing this async request
relativeTimeout	Relative time in milliseconds after which callback will be called

Returns

Valid Result if the request has been successfully queued

Note

For a periodic timeout, call AsyncLoopTimeout::Result::reactivateRequest(true) in the completion callback

Member Data Documentation

callback

Function<void(Result&)> SC::AsyncLoopTimeout::callback

Called after given expiration time since AsyncLoopTimeout::start has passed.

relativeTimeout

Time::Milliseconds SC::AsyncLoopTimeout::relativeTimeout

Timer expiration (relative) time in milliseconds.

---

The documentation for this struct was generated from the following file:

• Async.h