Starts a file close operation, closing the OS file descriptor. More...

#include <Async.h>

Inheritance diagram for SC::AsyncFileClose:

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

using	Result = AsyncResultOf< AsyncFileClose, CompletionData >
	Callback result for AsyncFileClose. 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, FileDescriptor::Handle fileDescriptor)

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
int	code = 0
	Return code of close socket operation. More...

Function< void(Result &)>	callback
	Callback called after fully closing the file descriptor. 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 file close operation, closing the OS file descriptor.

Callback will be called when the file is actually closed.
File library can be used to open the file and obtain a blocking or non-blocking file descriptor handle.

// Assuming an already created (and running) AsyncEventLoop named eventLoop
// ...
 
// Open a file and associated it with event loop
FileDescriptor fd;
FileDescriptor::OpenOptions options;
options.blocking = false;
SC_TRY(fd.open("MyFile.txt", FileDescriptor::WriteCreateTruncate, options));
SC_TRY(eventLoop.associateExternallyCreatedFileDescriptor(fd));
 
// Create the file close request
FileDescriptor::Handle handle;
SC_TRY(fd.get(handle, Result::Error("handle")));
AsyncFileClose asyncFileClose;
asyncFileClose.callback = [&](AsyncFileClose::Result& result)
{
    if(result.isValid())
    {
        console.printLine("File was closed successfully");
    }
};
SC_TRY(asyncFileClose.start(eventLoop, handle));

Member Typedef Documentation

◆ CompletionData

using SC::AsyncFileClose::CompletionData = AsyncCompletionData

Completion data for AsyncFileClose.

◆ Result

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

Callback result for AsyncFileClose.

Member Data Documentation

◆ callback

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

Callback called after fully closing the file descriptor.

◆ code

int SC::AsyncFileClose::code = 0

Return code of close socket operation.

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

Async.h

Public Types

Public Member Functions

Public Attributes

Friends