SquidTime.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2021 The Squid Software Foundation and contributors
 *
 * Squid software is distributed under GPLv2+ license and includes
 * contributions from numerous individuals and organizations.
 * Please see the COPYING and CONTRIBUTORS files for details.
 */
 
/* DEBUG: section 21    Time Functions */
 
#ifndef   SQUID_TIME_H
#define   SQUID_TIME_H
 
#include "rfc1123.h"
 
#include <ctime>
#include <iosfwd>
/* NP: sys/time.h is provided by libcompat */
 
/* Use uint64_t to store milliseconds */
typedef uint64_t time_msec_t;
 
/* globals for accessing time */
extern struct timeval current_time;
extern double current_dtime;
extern time_t squid_curtime;
 
time_t getCurrentTime(void);
int tvSubMsec(struct timeval, struct timeval);
 
void tvSub(struct timeval &res, struct timeval const &t1, struct timeval const &t2);
 
void tvAdd(struct timeval &res, struct timeval const &t1, struct timeval const &t2);
 
void tvAssignAdd(struct timeval &t, struct timeval const &add);
 
inline long int tvToMsec(struct timeval &t)
{
    return t.tv_sec * 1000 + t.tv_usec / 1000;
}
 
class TimeEngine
{
 
public:
    virtual ~TimeEngine();
 
    virtual void tick();
};
 
// TODO: Remove direct timercmp() calls in legacy code.
 
inline bool
operator <(const timeval &a, const timeval &b)
{
    return timercmp(&a, &b, <);
}
 
inline bool
operator >(const timeval &a, const timeval &b)
{
    return timercmp(&a, &b, >);
}
 
inline bool
operator !=(const timeval &a, const timeval &b)
{
    return timercmp(&a, &b, !=);
}
 
// Operators for timeval below avoid timercmp() because Linux timeradd(3) manual
// page says that their timercmp() versions "do not work" on some platforms.
 
inline bool
operator <=(const timeval &a, const timeval &b)
{
    return !(a > b);
}
 
inline bool
operator >=(const timeval &a, const timeval &b)
{
    return !(a < b);
}
 
inline bool
operator ==(const timeval &a, const timeval &b)
{
    return !(a != b);
}
 
std::ostream &operator <<(std::ostream &, const timeval &);
 
namespace Time
{
 
const char *FormatStrf(time_t t);
 
const char *FormatHttpd(time_t t);
 
} // namespace Time
 
#endif /* SQUID_TIME_H */