aboutsummaryrefslogtreecommitdiff
path: root/contrib/native/client/src/include/drill/drillClient.hpp
diff options
context:
space:
mode:
authorParth Chandra <pchandra@maprtech.com>2015-03-27 11:21:07 -0700
committerParth Chandra <pchandra@maprtech.com>2015-04-03 18:40:53 -0700
commit4f213570f29a30c8609afacba0ca01cc33cdc7d0 (patch)
tree0ea0856026a51a80c89f6e8d7fdfa621f3f9a332 /contrib/native/client/src/include/drill/drillClient.hpp
parent6a8e0ec101cf082d9200b22c668a9b04451263ad (diff)
DRILL-2573: C++ Client - Separate QueryResult into QueryResult and QueryData
Diffstat (limited to 'contrib/native/client/src/include/drill/drillClient.hpp')
-rw-r--r--contrib/native/client/src/include/drill/drillClient.hpp4
1 files changed, 3 insertions, 1 deletions
diff --git a/contrib/native/client/src/include/drill/drillClient.hpp b/contrib/native/client/src/include/drill/drillClient.hpp
index 9289df3c7..c288c7073 100644
--- a/contrib/native/client/src/include/drill/drillClient.hpp
+++ b/contrib/native/client/src/include/drill/drillClient.hpp
@@ -167,7 +167,9 @@ typedef void* QueryHandle_t;
* Query Results listener callback. This function is called for every record batch after it has
* been received and decoded. The listener function should return a status.
* If the listener returns failure, the query will be canceled.
- *
+ * The listener is also called one last time when the query is completed or gets an error. In that
+ * case the RecordBatch Parameter is NULL. The DrillClientError parameter is NULL is there was no
+ * error oterwise it will have a valid DrillClientError object.
* DrillClientQueryResult will hold a listener & listener contxt for the call back function
*/
typedef status_t (*pfnQueryResultsListener)(QueryHandle_t ctx, RecordBatch* b, DrillClientError* err);