From commits-return-6062-archive-asf-public=cust-asf.ponee.io@kudu.apache.org Tue Jun 19 17:21:45 2018 Return-Path: X-Original-To: archive-asf-public@cust-asf.ponee.io Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx-eu-01.ponee.io (Postfix) with SMTP id 40F691807A3 for ; Tue, 19 Jun 2018 17:21:43 +0200 (CEST) Received: (qmail 71666 invoked by uid 500); 19 Jun 2018 15:21:42 -0000 Mailing-List: contact commits-help@kudu.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@kudu.apache.org Delivered-To: mailing list commits@kudu.apache.org Received: (qmail 71450 invoked by uid 99); 19 Jun 2018 15:21:42 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 19 Jun 2018 15:21:42 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id AF63BE09E9; Tue, 19 Jun 2018 15:21:41 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit From: granthenke@apache.org To: commits@kudu.apache.org Date: Tue, 19 Jun 2018 15:21:47 -0000 Message-Id: In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [07/51] [partial] kudu git commit: Add 1.7.1 release docs and links http://git-wip-us.apache.org/repos/asf/kudu/blob/20153945/cpp-client-api/classkudu_1_1_mono_delta.html ---------------------------------------------------------------------- diff --git a/cpp-client-api/classkudu_1_1_mono_delta.html b/cpp-client-api/classkudu_1_1_mono_delta.html deleted file mode 100644 index 1659029..0000000 --- a/cpp-client-api/classkudu_1_1_mono_delta.html +++ /dev/null @@ -1,393 +0,0 @@ - - - - - - - -Kudu C++ client API: kudu::MonoDelta Class Reference - - - - - - - - - -
-
- - - - - - -
-
Kudu C++ client API -
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-Public Member Functions | -Static Public Member Functions | -Friends | -List of all members
-
-
kudu::MonoDelta Class Reference
-
-
- -

A representation of a time interval. - More...

- -

#include <monotime.h>

- - - - - - - - - - - - - - - - - - - - - - - - - - - - -

-Public Member Functions

 MonoDelta ()
 
bool Initialized () const
 
bool LessThan (const MonoDelta &rhs) const
 
bool MoreThan (const MonoDelta &rhs) const
 
bool Equals (const MonoDelta &rhs) const
 
std::string ToString () const
 
void ToTimeVal (struct timeval *tv) const
 
void ToTimeSpec (struct timespec *ts) const
 
Converters into seconds representation (and ubiquitous SI prefixes).
Returns
Representation of the time interval in appropriate SI units.
-
-double ToSeconds () const
 
-int64_t ToMilliseconds () const
 
-int64_t ToMicroseconds () const
 
-int64_t ToNanoseconds () const
 
- - - - - - - - - - - - - -

-Static Public Member Functions

static void NanosToTimeSpec (int64_t nanos, struct timespec *ts)
 
Converters from seconds representation (and ubiquitous SI prefixes).
Parameters
- - -
[in]seconds/ms/us/nsTime interval representation in seconds (with ubiquitous SI prefixes).
-
-
-
Returns
The resulting MonoDelta object initialized in accordance with the specified parameter.
-
-static MonoDelta FromSeconds (double seconds)
 
-static MonoDelta FromMilliseconds (int64_t ms)
 
-static MonoDelta FromMicroseconds (int64_t us)
 
-static MonoDelta FromNanoseconds (int64_t ns)
 
- - - -

-Friends

-class MonoTime
 
-

Detailed Description

-

A representation of a time interval.

-

The MonoDelta class represents an elapsed duration of time – i.e. the delta between two MonoTime instances.

-

Constructor & Destructor Documentation

- -

◆ MonoDelta()

- -
-
- - - - - - - -
kudu::MonoDelta::MonoDelta ()
-
-

Build a MonoDelta object.

-
Note
A MonoDelta instance built with the this default constructor is "uninitialized" and may not be used for any operation.
- -
-
-

Member Function Documentation

- -

◆ Equals()

- -
-
- - - - - - - - -
bool kudu::MonoDelta::Equals (const MonoDelta & rhs) const
-
-

Check whether this time interval has the same duration as the specified one.

-
Parameters
- - -
[in]rhsA time interval for comparison.
-
-
-
Returns
true iff this time interval has the same duration as the the specified one.
- -
-
- -

