API documentation for avahi_client_new

[jkyro]

The API documentation doesn't tell that the avahi_client_new function also calls the callback provided as parameter.

The expression is "whenever the client state changes", but there's no mention about the creation of the client itself generating a state change that gets handled before the function actually returns. This has the implication that the value stored from avahi_client_new can't be used in the callback.

In my opinion, I'm not expecting the callback to be called until entering the event loop unless stated otherwise.

Example:

static AvahiClient *global_client = NULL;



void my_client_callbcak( AvahiClient *client, AvahiClientState s, void *userdata)
{
    //global_client is NULL the first time this function is called
    ...
}

int main() 
{
    global_client = avahi_client_new(); 

}

[lathiat]

As a point, given the client is passed in with the callback anyway (as the first argument 'client')

You shouldn't be using the global value anyway

[jkyro]

Yes, I agree. But I still think the documentation should be more explicit here.

[lathiat]

Yep, you're 100% correct.

[lathiat]

This should also be reflected in the entry_group_new code, as we even made this mistake ourselves (Bug #79)

[lennart]

(In [1359]) Fix documentation of avahi_{entry_group|client}_new(): clarify that the specified callback function is called for the first time from withing the avahi_xxx_new() context. (Closes #65)