C++ edjLibrary SDK
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
edjx::storage::StorageResponsePending Struct Reference

Placeholder for storage response used in streaming methods when the response is not available immediately. More...

#include <storage.hpp>

Public Member Functions

 StorageResponsePending ()
 Constructs an uninitialized response holder. More...
 
 StorageResponsePending (uint32_t sd)
 Constructs a response holder for a stream identified by the stream descriptor sd. More...
 
edjx::error::StorageError get_storage_response (StorageResponse &result)
 Attempts to retrieve the storage response if it is ready. More...
 

Public Attributes

uint32_t sd
 Stream descriptor. More...
 

Detailed Description

Placeholder for storage response used in streaming methods when the response is not available immediately.

Constructor & Destructor Documentation

◆ StorageResponsePending() [1/2]

edjx::storage::StorageResponsePending::StorageResponsePending ( )
inline

Constructs an uninitialized response holder.

◆ StorageResponsePending() [2/2]

edjx::storage::StorageResponsePending::StorageResponsePending ( uint32_t  sd)
inline

Constructs a response holder for a stream identified by the stream descriptor sd.

Parameters
sdStream descriptor

Member Function Documentation

◆ get_storage_response()

edjx::error::StorageError edjx::storage::StorageResponsePending::get_storage_response ( StorageResponse result)

Attempts to retrieve the storage response if it is ready.

Parameters
resultRetrieved storage response
Returns
Returns edjx::error::StorageError::Success on success, some other value otherwise.

Member Data Documentation

◆ sd

uint32_t edjx::storage::StorageResponsePending::sd

Stream descriptor.


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