SC::AsyncSocketClose Struct Reference

Starts a socket close operation. More...

#include <Async.h>

Inheritance diagram for SC::AsyncSocketClose:

Public Types
using	CompletionData = AsyncCompletionData
	Completion data for AsyncSocketClose. More...
using	Result = AsyncResultOf< AsyncSocketClose, CompletionData >
	Callback result for AsyncSocketClose. 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, const SocketDescriptor &socketDescriptor)
	Starts a socket close operation. 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
int	code = 0
	Return code of close socket operation. More...
Function< void(Result &)>	callback
	Callback called after fully closing the socket. 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 socket close operation.

Callback will be called when the socket has been fully closed.

// Assuming an already created (and running) AsyncEventLoop named `eventLoop`
// and a connected or accepted socket named `client`
// ...
AsyncSocketClose asyncClose;
 
asyncClose.callback = [&](AsyncSocketClose::Result& result)
{
    if(result.isValid())
    {
        console.printLine("Socket was closed successfully");
    }
};
SC_TRY(asyncClose.start(eventLoop, client));
 

Member Typedef Documentation

CompletionData

using SC::AsyncSocketClose::CompletionData = AsyncCompletionData

Completion data for AsyncSocketClose.

Result

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

Callback result for AsyncSocketClose.

Member Function Documentation

start()

SC::Result SC::AsyncSocketClose::start	(	AsyncEventLoop &	eventLoop,
		const SocketDescriptor &	socketDescriptor
	)

Starts a socket close operation.

Callback will be called when the socket has been fully closed.

Parameters

eventLoop	The event loop where queuing this async request
socketDescriptor	The socket to be closed

Returns

Valid Result if the request has been successfully queued

Member Data Documentation

callback

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

Callback called after fully closing the socket.

code

int SC::AsyncSocketClose::code = 0

Return code of close socket operation.

---

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

• Async.h