◆ Initialized()

- -
-
- - - - - - - -
bool kudu::MonoDelta::Initialized () const
-
-
Returns
true iff this object is initialized.
- -
-
- -

◆ LessThan()

- -
-
- - - - - - - - -
bool kudu::MonoDelta::LessThan (const MonoDelta & rhs) const
-
-

Check whether this time interval is shorter than the specified one.

-
Parameters
- - -
[in]rhsA time interval for comparison.
-
-
-
Returns
true iff this time interval is strictly shorter than the specified one.
- -
-
- -

◆ MoreThan()

- -
-
- - - - - - - - -
bool kudu::MonoDelta::MoreThan (const MonoDelta & rhs) const
-
-

Check whether this time interval is longer than the specified one.

-
Parameters
- - -
[in]rhsA time interval for comparison.
-
-
-
Returns
true iff this time interval is strictly longer than the specified one.
- -
-
- -

◆ NanosToTimeSpec()

- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - -
static void kudu::MonoDelta::NanosToTimeSpec (int64_t nanos,
struct timespec * ts 
)
- 		-static
-
-

Convert a nanosecond value to a timespec.

-
Parameters
- - - -
[in]nanosRepresentation of a relative point in time in nanoseconds.
[out]tsPlaceholder for the resulting timespec representation.
-
-
- -
-
- -

◆ ToString()

- -
-
- - - - - - - -
std::string kudu::MonoDelta::ToString () const
-
-
Returns
String representation of this interval's duration (in seconds).
- -
-
- -

◆ ToTimeSpec()

- -
-
- - - - - - - - -
void kudu::MonoDelta::ToTimeSpec (struct timespec * ts) const
-
-

Represent this time interval as a timespec structure, with nanosecond accuracy.

-
Parameters
- - -
[out]tsPlaceholder for the result value.
-
-
- -
-
- -

◆ ToTimeVal()

- -
-
- - - - - - - - -
void kudu::MonoDelta::ToTimeVal (struct timeval * tv) const
-
-

Represent this time interval as a timeval structure, with microsecond accuracy.

-
Parameters
- - -
[out]tvPlaceholder for the result value.
-
-
- -
-
-
The documentation for this class was generated from the following file: -
- -
-
- Generated for Kudu version 1.7.0 on Thu Mar 22 2018 13:30:02 by Doxygen 1.8.14 -
- Copyright © 2018 The Apache Software Foundation. -
- - http://git-wip-us.apache.org/repos/asf/kudu/blob/20153945/cpp-client-api/classkudu_1_1_mono_time-members.html ---------------------------------------------------------------------- diff --git a/cpp-client-api/classkudu_1_1_mono_time-members.html b/cpp-client-api/classkudu_1_1_mono_time-members.html deleted file mode 100644 index e5443f8..0000000 --- a/cpp-client-api/classkudu_1_1_mono_time-members.html +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - -Kudu C++ client API: Member List - - - - - - - - - -
-
- - - - - - -
-
Kudu C++ client API -
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-
kudu::MonoTime Member List
-
-
- -

This is the complete list of members for kudu::MonoTime, including all inherited members.

- - - - - - - - -
kMicrosecondsPerSecond (defined in kudu::MonoTime)kudu::MonoTimestatic
kNanosecondsPerMicrosecond (defined in kudu::MonoTime)kudu::MonoTimestatic
kNanosecondsPerMillisecond (defined in kudu::MonoTime)kudu::MonoTimestatic
kNanosecondsPerSecond (defined in kudu::MonoTime)kudu::MonoTimestatic
Max()kudu::MonoTimestatic
Min()kudu::MonoTimestatic
Now()kudu::MonoTimestatic
- -
-
- Generated for Kudu version 1.7.0 on Thu Mar 22 2018 13:30:02 by Doxygen 1.8.14 -
- Copyright © 2018 The Apache Software Foundation. -
- - http://git-wip-us.apache.org/repos/asf/kudu/blob/20153945/cpp-client-api/classkudu_1_1_mono_time.html ---------------------------------------------------------------------- diff --git a/cpp-client-api/classkudu_1_1_mono_time.html b/cpp-client-api/classkudu_1_1_mono_time.html deleted file mode 100644 index 5c6ea27..0000000 --- a/cpp-client-api/classkudu_1_1_mono_time.html +++ /dev/null @@ -1,202 +0,0 @@ - - - - - - - -Kudu C++ client API: kudu::MonoTime Class Reference - - - - - - - - - -
-
- - - - - - -
-
Kudu C++ client API -
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-Static Public Member Functions | -List of all members
-
-
kudu::MonoTime Class Reference
-
-
- -

