---

oscl_time.h

Go to the documentation of this file.

// -*- c++ -*-
// = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =

//               O S C L _ T I M E   ( T I M E   F U N C T I O N S )

// = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =

#ifndef OSCL_TIME_H_INCLUDED
#define OSCL_TIME_H_INCLUDED

// - - Inclusion - - - - - - - - - - - - - - - - - - - - - - - - - - - -

#ifndef OSCL_BASE_H_INCLUDED
#include "oscl_base.h"
#endif

#ifndef OSCLCONFIG_TIME_H_INCLUDED
#include "osclconfig_time.h"
#endif

#ifndef OSCL_INT64_UTILS_INCLUDED
#include "oscl_int64_utils.h"
#endif

const int CTIME_BUFFER_SIZE = 26;

const int PV8601TIME_BUFFER_SIZE = 21;

typedef char CtimeStrBuf[CTIME_BUFFER_SIZE];
typedef char PV8601timeStrBuf[PV8601TIME_BUFFER_SIZE];

class TimeValue;  // Forward definition

OSCL_IMPORT_REF void PV8601ToRFC822(PV8601timeStrBuf pv8601_buffer, CtimeStrBuf ctime_buffer);
OSCL_IMPORT_REF void RFC822ToPV8601(CtimeStrBuf ctime_buffer, PV8601timeStrBuf);

// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
typedef enum { SECONDS = 0, MILLISECONDS = 1, MICROSECONDS = 2 } TimeUnits;

const long USEC_PER_SEC = 1000000;
const long MSEC_PER_SEC = 1000;

static const long MapToSeconds[] = {1, 1000, 1000000};
static const long MapToUSeconds[] = {1000000, 1000, 1};
static const long MapTo100NanoSeconds[] = {10000000, 10000, 10};
const uint32 unix_ntp_offset = 2208988800U;

// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -


class NTPTime
{

    private:
        uint64 timevalue;

    public:
        OSCL_COND_IMPORT_REF NTPTime();

        OSCL_COND_IMPORT_REF NTPTime(const NTPTime& src);


        OSCL_COND_IMPORT_REF NTPTime(const uint32 seconds);


        OSCL_COND_IMPORT_REF NTPTime(const int32 seconds);


        OSCL_COND_IMPORT_REF NTPTime(const TimeValue& t);


        OSCL_COND_IMPORT_REF NTPTime(const uint64 value);



        OSCL_COND_IMPORT_REF NTPTime& operator=(uint32 newval);


        OSCL_COND_IMPORT_REF NTPTime& operator=(uint64 newval);


        OSCL_COND_IMPORT_REF NTPTime& operator+=(uint64 val);


        OSCL_COND_IMPORT_REF NTPTime operator-(const NTPTime &ntpt) const;


        void set_from_system_time(const uint32 systemtime);

        /* \return This method returns the middle 32 bits of the 32.32 representation. */
        OSCL_COND_IMPORT_REF uint32 get_middle32() const;

        OSCL_COND_IMPORT_REF uint32 get_upper32() const;

        OSCL_COND_IMPORT_REF uint32 get_lower32() const;


        int32 to_system_time() const;

        OSCL_COND_IMPORT_REF uint64 get_value() const;

        OSCL_IMPORT_REF int set_to_current_time();

};

// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

class TimeValue
{

    public:
        OSCL_COND_IMPORT_REF TimeValue();

        OSCL_COND_IMPORT_REF TimeValue(const TimeValue& Tv);


        OSCL_COND_IMPORT_REF TimeValue(long tv, TimeUnits units);


        OSCL_COND_IMPORT_REF TimeValue(const OsclBasicTimeStruct& in_tv);


        OSCL_COND_IMPORT_REF TimeValue(OsclBasicDateTimeStruct in_ts);


        OSCL_COND_IMPORT_REF int32 get_local_time();


        friend class NTPTime;

        OSCL_COND_IMPORT_REF void set_to_zero();

        OSCL_COND_IMPORT_REF void set_to_current_time();


        OSCL_COND_IMPORT_REF void set_from_ntp_time(const uint32 ntp_offset);


        OSCL_COND_IMPORT_REF uint32 get_sec() const ;

        OSCL_COND_IMPORT_REF int32 to_msec() const;


        OSCL_COND_IMPORT_REF uint32 get_usec() const ;


        OSCL_IMPORT_REF char *get_str_ctime(CtimeStrBuf ctime_strbuf);


        OSCL_IMPORT_REF int get_pv8601_str_time(PV8601timeStrBuf time_strbuf);


        OSCL_IMPORT_REF char *get_rfc822_gmtime_str(int max_time_strlen,
                char *time_str);

        OSCL_COND_IMPORT_REF bool is_zero();


        // comparison operators
        OSCL_COND_IMPORT_REF friend bool operator ==(const TimeValue& a, const TimeValue& b);
        OSCL_COND_IMPORT_REF friend bool operator !=(const TimeValue& a, const TimeValue& b);
        OSCL_COND_IMPORT_REF friend bool operator <=(const TimeValue& a, const TimeValue& b);
        OSCL_COND_IMPORT_REF friend bool operator >=(const TimeValue& a, const TimeValue& b);
        OSCL_COND_IMPORT_REF friend bool operator <(const TimeValue& a, const TimeValue& b);
        OSCL_COND_IMPORT_REF friend bool operator >(const TimeValue& a, const TimeValue& b);

        OSCL_COND_IMPORT_REF TimeValue& operator =(const TimeValue& a);

        // arithmetic operators
        OSCL_COND_IMPORT_REF TimeValue& operator +=(const TimeValue& a);
        OSCL_COND_IMPORT_REF TimeValue& operator -=(const TimeValue& a);
        OSCL_COND_IMPORT_REF TimeValue& operator *=(const int scale);

        OSCL_COND_IMPORT_REF OsclBasicTimeStruct * get_timeval_ptr();

    private:

        OsclBasicTimeStruct ts;
        const OsclBasicTimeStruct *getBasicTimeStruct() const
        {
            return &ts;
        };

};

OSCL_COND_IMPORT_REF TimeValue operator -(const TimeValue& a, const TimeValue& b);

#if (!OSCL_DISABLE_INLINES)
#include "oscl_time.inl"
#endif


// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

#endif // OSCL_TIME_H_INCLUDED

---