myMPD
Internal API documentation
Loading...
Searching...
No Matches
timer.h File Reference

Timerfd helpers. More...

#include <stdbool.h>
Include dependency graph for timer.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

int mympd_timer_create (int clock, int timeout, int interval)
 
bool mympd_timer_read (int fd)
 
bool mympd_timer_set (int timer_fd, int timeout, int interval)
 
void mympd_timer_log_next_expire (int timer_fd)
 
void mympd_timer_close (int fd)
 

Detailed Description

Timerfd helpers.

Function Documentation

◆ mympd_timer_close()

void mympd_timer_close ( int  fd)

Closes the timer

Parameters
fdfd to close

◆ mympd_timer_create()

int mympd_timer_create ( int  clock,
int  timeout,
int  interval 
)

Creates a new timer

Parameters
clockone off CLOCK_MONOTONIC or CLOCK_REALTIME
timeouttimeout in seconds
intervalinterval in seconds
Returns
timer fd

◆ mympd_timer_log_next_expire()

void mympd_timer_log_next_expire ( int  timer_fd)

Logs the next timer expiration.

Parameters
timer_fdtimer fd

◆ mympd_timer_read()

bool mympd_timer_read ( int  fd)

Reads from a timerfd

Parameters
fdread from this fd
Returns
true on success, else false

◆ mympd_timer_set()

bool mympd_timer_set ( int  timer_fd,
int  timeout,
int  interval 
)

Sets the relative timeout and interval for a timer fd.

Parameters
timer_fdtimer fd
timeoutrelative timeout in seconds
intervalinterval in seconds
Returns
true on success, else false