apr_time.h

Go to the documentation of this file.

/* 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.
 */

#ifndef APR_TIME_H
#define APR_TIME_H

#include "apr.h"
#include "apr_pools.h"
#include "apr_errno.h"

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

APR_DECLARE_DATA extern const char apr_month_snames[12][4];
APR_DECLARE_DATA extern const char apr_day_snames[7][4];


typedef apr_int64_t apr_time_t;


#define APR_TIME_C(val) APR_INT64_C(val)

#define APR_TIME_T_FMT APR_INT64_T_FMT

typedef apr_int64_t apr_interval_time_t;
typedef apr_int32_t apr_short_interval_time_t;

#define APR_USEC_PER_SEC APR_TIME_C(1000000)

#define apr_time_sec(time) ((time) / APR_USEC_PER_SEC)

#define apr_time_usec(time) ((time) % APR_USEC_PER_SEC)

#define apr_time_msec(time) (((time) / 1000) % 1000)

#define apr_time_as_msec(time) ((time) / 1000)

#define apr_time_from_msec(msec) ((apr_time_t)(msec) * 1000)

#define apr_time_from_sec(sec) ((apr_time_t)(sec) * APR_USEC_PER_SEC)

#define apr_time_make(sec, usec) ((apr_time_t)(sec) * APR_USEC_PER_SEC \
                                + (apr_time_t)(usec))

APR_DECLARE(apr_time_t) apr_time_now(void);

typedef struct apr_time_exp_t apr_time_exp_t;

struct apr_time_exp_t {
    apr_int32_t tm_usec;
    apr_int32_t tm_sec;
    apr_int32_t tm_min;
    apr_int32_t tm_hour;
    apr_int32_t tm_mday;
    apr_int32_t tm_mon;
    apr_int32_t tm_year;
    apr_int32_t tm_wday;
    apr_int32_t tm_yday;
    apr_int32_t tm_isdst;
    apr_int32_t tm_gmtoff;
};

APR_DECLARE(apr_status_t) apr_time_ansi_put(apr_time_t *result, 
                                                    time_t input);

APR_DECLARE(apr_status_t) apr_time_exp_tz(apr_time_exp_t *result,
                                          apr_time_t input,
                                          apr_int32_t offs);

APR_DECLARE(apr_status_t) apr_time_exp_gmt(apr_time_exp_t *result, 
                                           apr_time_t input);

APR_DECLARE(apr_status_t) apr_time_exp_lt(apr_time_exp_t *result, 
                                          apr_time_t input);

APR_DECLARE(apr_status_t) apr_time_exp_get(apr_time_t *result, 
                                           apr_time_exp_t *input);

APR_DECLARE(apr_status_t) apr_time_exp_gmt_get(apr_time_t *result, 
                                               apr_time_exp_t *input);

APR_DECLARE(void) apr_sleep(apr_interval_time_t t);

#define APR_RFC822_DATE_LEN (30)

APR_DECLARE(apr_status_t) apr_rfc822_date(char *date_str, apr_time_t t);

#define APR_CTIME_LEN (25)

APR_DECLARE(apr_status_t) apr_ctime(char *date_str, apr_time_t t);

APR_DECLARE(apr_status_t) apr_strftime(char *s, apr_size_t *retsize, 
                                       apr_size_t max, const char *format, 
                                       apr_time_exp_t *tm);

APR_DECLARE(void) apr_time_clock_hires(apr_pool_t *p);

#ifdef __cplusplus
}
#endif

#endif  /* ! APR_TIME_H */