Sane C++ Libraries
C++ Platform Abstraction Libraries
SC::AsyncSocketReceive::Result Struct Reference

Callback result for AsyncSocketReceive. More...

#include <Async.h>

Inheritance diagram for SC::AsyncSocketReceive::Result:
SC::AsyncResultOf< AsyncSocketReceive, CompletionData > SC::AsyncResult

Public Member Functions

SC::Result get (Span< char > &outData)
 Get a Span of the actually read data. More...
 
- Public Member Functions inherited from SC::AsyncResultOf< AsyncSocketReceive, CompletionData >
AsyncSocketReceivegetAsync ()
 
const AsyncSocketReceivegetAsync () const
 
 AsyncResult (AsyncRequest &request, SC::Result &&res)
 Constructs an async result from a request and a result. More...
 
 AsyncResult (AsyncRequest &request)
 Constructs an async result from a request. More...
 
- Public Member Functions inherited from SC::AsyncResult
 AsyncResult (AsyncRequest &request, SC::Result &&res)
 Constructs an async result from a request and a result. More...
 
 AsyncResult (AsyncRequest &request)
 Constructs an async result from a request. More...
 
void reactivateRequest (bool value)
 Ask the event loop to re-activate this request after it was already completed. More...
 
const SC::ResultisValid () const
 Check if the returnCode of this result is valid. More...
 

Additional Inherited Members

- Public Attributes inherited from SC::AsyncResultOf< AsyncSocketReceive, CompletionData >
CompletionData completionData
 
- Public Attributes inherited from SC::AsyncResult
AsyncRequestasync
 
- Protected Attributes inherited from SC::AsyncResult
bool shouldBeReactivated = false
 
bool shouldCallCallback = true
 
SC::Result returnCode = SC::Result(true)
 

Detailed Description

Callback result for AsyncSocketReceive.

Member Function Documentation

◆ get()

SC::Result SC::AsyncSocketReceive::Result::get ( Span< char > &  outData)
inline

Get a Span of the actually read data.

Parameters
outDataThe span of data actually read from socket
Returns
Valid Result if the data was read without errors

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