libkeepalive
Loading...
Searching...
No Matches
keepalive-displaykeepalive.h File Reference

Provides wrapper API for MCE blanking-pause D-Bus interface. More...

Go to the source code of this file.

Typedefs

typedef struct displaykeepalive_t displaykeepalive_t
 

Functions

displaykeepalive_tdisplaykeepalive_new (void)
 
displaykeepalive_tdisplaykeepalive_ref (displaykeepalive_t *self)
 
void displaykeepalive_unref (displaykeepalive_t *self)
 
void displaykeepalive_start (displaykeepalive_t *self)
 
void displaykeepalive_stop (displaykeepalive_t *self)
 

Detailed Description

Provides wrapper API for MCE blanking-pause D-Bus interface.

Typedef Documentation

◆ displaykeepalive_t

Opaque display keepalive structure

Allocate via displaykeepalive_new() and release via displaykeepalive_unref().

Function Documentation

◆ displaykeepalive_new()

displaykeepalive_t * displaykeepalive_new ( void )

Create display keepalive object

Initially has reference count of 1.

Use displaykeepalive_ref() to increment reference count and displaykeepalive_unref() to decrement reference count.

Will be automatically released after reference count drops to zero.

Returns
pointer to display keepalive object, or NULL
Examples
keep-display-on.c.

◆ displaykeepalive_ref()

displaykeepalive_t * displaykeepalive_ref ( displaykeepalive_t * self)

Increment reference count of display keepalive object

Passing NULL object is explicitly allowed and does nothing.

Parameters
selfdisplay keepalive object pointer
Returns
pointer to display keepalive object, or NULL in case of errors

◆ displaykeepalive_unref()

void displaykeepalive_unref ( displaykeepalive_t * self)

Decrement reference count of display keepalive object

Passing NULL object is explicitly allowed and does nothing.

The object will be released if reference count reaches zero.

Parameters
selfdisplay keepalive object pointer
Examples
keep-display-on.c.

◆ displaykeepalive_start()

void displaykeepalive_start ( displaykeepalive_t * self)

Disable display normal display blanking policy

The display keepalive object makes the necessary D-Bus IPC that keeps the display from blanking while/when the following conditions are met: 1) display is already on 2) lockscreen is not shown 3) MCE is running

Examples
keep-display-on.c.

◆ displaykeepalive_stop()

void displaykeepalive_stop ( displaykeepalive_t * self)

Allow display normal display blanking policy

Examples
keep-display-on.c.