Starts an handle polling operation. More...

#include <Async.h>

Inheritance diagram for SC::AsyncFilePoll:

Public Types
using	CompletionData = AsyncCompletionData
	Completion data for AsyncFilePoll. More...

using	Result = AsyncResultOf< AsyncFilePoll, CompletionData >
	Callback result for AsyncFilePoll. 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 &loop, FileDescriptor::Handle fileDescriptor)
	Starts a file descriptor poll operation, monitoring its readiness with appropriate OS API. 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...

	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

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 ()

Result	queueSubmission (AsyncEventLoop &eventLoop)

Result	queueSubmission (AsyncEventLoop &eventLoop, ThreadPool &threadPool, AsyncTask &task)

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 Typedef Documentation

◆ CompletionData

using SC::AsyncFilePoll::CompletionData = AsyncCompletionData

Completion data for AsyncFilePoll.

◆ Result

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

Callback result for AsyncFilePoll.

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

Public Types

Public Member Functions

Public Attributes