defs.h File Reference

#include <avahi-common/cdecl.h>

Include dependency graph for defs.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines
#define	AVAHI_DEFAULT_TTL   (75*60)
#define	AVAHI_DEFAULT_TTL_HOST_NAME   (120)
Enumerations
States
enum	AvahiServerState {   AVAHI_SERVER_INVALID, AVAHI_SERVER_REGISTERING, AVAHI_SERVER_RUNNING, AVAHI_SERVER_COLLISION,   AVAHI_SERVER_FAILURE }
enum	AvahiEntryGroupState {   AVAHI_ENTRY_GROUP_UNCOMMITED, AVAHI_ENTRY_GROUP_REGISTERING, AVAHI_ENTRY_GROUP_ESTABLISHED, AVAHI_ENTRY_GROUP_COLLISION,   AVAHI_ENTRY_GROUP_FAILURE }
Flags
enum	AvahiPublishFlags {   AVAHI_PUBLISH_UNIQUE = 1, AVAHI_PUBLISH_NO_PROBE = 2, AVAHI_PUBLISH_NO_ANNOUNCE = 4, AVAHI_PUBLISH_ALLOW_MULTIPLE = 8,   AVAHI_PUBLISH_UPDATE = 64 }
enum	AvahiLookupFlags { AVAHI_LOOKUP_NO_TXT = 4, AVAHI_LOOKUP_NO_ADDRESS = 8 }
enum	AvahiLookupResultFlags {   AVAHI_LOOKUP_RESULT_CACHED = 1, AVAHI_LOOKUP_RESULT_WIDE_AREA = 2, AVAHI_LOOKUP_RESULT_MULTICAST = 4, AVAHI_LOOKUP_RESULT_LOCAL = 8,   AVAHI_LOOKUP_RESULT_OUR_OWN = 16, AVAHI_LOOKUP_RESULT_STATIC = 32 }
Events
enum	AvahiBrowserEvent {   AVAHI_BROWSER_NEW, AVAHI_BROWSER_REMOVE, AVAHI_BROWSER_CACHE_EXHAUSTED, AVAHI_BROWSER_ALL_FOR_NOW,   AVAHI_BROWSER_FAILURE }
enum	AvahiResolverEvent { AVAHI_RESOLVER_FOUND, AVAHI_RESOLVER_FAILURE }
Other definitions
enum	AvahiDomainBrowserType {   AVAHI_DOMAIN_BROWSER_BROWSE, AVAHI_DOMAIN_BROWSER_BROWSE_DEFAULT, AVAHI_DOMAIN_BROWSER_REGISTER, AVAHI_DOMAIN_BROWSER_REGISTER_DEFAULT,   AVAHI_DOMAIN_BROWSER_BROWSE_LEGACY, AVAHI_DOMAIN_BROWSER_MAX }
DNS RR definitions
fulldocs
enum	{   AVAHI_DNS_TYPE_A = 0x01, AVAHI_DNS_TYPE_NS = 0x02, AVAHI_DNS_TYPE_CNAME = 0x05, AVAHI_DNS_TYPE_SOA = 0x06,   AVAHI_DNS_TYPE_PTR = 0x0C, AVAHI_DNS_TYPE_HINFO = 0x0D, AVAHI_DNS_TYPE_MX = 0x0F, AVAHI_DNS_TYPE_TXT = 0x10,   AVAHI_DNS_TYPE_AAAA = 0x1C, AVAHI_DNS_TYPE_SRV = 0x21 }
enum	{ AVAHI_DNS_CLASS_IN = 0x01 }

---

Detailed Description

Some common definitions

Definition in file defs.h.

---

Define Documentation

#define AVAHI_DEFAULT_TTL   (75*60)

The default TTL for all other records.

Definition at line 350 of file defs.h.

#define AVAHI_DEFAULT_TTL_HOST_NAME   (120)

The default TTL for RRs which contain a host name of some kind.

Definition at line 347 of file defs.h.

---

Enumeration Type Documentation

anonymous enum

DNS record types, see RFC 1035

Enumerator:

AVAHI_DNS_TYPE_A
AVAHI_DNS_TYPE_NS
AVAHI_DNS_TYPE_CNAME
AVAHI_DNS_TYPE_SOA
AVAHI_DNS_TYPE_PTR
AVAHI_DNS_TYPE_HINFO
AVAHI_DNS_TYPE_MX
AVAHI_DNS_TYPE_TXT
AVAHI_DNS_TYPE_AAAA
AVAHI_DNS_TYPE_SRV

Definition at line 326 of file defs.h.

anonymous enum

DNS record classes, see RFC 1035

Enumerator:

AVAHI_DNS_CLASS_IN

Probably the only class we will ever use

Definition at line 340 of file defs.h.

enum AvahiBrowserEvent