Representation of a particular point in time. - More...

- -

#include <monotime.h>

- - - - - - - - -

-Static Public Member Functions

static MonoTime Now ()
 
static MonoTime Max ()
 
static MonoTime Min ()
 
- - - - - - - - - - -

-Static Public Attributes

Conversion constants for ubiquitous time units.
-static const int64_t kNanosecondsPerSecond = 1000000000L
 
-static const int64_t kNanosecondsPerMillisecond = 1000000L
 
-static const int64_t kNanosecondsPerMicrosecond = 1000L
 
-static const int64_t kMicrosecondsPerSecond = 1000000L
 
-

Detailed Description

-

Representation of a particular point in time.

-

The MonoTime class represents a particular point in time, relative to some fixed but unspecified reference point.

-

This time is monotonic, meaning that if the user changes his or her system clock, the monotime does not change.

-

Member Function Documentation

- -

◆ Max()

- -
-
- - - - - -
- - - - - - - -
static MonoTime kudu::MonoTime::Max ()
- 		-static
-
-
Returns
MonoTime equal to farthest possible time into the future.
- -
-
- -

◆ Min()

- -
-
- - - - - -
- - - - - - - -
static MonoTime kudu::MonoTime::Min ()
- 		-static
-
-
Returns
MonoTime equal to farthest possible time into the past.
- -
-
- -

◆ Now()

- -
-
- - - - - -
- - - - - - - -
static MonoTime kudu::MonoTime::Now ()
- 		-static
-
-

Get current time in MonoTime representation.

-
Returns
Time specification for the moment of the method's invocation.
- -
-
-
The documentation for this class was generated from the following file: -
- -
-
- Generated for Kudu version 1.7.0 on Thu Mar 22 2018 13:30:02 by Doxygen 1.8.14 -
- Copyright © 2018 The Apache Software Foundation. -
- - http://git-wip-us.apache.org/repos/asf/kudu/blob/20153945/cpp-client-api/classkudu_1_1_slice-members.html ---------------------------------------------------------------------- diff --git a/cpp-client-api/classkudu_1_1_slice-members.html b/cpp-client-api/classkudu_1_1_slice-members.html deleted file mode 100644 index b3ffd39..0000000 --- a/cpp-client-api/classkudu_1_1_slice-members.html +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - -Kudu C++ client API: Member List - - - - - - - - - -
-
- - - - - - -
-
Kudu C++ client API -
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-
kudu::Slice Member List
-
-
- -

This is the complete list of members for kudu::Slice, including all inherited members.

- - - - - - - - - - - - - - - - - - - - - -
check_size(size_t expected_size) constkudu::Slice
clear()kudu::Sliceinline
compare(const Slice &b) constkudu::Sliceinline
data() constkudu::Sliceinline
empty() constkudu::Sliceinline
mutable_data()kudu::Sliceinline
operator==(const Slice &x, const Slice &y)kudu::Slicefriend
operator[](size_t n) constkudu::Sliceinline
relocate(uint8_t *d)kudu::Sliceinline
remove_prefix(size_t n)kudu::Sliceinline
size() constkudu::Sliceinline
Slice()kudu::Sliceinline
Slice(const uint8_t *d, size_t n)kudu::Sliceinline
Slice(const char *d, size_t n)kudu::Sliceinline
Slice(const std::string &s)kudu::Sliceinline
Slice(const char *s)kudu::Sliceinline
starts_with(const Slice &x) constkudu::Sliceinline
ToDebugString(size_t max_len=0) constkudu::Slice
ToString() constkudu::Slice
truncate(size_t n)kudu::Sliceinline
- -
-
- Generated for Kudu version 1.7.0 on Thu Mar 22 2018 13:30:02 by Doxygen 1.8.14 -
- Copyright © 2018 The Apache Software Foundation. -
- - http://git-wip-us.apache.org/repos/asf/kudu/blob/20153945/cpp-client-api/classkudu_1_1_slice.html ---------------------------------------------------------------------- diff --git a/cpp-client-api/classkudu_1_1_slice.html b/cpp-client-api/classkudu_1_1_slice.html deleted file mode 100644 index b14a997..0000000 --- a/cpp-client-api/classkudu_1_1_slice.html +++ /dev/null @@ -1,741 +0,0 @@ - - - - - - - -Kudu C++ client API: kudu::Slice Class Reference - - - - - - - - - -
-
- - - - - - -
-
Kudu C++ client API -
-
-
- - - - - - - - -
-
- - -
- -
- - -
-
-
-Classes | -Public Member Functions | -Friends | -List of all members
-
-
kudu::Slice Class Reference
-
-
- -

