Systime API

The Systime API provides the means of getting the system time, instead of the scheduler time as you would with functions like gettime(). More...

+ Collaboration diagram for Systime API:

Data Structures

struct  t_datetime
 The Systime data structure. More...

Enumerations

enum  e_max_dateflags { SYSDATEFORMAT_FLAGS_SHORT, SYSDATEFORMAT_FLAGS_MEDIUM, SYSDATEFORMAT_FLAGS_LONG }
 Flags for the sysdateformat_formatdatetime() function. More...

Functions

unsigned long systime_ticks (void)
 Find out the operating system’s time in ticks.
unsigned long systime_ms (void)
 Find out the operating system’s time in milliseconds.
void systime_datetime (t_datetime *d)
 Find out the operating system’s date and time.
unsigned long systime_seconds (void)
 Find out the operating system’s time in seconds.
void systime_secondstodate (unsigned long secs, t_datetime *d)
 Convert a time in seconds into a t_datetime representation.
unsigned long systime_datetoseconds (t_datetime *d)
 Convert a t_datetime representation of time into seconds.
void sysdateformat_strftimetodatetime (char *strf, t_datetime *d)
 Fill a t_datetime struct with a datetime formatted string.
void sysdateformat_formatdatetime (t_datetime *d, long dateflags, long timeflags, char *s, long buflen)
 Get a human friendly string representation of a t_datetime.

Detailed Description

The Systime API provides the means of getting the system time, instead of the scheduler time as you would with functions like gettime().


Enumeration Type Documentation

Flags for the sysdateformat_formatdatetime() function.

Enumerator:
SYSDATEFORMAT_FLAGS_SHORT 

short

SYSDATEFORMAT_FLAGS_MEDIUM 

medium

SYSDATEFORMAT_FLAGS_LONG 

long


Function Documentation

void sysdateformat_formatdatetime ( t_datetime d,
long  dateflags,
long  timeflags,
char *  s,
long  buflen 
)

Get a human friendly string representation of a t_datetime.

For example: "Today", "Yesterday", etc.

Parameters:
dThe address of a t_datetime to fill.
dateflagsOne of the values defined in e_max_dateflags.
timeflagsCurrently unused. Pass 0.
sAn already allocated string to hold the human friendly result.
buflenThe number of characters allocated to the string s.
void sysdateformat_strftimetodatetime ( char *  strf,
t_datetime d 
)

Fill a t_datetime struct with a datetime formatted string.

For example, the string "2007-12-24 12:21:00".

Parameters:
strfA string containing the datetime.
dThe address of a t_datetime to fill.
void systime_datetime ( t_datetime d)

Find out the operating system’s date and time.

Parameters:
dReturns the system’s date and time in a t_datetime data structure.
unsigned long systime_datetoseconds ( t_datetime d)

Convert a t_datetime representation of time into seconds.

Parameters:
dThe address of a t_datetime that contains a valid period of time.
Returns:
The number of seconds represented by d.
unsigned long systime_ms ( void  )

Find out the operating system’s time in milliseconds.

Returns:
the system time in milliseconds.
unsigned long systime_seconds ( void  )

Find out the operating system’s time in seconds.

Returns:
the system time in seconds.
void systime_secondstodate ( unsigned long  secs,
t_datetime d 
)

Convert a time in seconds into a t_datetime representation.

Parameters:
secsA number of seconds to be represented as a t_datetime.
dThe address of a t_datetime that will be filled with the converted value.
unsigned long systime_ticks ( void  )

Find out the operating system’s time in ticks.

Returns:
the system time in ticks.