Skip to content

Commit

Permalink
net: doc: socket_offload.h: Improve documentation
Browse files Browse the repository at this point in the history
Fix the socket_offload.h header file documentation.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
  • Loading branch information
jukkar authored and carlescufi committed May 21, 2024
1 parent f8a3c95 commit 77a8f1b
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions include/zephyr/net/socket_offload.h
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,11 @@ extern "C" {
* POSIX socket API standard for arguments, return values and setting of errno.
*/
struct socket_dns_offload {
/** DNS getaddrinfo offloaded implementation API */
int (*getaddrinfo)(const char *node, const char *service,
const struct zsock_addrinfo *hints,
struct zsock_addrinfo **res);
/** DNS freeaddrinfo offloaded implementation API */
void (*freeaddrinfo)(struct zsock_addrinfo *res);
};

Expand All @@ -39,12 +41,16 @@ struct socket_dns_offload {
*/
void socket_offload_dns_register(const struct socket_dns_offload *ops);

/** @cond INTERNAL_HIDDEN */

int socket_offload_getaddrinfo(const char *node, const char *service,
const struct zsock_addrinfo *hints,
struct zsock_addrinfo **res);

void socket_offload_freeaddrinfo(struct zsock_addrinfo *res);

/** @endcond */

#ifdef __cplusplus
}
#endif
Expand Down

0 comments on commit 77a8f1b

Please sign in to comment.