Type of callback event when browsing

Enumerator:

AVAHI_BROWSER_NEW	The object is new on the network
AVAHI_BROWSER_REMOVE	The object has been removed from the network
AVAHI_BROWSER_CACHE_EXHAUSTED	One-time event, to notify the user that all entries from the caches have been send
AVAHI_BROWSER_ALL_FOR_NOW	One-time event, to notify the user that more records will probably not show up in the near future, i.e. all cache entries have been read and all static servers been queried
AVAHI_BROWSER_FAILURE	Browsing failed due to some reason which can be retrieved using avahi_server_errno()/avahi_client_errno()

Definition at line 282 of file defs.h.

enum AvahiDomainBrowserType

The type of domain to browse for

Enumerator:

AVAHI_DOMAIN_BROWSER_BROWSE	Browse for a list of available browsing domains
AVAHI_DOMAIN_BROWSER_BROWSE_DEFAULT	Browse for the default browsing domain
AVAHI_DOMAIN_BROWSER_REGISTER	Browse for a list of available registering domains
AVAHI_DOMAIN_BROWSER_REGISTER_DEFAULT	Browse for the default registering domain
AVAHI_DOMAIN_BROWSER_BROWSE_LEGACY	Legacy browse domain - see DNS-SD spec for more information
AVAHI_DOMAIN_BROWSER_MAX

Definition at line 301 of file defs.h.

enum AvahiEntryGroupState

States of an entry group object

Enumerator:

AVAHI_ENTRY_GROUP_UNCOMMITED	The group has not yet been commited, the user must still call avahi_entry_group_commit()
AVAHI_ENTRY_GROUP_REGISTERING	The entries of the group are currently being registered
AVAHI_ENTRY_GROUP_ESTABLISHED	The entries have successfully been established
AVAHI_ENTRY_GROUP_COLLISION	A name collision for one of the entries in the group has been detected, the entries have been withdrawn
AVAHI_ENTRY_GROUP_FAILURE	Some kind of failure happened, the entries have been withdrawn

Definition at line 228 of file defs.h.

enum AvahiLookupFlags

Some flags for lookup functions

Enumerator:

AVAHI_LOOKUP_NO_TXT	When doing service resolving, don't lookup TXT record
AVAHI_LOOKUP_NO_ADDRESS	When doing service resolving, don't lookup A/AAAA record

Definition at line 258 of file defs.h.

enum AvahiLookupResultFlags

Some flags for lookup callback functions

Enumerator:

AVAHI_LOOKUP_RESULT_CACHED	This response originates from the cache
AVAHI_LOOKUP_RESULT_WIDE_AREA	This response originates from wide area DNS
AVAHI_LOOKUP_RESULT_MULTICAST	This response originates from multicast DNS
AVAHI_LOOKUP_RESULT_LOCAL	This record/service resides on and was announced by the local host. Only available in service and record browsers and only on AVAHI_BROWSER_NEW.
AVAHI_LOOKUP_RESULT_OUR_OWN	This service belongs to the same local client as the browser object. Only available in avahi-client, and only for service browsers and only on AVAHI_BROWSER_NEW.
AVAHI_LOOKUP_RESULT_STATIC	The returned data has been defined statically by some configuration option

Definition at line 268 of file defs.h.

enum AvahiPublishFlags

Some flags for publishing functions

Enumerator:

AVAHI_PUBLISH_UNIQUE	For raw records: The RRset is intended to be unique
AVAHI_PUBLISH_NO_PROBE	For raw records: Though the RRset is intended to be unique no probes shall be sent
AVAHI_PUBLISH_NO_ANNOUNCE	For raw records: Do not announce this RR to other hosts
AVAHI_PUBLISH_ALLOW_MULTIPLE	For raw records: Allow multiple local records of this type, even if they are intended to be unique
AVAHI_PUBLISH_UPDATE	Update existing records instead of adding new ones

Definition at line 241 of file defs.h.

enum AvahiResolverEvent

Type of callback event when resolving

Enumerator:

AVAHI_RESOLVER_FOUND	RR found, resolving successful
AVAHI_RESOLVER_FAILURE	Resolving failed due to some reason which can be retrieved using avahi_server_errno()/avahi_client_errno()

Definition at line 291 of file defs.h.

enum AvahiServerState

States of a server object

Enumerator:

AVAHI_SERVER_INVALID	Invalid state (initial)
AVAHI_SERVER_REGISTERING	Host RRs are being registered
AVAHI_SERVER_RUNNING	All host RRs have been established
AVAHI_SERVER_COLLISION	There is a collision with a host RR. All host RRs have been withdrawn, the user should set a new host name via avahi_server_set_host_name()
AVAHI_SERVER_FAILURE	Some fatal failure happened, the server is unable to proceed

Definition at line 219 of file defs.h.