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.
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.
void(*	watch_update )(AvahiWatch *w, AvahiWatchEvent event)
	Update the events to wait for.
AvahiWatchEvent(*	watch_get_events )(AvahiWatch *w)
	Return the events that happened.
void(*	watch_free )(AvahiWatch *w)
	Free a watch.
AvahiTimeout *(*	timeout_new )(const AvahiPoll *api, const struct timeval *tv, AvahiTimeoutCallback callback, void *userdata)
	Set a wakeup time for the polling loop.
void(*	timeout_update )(AvahiTimeout *, const struct timeval *tv)
	Update the absolute expiration time for a timeout, If tv is NULL, the timeout is disabled.
void(*	timeout_free )(AvahiTimeout *t)
	Free a timeout.

---

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 62 of file watch.h.

---

Field Documentation

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

Free a timeout.

It is safe to call this function from an AvahiTimeoutCallback

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.

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

void* AvahiPoll::userdata

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

Definition at line 65 of file watch.h.

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

Free a watch.

It is safe to call this function from an AvahiWatchCallback

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

Return the events that happened.

It is safe to call this function from an AvahiWatchCallback

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.

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

Update the events to wait for.

It is safe to call this function from an AvahiWatchCallback

---

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

• avahi-common/watch.h