NetBSD/gnu/libexec/uucp/uutime.h

/* uutime.h
   Header file for UUCP time routines.

   Copyright (C) 1992 Ian Lance Taylor

   This file is part of the Taylor UUCP package.

   This program is free software; you can redistribute it and/or
   modify it under the terms of the GNU General Public License as
   published by the Free Software Foundation; either version 2 of the
   License, or (at your option) any later version.

   This program is distributed in the hope that it will be useful, but
   WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

   The author of the program may be contacted at ian@airs.com or
   c/o AIRS, P.O. Box 520, Waltham, MA 02254.

	$Id: uutime.h,v 1.2 1993/08/02 17:25:16 mycroft Exp $
*/

#ifndef UUTIME_H

#define UUTIME_H

/* Timetables are kept in a array of pairs of strings.  */

struct stimetable
{
  /* Name of timetable.  */
  const char *zname;
  /* Time string.  */
  const char *ztime;
};

extern int cTtable;
extern struct stimetable *pasTtable;

/* A time string is parsed into a list of the following structures.
   Each element of the list represents a span of time.  The time
   string matches any time that is one of the spans.  The time may
   only depend on the day of the week, not on the day of the month or
   of the year.  Also, the time is specified only down to the minute,
   not down to the second or below.

   The starting and ending time are expressed in minutes since the
   beginning of the week, which is considered to be 12 midnight on
   Sunday.  Thus 60 is 1 am on Sunday, 1440 (== 60 * 24) is 12
   midnight on Monday, and the largest possible value is 10080 (== 60
   * 24 * 7) which is 12 midnight on the following Sunday.

   Each span of time has a value associated with it.  This is the
   lowest grade or the largest file size that may be transferred
   during the span.  When we add a new time span that overlaps with an
   existing one, we use the span with the higher grade or the smaller
   file size.  Thus specifying ``call-timegrade z Any'' and
   ``call-timegrade Z Mo'' means that only grade Z or higher may be
   sent on Monday, since Z is the higer grade of the overlapping
   spans.  After determining which grade or file size to use, we
   eliminate all overlaps.

   Each span also has a retry time associated with it.  This permits
   different retry times to be used at different times of day.  */

struct sspan
{
  /* Next time span in this list.  */
  struct sspan *qnext;
  /* Value for this span (lowest grade or largest file that may be
     transferred at this time).  */
  long ival;
  /* Starting minute.  */
  int istart;
  /* Ending minute.  */
  int iend;
  /* Retry time.  */
  int cretry;
};

/* Time functions.  */

/* Initialize the array of timetables.  */
extern void uinittimetables P((void));

/* Add a new timetable entry.  */
extern void uaddtimetable P((const char *zname, const char *ztime));

/* Parse a timegrade string into a time span.  A timegrade string is a
   sequence of strings separated by a single space.  The first
   character of each string is a grade.  The second character begins a
   time string.  The time string may end in a semicolon followed by a
   retry time.  */
extern struct sspan *qtimegrade_parse P((const char *ztimegrade));

/* Parse a timesize string into a time span.  A timespan string is a
   sequence of pairs of strings, all separated by a single space.  The
   first string in each pair is a numeric size.  The second string is
   a time string.  */
extern struct sspan *qtimesize_parse P((const char *ztimesize));

/* See if the current time matches a time span.  If not, return FALSE.
   Otherwise, return TRUE and set *pival and *pcretry to the values
   from the matching element of the span.  */
extern boolean ftimespan_match P((const struct sspan *,
				  long *pival, int *pcretry));

/* Free a time span returned by either qtparse_timesize or
   qtparse_timegrade.  */
extern void utimespan_free P((struct sspan *));

/* Determine the grade of work permitted at the current time, given a
   timegrade string.  This parses the timegrade string, locates the
   entry corresponding to the current time, and returns the associated
   grade.  If no time in the timegrade string matches, this returns
   '\0'.  */
extern char btimegrade P((const char *ztimegrade));

/* Determine the maximum size that may be transferred at the current
   time, given a timesize string.  This parses the timesize string,
   locates the entry corresponding to the current time, and returns
   the associated size.  If no time in the timesize string matches,
   this returns -1.  */
extern long cmax_size_now P((const char *ztimesize));

/* Determine the maximum size that may ever be transferred, given a
   timesize string.  If there are any time gaps larger than 1 hour not
   described by the timesize string, this returns -1.  Otherwise it
   returns the largest size that may be transferred at some time.  */
extern long cmax_size_ever P((const char *ztimesize));

#endif /* ! defined (UUTIME_H) */