SC::AsyncFileClose Struct Reference

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.
using	Result = AsyncResultOf<AsyncFileClose, CompletionData>
	Callback result for AsyncFileClose.
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)
	Sets async request members and calls AsyncEventLoop::start.
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
int	code = 0
	Return code of close socket operation.
Function< void(Result &)>	callback
	Callback called after fully closing the file descriptor.
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 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;
File::OpenOptions options;
options.blocking = false;
SC_TRY(File(fd).open("MyFile.txt", File::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 Function Documentation

start()

SC::Result SC::AsyncFileClose::start	(	AsyncEventLoop &	eventLoop,
		FileDescriptor::Handle	fileDescriptor )

Sets async request members and calls AsyncEventLoop::start.

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