[c++ client] notes for timestamp-related methods

Added notes on anticipated changes on methods related to getting
and setting hybrid timestamps while performing READ_AT_SNAPSHOT
scan operations:
  * KuduClient::GetLatestObservedTimestamp()
  * KuduClient::SetLatestObservedTimestamp()
  * KuduScanner::SetSnapshotRaw()

Some changes are anticipated there in the context of KUDU-611.
In short, the timestamp might be replaced with some opaque type
(e.g., a sequence of bytes).

Also, added code sample to provide an idea how to use value returned
by KuduClient::GetLatestObservedTimestamp() to set appropriate snapshot
timestamp via KuduScanner::SetSnapshotRaw().

This addresses the following JIRA issues:
  KUDU-1661 Mark KuduClient::GetLatestObservedTimestamp()
      as experimental
  KUDU-1663 Clean-up in-code documentation for KuduScanner::ReadMode
      and KuduClient::GetLatestObservedTimestamp

Change-Id: I6c45b797fa459ac9d214bb2612fd797f7a1eea45
Reviewed-on: http://gerrit.cloudera.org:8080/4569
Tested-by: Kudu Jenkins
Reviewed-by: David Ribeiro Alves <dralves@apache.org>
(cherry picked from commit b70d3625b88ef4ad5d15ef68865e933a73c9069c)
Reviewed-on: http://gerrit.cloudera.org:8080/4666
Reviewed-by: Dan Burkert <dan@cloudera.com>
Tested-by: Dan Burkert <dan@cloudera.com>
1 file changed