A wrapper around externally allocated data. - More...

- -

#include <slice.h>

- - - - - -

-Classes

struct  Comparator
 Comparator struct, useful for ordered collections (like STL maps). More...
 
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

-Public Member Functions

- Slice ()
 Create an empty slice.
 
 Slice (const uint8_t *d, size_t n)
 
 Slice (const char *d, size_t n)
 
 Slice (const std::string &s)
 
 Slice (const char *s)
 
const uint8_t * data () const
 
uint8_t * mutable_data ()
 
size_t size () const
 
bool empty () const
 
const uint8_t & operator[] (size_t n) const
 
-void clear ()
 Change this slice to refer to an empty array.
 
void remove_prefix (size_t n)
 
void truncate (size_t n)
 
Status check_size (size_t expected_size) const
 
std::string ToString () const
 
std::string ToDebugString (size_t max_len=0) const
 
int compare (const Slice &b) const
 
bool starts_with (const Slice &x) const
 
void relocate (uint8_t *d)
 
- - - -

-Friends

bool operator== (const Slice &x, const Slice &y)
 
-

Detailed Description

-

A wrapper around externally allocated data.

-

Slice is a simple structure containing a pointer into some external storage and a size. The user of a Slice must ensure that the slice is not used after the corresponding external storage has been deallocated.

-

Multiple threads can invoke const methods on a Slice without external synchronization, but if any of the threads may call a non-const method, all threads accessing the same Slice must use external synchronization.

-

Slices can be built around faststrings and StringPieces using constructors with implicit casts. Both StringPieces and faststrings depend on a great deal of gutil code.

-

Constructor & Destructor Documentation

- -

◆ Slice() [1/4]

- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - -
kudu::Slice::Slice (const uint8_t * d,
size_t n 
)
- 		-inline
-
-

Create a slice that refers to a uint8_t byte array.

-
Parameters
- - - -
[in]dThe input array.
[in]nNumber of bytes in the array.
-
-
- -
-
- -

◆ Slice() [2/4]

- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - -
kudu::Slice::Slice (const char * d,
size_t n 
)
- 		-inline
-
-

Create a slice that refers to a char byte array.

-
Parameters
- - - -
[in]dThe input array.
[in]nNumber of bytes in the array.
-
-
- -
-
- -

◆ Slice() [3/4]

- -
-
- - - - - -
- - - - - - - - -
kudu::Slice::Slice (const std::string & s)
- 		-inline
-
-

Create a slice that refers to the contents of the given string.

-
Parameters
- - -
[in]sThe input string.
-
-
- -
-
- -

◆ Slice() [4/4]

- -
-
- - - - - -
- - - - - - - - -
kudu::Slice::Slice (const char * s)
- 		-inline
-
-

Create a slice that refers to a C-string s[0,strlen(s)-1].

-
Parameters
- - -
[in]sThe input C-string.
-
-
- -
-
-

Member Function Documentation

- -

◆ check_size()

- -
-
- - - - - - - - -
Status kudu::Slice::check_size (size_t expected_size) const
-
-

Check that the slice has the expected size.

-
Parameters
- - -
[in]expected_size
-
-
-
Returns
Status::Corruption() iff size() != expected_size
- -
-
- -

◆ compare()

- -
-
- - - - - -
- - - - - - - - -
int kudu::Slice::compare (const Slice & b) const
- 		-inline
-
-

Do a three-way comparison of the slice's data.

