Skip to content

Commit

Permalink
LookupFlags documentation updated
Browse files Browse the repository at this point in the history
  • Loading branch information
alexpevzner committed Aug 20, 2024
1 parent b4a7f03 commit e4b6e17
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion lookupflags.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,24 @@ import "C"
// LookupFlags provides some options for lookup functions
type LookupFlags int

// LookupFlags values
// LookupFlags values.
//
// Please notice, LookupUseWideArea and LookupUseMulticast are
// mutually exclusive. Each of these flags forces the particular
// lookup methods, so if both are set, no valid lookup methods
// remains. The following simple table summarize usage of these
// flags:
//
// Flags combination Meaning
//
// 0 WAN + Multicast
// LookupUseWideArea WAN only
// LookupUseMulticast mDNS only
// LookupUseWideArea | LookupUseMulticast Invalid
//
// LookupNoTXT and LookupNoAddress are only meaningful for creating
// [ServiceResolver] with the [NewServiceResolver] function. Using
// them for any other purpose may result in [ErrInvalidFlags] error.
const (
// Force lookup via wide area DNS
LookupUseWideArea LookupFlags = C.AVAHI_LOOKUP_USE_WIDE_AREA
Expand Down

0 comments on commit e4b6e17

Please sign in to comment.