AvahiPoll Struct Reference

Defines an abstracted event polling API. More...

#include <avahi-common/watch.h>

Data Fields
void *	userdata
	Some abstract user data usable by the provider of the API. More...
AvahiWatch *(*	watch_new )(const AvahiPoll *api, int fd, AvahiWatchEvent event, AvahiWatchCallback callback, void *userdata)
	Create a new watch for the specified file descriptor and for the specified events. More...
void(*	watch_update )(AvahiWatch *w, AvahiWatchEvent event)
	Update the events to wait for. More...
AvahiWatchEvent(*	watch_get_events )(AvahiWatch *w)
	Return the events that happened. More...
void(*	watch_free )(AvahiWatch *w)
	Free a watch. More...
AvahiTimeout *(*	timeout_new )(const AvahiPoll *api, const struct timeval *tv, AvahiTimeoutCallback callback, void *userdata)
	Set a wakeup time for the polling loop. More...
void(*	timeout_update )(AvahiTimeout *, const struct timeval *tv)
	Update the absolute expiration time for a timeout, If tv is NULL, the timeout is disabled. More...
void(*	timeout_free )(AvahiTimeout *t)
	Free a timeout. More...

Detailed Description

Defines an abstracted event polling API.

This may be used to connect Avahi to other main loops. This is loosely based on Unix poll(2). A consumer will call watch_new() for all file descriptors it wants to listen for events on. In addition he can call timeout_new() to define time based events .

Examples:

glib-integration.c.

Definition at line 60 of file watch.h.

Field Documentation

timeout_free

void(* AvahiPoll::timeout_free) (AvahiTimeout *t)

Free a timeout.

It is safe to call this function from an AvahiTimeoutCallback

Definition at line 91 of file watch.h.

timeout_new

AvahiTimeout*(* AvahiPoll::timeout_new) (const AvahiPoll *api, const struct timeval *tv, AvahiTimeoutCallback callback, void *userdata)

Set a wakeup time for the polling loop.

The API will call the callback function when the absolute time *tv is reached. If tv is NULL, the timeout is disabled. After the timeout expired the callback function will be called and the timeout is disabled. You can reenable it by calling timeout_update()

Examples:

client-publish-service.c, and glib-integration.c.

Definition at line 84 of file watch.h.

timeout_update

void(* AvahiPoll::timeout_update) (AvahiTimeout *, const struct timeval *tv)

Update the absolute expiration time for a timeout, If tv is NULL, the timeout is disabled.

It is safe to call this function from an AvahiTimeoutCallback

Definition at line 88 of file watch.h.

userdata

void* AvahiPoll::userdata

Some abstract user data usable by the provider of the API.

Definition at line 63 of file watch.h.

watch_free

void(* AvahiPoll::watch_free) (AvahiWatch *w)

Free a watch.

It is safe to call this function from an AvahiWatchCallback

Definition at line 77 of file watch.h.

watch_get_events

AvahiWatchEvent(* AvahiPoll::watch_get_events) (AvahiWatch *w)

Return the events that happened.

It is safe to call this function from an AvahiWatchCallback

Definition at line 74 of file watch.h.

watch_new

AvahiWatch*(* AvahiPoll::watch_new) (const AvahiPoll *api, int fd, AvahiWatchEvent event, AvahiWatchCallback callback, void *userdata)

Create a new watch for the specified file descriptor and for the specified events.

The API will call the callback function whenever any of the events happens.

Definition at line 68 of file watch.h.

watch_update

void(* AvahiPoll::watch_update) (AvahiWatch *w, AvahiWatchEvent event)

Update the events to wait for.

It is safe to call this function from an AvahiWatchCallback

Definition at line 71 of file watch.h.

---

The documentation for this struct was generated from the following file:

• avahi-common/watch.h