-
Parameters
- - -
[in]bThe other slice to compare with.
-
-
-
Returns
Values are
    -
  • < 0 iff "*this" < "b"
    • -
  • == 0 iff "*this" == "b"
    • -
  • > 0 iff "*this" > "b"
    • -
-
- -
-
- -

◆ data()

- -
-
- - - - - -
- - - - - - - -
const uint8_t* kudu::Slice::data () const
- 		-inline
-
-
Returns
A pointer to the beginning of the referenced data.
- -
-
- -

◆ empty()

- -
-
- - - - - -
- - - - - - - -
bool kudu::Slice::empty () const
- 		-inline
-
-
Returns
true iff the length of the referenced data is zero.
- -
-
- -

◆ mutable_data()

- -
-
- - - - - -
- - - - - - - -
uint8_t* kudu::Slice::mutable_data ()
- 		-inline
-
-
Returns
A mutable pointer to the beginning of the referenced data.
- -
-
- -

◆ operator[]()

- -
-
- - - - - -
- - - - - - - - -
const uint8_t& kudu::Slice::operator[] (size_t n) const
- 		-inline
-
-
Precondition
n < size()
-
Parameters
- - -
[in]nThe index of the byte.
-
-
-
Returns
the n-th byte in the referenced data.
- -
-
- -

◆ relocate()

- -
-
- - - - - -
- - - - - - - - -
void kudu::Slice::relocate (uint8_t * d)
- 		-inline
-
-

Relocate/copy the slice's data into a new location.

-
Parameters
- - -
[in]dThe new location for the data. If it's the same location, then no relocation is done. It is assumed that the new location is large enough to fit the data.
-
-
- -
-
- -

◆ remove_prefix()

- -
-
- - - - - -
- - - - - - - - -
void kudu::Slice::remove_prefix (size_t n)
- 		-inline
-
-

Drop the first "n" bytes from this slice.

-
Precondition
n <= size()
-
Note
Only the base and bounds of the slice are changed; the data is not modified.
-
Parameters
- - -
[in]nNumber of bytes that should be dropped from the beginning.
-
-
- -
-
- -

◆ size()

- -
-
- - - - - -
- - - - - - - -
size_t kudu::Slice::size () const
- 		-inline
-
-
Returns
The length (in bytes) of the referenced data.
- -
-
- -

◆ starts_with()

- -
-
- - - - - -
- - - - - - - - -
bool kudu::Slice::starts_with (const Slice & x) const
- 		-inline
-
-

Check whether the slice starts with the given prefix.

Parameters
- - -
[in]xThe slice in question.
-
-
-
Returns
true iff "x" is a prefix of "*this"
- -
-
- -

◆ ToDebugString()

- -
-
- - - - - - - - -
std::string kudu::Slice::ToDebugString (size_t max_len = 0) const
-
-

Get printable representation of the data in the slice.

-
Parameters
- - -
[in]max_lenThe maximum number of bytes to output in the printable format; 0 means no limit.
-
-
-
Returns
A string with printable representation of the data.
- -
-
- -

◆ ToString()

- -
-
- - - - - - - -
std::string kudu::Slice::ToString () const
-
-
Returns
A string that contains a copy of the referenced data.
- -
-
- -

◆ truncate()

- -
-
- - - - - -
- - - - - - - - -
void kudu::Slice::truncate (size_t n)
- 		-inline
-
-

Truncate the slice to the given number of bytes.

-
Precondition
n <= size()
-
Note
Only the base and bounds of the slice are changed; the data is not modified.
-
Parameters
- - -
[in]nThe new size of the slice.
-
-
- -
-
-

Friends And Related Function Documentation

- -

◆ operator==

- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - -
bool operator== (const Slice & x,
const Slice & y 
)
- 		-friend
-
-

Check whether two slices are identical.

-
Parameters
- - - -
[in]xOne slice.
[in]yAnother slice.
-
-
-
Returns
true iff two slices contain byte-for-byte identical data.
- -
-
-
The documentation for this class was generated from the following file: -
- -
-
- Generated for Kudu version 1.7.0 on Thu Mar 22 2018 13:30:02 by Doxygen 1.8.14 -
- Copyright © 2018 The Apache Software Foundation. -
- -