Zephyr API Documentation 4.1.99
A Scalable Open Source RTOS
 4.1.99
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
socket_offload.h File Reference

Socket Offload Redirect API. More...

Go to the source code of this file.

Data Structures

struct  socket_dns_offload
 An offloaded Socket DNS API interface. More...
 

Macros

#define socket_offload_dns_is_enabled()
 Check if DNS offloading is enabled.
 

Functions

void socket_offload_dns_register (const struct socket_dns_offload *ops)
 Register an offloaded socket DNS API interface.
 
int socket_offload_dns_deregister (const struct socket_dns_offload *ops)
 Deregister an offloaded socket DNS API interface.
 
void socket_offload_dns_enable (bool enable)
 Enable/disable DNS offloading at runtime.
 

Detailed Description

Socket Offload Redirect API.

Macro Definition Documentation

◆ socket_offload_dns_is_enabled

#define socket_offload_dns_is_enabled ( )
Value:
false

Check if DNS offloading is enabled.

Return values
trueDNS offloaded API is registered and enabled.
falseDNS offloading is disabled.

Function Documentation

◆ socket_offload_dns_deregister()

int socket_offload_dns_deregister ( const struct socket_dns_offload * ops)

Deregister an offloaded socket DNS API interface.

Parameters
opsA pointer to the offloaded socket DNS API interface.
Return values
0On success
-EINVALOffloaded DNS API was not regsitered.

◆ socket_offload_dns_enable()

void socket_offload_dns_enable ( bool enable)

Enable/disable DNS offloading at runtime.

Parameters
enableWhether to enable or disable the DNS offloading.

◆ socket_offload_dns_register()

void socket_offload_dns_register ( const struct socket_dns_offload * ops)

Register an offloaded socket DNS API interface.

Parameters
opsA pointer to the offloaded socket DNS API interface.