SC::AsyncFilePoll Struct Reference

Starts an handle polling operation. More...

#include <Async.h>

Inheritance diagram for SC::AsyncFilePoll:

Public Types
using	CompletionData = AsyncCompletionData
using	Result = AsyncResultOf<AsyncFilePoll, CompletionData>
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 &loop, FileDescriptor::Handle fileDescriptor)
	Starts a file descriptor poll operation, monitoring its readiness with appropriate OS API.
Public Member Functions inherited from SC::AsyncRequest
void	setDebugName (const char *newDebugName)
AsyncEventLoop *	getEventLoop () const
	Get the event loop associated with this AsyncRequest.
void	cacheInternalEventLoop (AsyncEventLoop &loop)
	Caches the event loop associated with this AsyncRequest.
Result	setThreadPoolAndTask (ThreadPool &pool, AsyncTask &task)
	Sets the thread pool and task to use for this request.
void	resetThreadPoolAndTask ()
	Resets anything previously set with setThreadPoolAndTask.
	AsyncRequest (Type type)
	Constructs a free async request of given type.
Result	stop (Function< void(AsyncResult &)> *afterStopped=nullptr)
	Ask to stop current async operation.
bool	isFree () const
	Returns true if this request is free.
bool	isCancelling () const
	Returns true if this request is being cancelled.
bool	isActive () const
	Returns true if this request is active or being reactivated.
Type	getType () const
	Returns request type.
Result	start (AsyncEventLoop &loop)
	Shortcut for AsyncEventLoop::start.

Public Attributes
Function< void(Result &)>	callback
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	checkState ()
void	queueSubmission (AsyncEventLoop &eventLoop)
Protected Attributes inherited from SC::AsyncRequest
AsyncEventLoop *	eventLoop = nullptr
AsyncTask *	asyncTask = nullptr

Detailed Description

Starts an handle polling operation.

Uses GetOverlappedResult (windows), kevent (macOS), epoll (Linux) and io_uring (Linux). Callback will be called when any of the three API signals readiness events on the given file descriptor. Check File System Watcher for an example usage of this notification.

Member Function Documentation

start()

SC::Result SC::AsyncFilePoll::start	(	AsyncEventLoop &	loop,
		FileDescriptor::Handle	fileDescriptor )

Starts a file descriptor poll operation, monitoring its readiness with appropriate OS API.

---

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

• Async.h