duration.hpp
Go to the documentation of this file.
#ifndef PROTON_DURATION_HPP
#define PROTON_DURATION_HPP
/*
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*/
#include "./internal/export.hpp"
#include "./internal/comparable.hpp"
#include "./types_fwd.hpp"
#include <proton/type_compat.h>
#include <iosfwd>
namespace proton {
class duration : private internal::comparable<duration> {
public:
typedef int64_t numeric_type;
explicit duration(numeric_type ms = 0) : ms_(ms) {}
duration& operator=(numeric_type ms) { ms_ = ms; return *this; }
numeric_type milliseconds() const { return ms_; }
PN_CPP_EXTERN static const duration FOREVER;
PN_CPP_EXTERN static const duration IMMEDIATE;
PN_CPP_EXTERN static const duration SECOND;
PN_CPP_EXTERN static const duration MILLISECOND;
PN_CPP_EXTERN static const duration MINUTE;
private:
numeric_type ms_;
};
PN_CPP_EXTERN std::ostream& operator<<(std::ostream&, duration);
inline bool operator<(duration x, duration y) { return x.milliseconds() < y.milliseconds(); }
inline bool operator==(duration x, duration y) { return x.milliseconds() == y.milliseconds(); }
inline duration operator+(duration x, duration y) { return duration(x.milliseconds() + y.milliseconds()); }
inline duration operator-(duration x, duration y) { return duration(x.milliseconds() - y.milliseconds()); }
inline duration operator*(duration d, uint64_t n) { return duration(d.milliseconds()*n); }
inline duration operator*(uint64_t n, duration d) { return d * n; }
inline duration operator/(duration d, uint64_t n) { return duration(d.milliseconds() / n); }
} // proton
#endif // PROTON_DURATION_HPP
proton::duration::duration
duration(numeric_type ms=0)
Construct from a value in milliseconds.
Definition: duration.hpp:45
proton::operator<<
std::ostream & operator<<(std::ostream &, const binary &)
Print a binary value.
proton::duration
A span of time in milliseconds.
Definition: duration.hpp:39
proton::duration::MILLISECOND
static const duration MILLISECOND
One millisecond.
Definition: duration.hpp:56
proton::duration::numeric_type
int64_t numeric_type
A numeric type holding a value in milliseconds.
Definition: duration.hpp:42
proton::duration::milliseconds
numeric_type milliseconds() const
Get the value in milliseconds.
Definition: duration.hpp:51
proton::duration::IMMEDIATE
static const duration IMMEDIATE
Don't wait at all.
Definition: duration.hpp:54
proton::duration::SECOND
static const duration SECOND
One second.
Definition: duration.hpp:55
proton
The main Proton namespace.
Definition: annotation_key.hpp:33
proton::duration::operator=
duration & operator=(numeric_type ms)
Assign a value in milliseconds.
Definition: duration.hpp:48
proton::duration::MINUTE
static const duration MINUTE
One minute.
Definition: duration.hpp:57
proton::duration::FOREVER
static const duration FOREVER
Wait forever.
Definition: duration.hpp:53
types_fwd.hpp