interesting
/
getdns
mirror of https://github.com/getdnsapi/getdns.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

beefed up some function comments

This commit is contained in:
Glen Wiley 2014-01-28 09:07:21 -05:00
parent f0f755ec86
commit 5c75d3c6a6
1 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
src/util-internal.h
View File

@ -80,7 +80,15 @@ getdns_return_t getdns_list_copy(struct getdns_list *srclist,
getdns_return_t
getdns_dict_copy(struct getdns_dict *srcdict, struct getdns_dict **dstdict);
/* convert an ip address dict to a sock storage */
/**
* convert an ip address (v4/v6) dict to a sock storage
* expects dict to contain keys GETDNS_STR_PORT, GETDNS_STR_ADDRESS_TYPE
* GETDNS_STR_ADDRESS_DATA
* @param ns pointer to dictionary containing keys listed above
* @param output previously allocated storage used to return numeric address
* @return GETDNS_RETURN_GOOD on success
* @return GETDNS_RETURN_GENERIC_ERROR if keys missing from dictionary
*/
getdns_return_t dict_to_sockaddr(struct getdns_dict * ns,
struct sockaddr_storage *output);
getdns_return_t sockaddr_to_dict(struct getdns_context *context,
@ -111,9 +119,12 @@ getdns_return_t validate_dname(const char* dname);
*/
getdns_return_t validate_extensions(struct getdns_dict * extensions);
/* helper to convert an rr_list to getdns_list.
returns a list of objects where each object
is a result from create_dict_from_rr */
/**
* helper to convert an rr_list to getdns_list
* @param context initialized getdns_context
* @param rr_list ldns rr list to be converted
* @return a list of objects where each object is a result from create_dict_from_rr
*/
struct getdns_list *
create_list_from_rr_list(struct getdns_context *context, ldns_rr_list * rr_list);