sosscli::QueryResult Class Reference

The QueryResult class contains the result of a query operation, providing access to the keys returned from a query. More...

#include <query_result.h>

Public Member Functions
	QueryResult (int32_t return_code, const std::vector< uint8_t > &key_list_bytes)
	Constructor (intended for use by the C++ API, not client applications).
	QueryResult (int32_t error_code)
	Constructor (intended for use by the C++ API, not client applications).
virtual	~QueryResult ()
	Destructor.
const std::vector< SossKey > &	keys ()
	Returns a reference to keys in this query result. More...
int32_t	return_code ()
	Gets the code returned from the ScaleOut StateServer service, where a negative value indicates that an error occurred. More...

Detailed Description

The QueryResult class contains the result of a query operation, providing access to the keys returned from a query.

Member Function Documentation

const std::vector<SossKey>& sosscli::QueryResult::keys ( )

inline

Returns a reference to keys in this query result.

A reference is returned because the collection of keys could be very large, and copying the entire collection could be undesirable. Avoid keeping a reference or pointer to the returned vector after this QueryResult instance is destroyed.

int32_t sosscli::QueryResult::return_code ( )

inline

Gets the code returned from the ScaleOut StateServer service, where a negative value indicates that an error occurred.

---

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

• include/soss_client/query_result.h