FreeRTOS_GetAddressConfiguration() API Reference

FreeRTOS_GetAddressConfiguration()

[FreeRTOS Embedded IP Stack API]

void FreeRTOS_GetAddressConfiguration( uint32_t *pulIPAddress,
                                       uint32_t *pulNetMask,
                                       uint32_t *pulGatewayAddress,
                                       uint32_t *pulDNSServerAddress );

Obtains the network address configuration from the IP stack.

Parameters:

pulIPAddress

Used to return the IP address being used by the IP stack.

The IP address is represented as a 32-bit number in network byte order.

pulNetMask

Used to return the net mask being used by the IP stack.

The net mask is represented as a 32-bit number in network byte order.

pulGatewayAddress

Used to return the IP address of the gateway being used by the IP stack.

The IP address is represented as a 32-bit number in network byte order.

pulDNSServerAddress

Used to return the IP address of the DNS server being used by the IP stack.

The IP address is represented as a 32-bit number in network byte order.

Example usage:


/* FreeRTOS+UDP sockets include */
#define "FreeRTOS_sockets.h"

void vApplicationIPNetworkEventHook( eIPCallbackEvent_t eNetworkEvent )
{
uint32_t ulIPAddress, ulNetMask, ulGatewayAddress, ulDNSServerAddress;
int8_t cBuffer[ 16 ];

    if( eNetworkEvent == eNetworkUp )
    {
        /* The network is up and configured.  Print out the configuration
        obtained from the DHCP server. */
        FreeRTOS_GetAddressConfiguration( &ulIPAddress, 
                                          &ulNetMask, 
                                          &ulGatewayAddress, 
                                          &ulDNSServerAddress );
                                            
        /* Convert the IP address to a string then print it out. */
        FreeRTOS_inet_ntoa( ulIPAddress, cBuffer );
        printf( "IP Address: %s\r\n", cBuffer );
        
        /* Convert the net mask to a string then print it out. */
        FreeRTOS_inet_ntoa( ulNetMask, cBuffer );
        printf( "Subnet Mask: %s\r\n", cBuffer );

        /* Convert the IP address of the gateway to a string then print it out. */
        FreeRTOS_inet_ntoa( ulGatewayAddress, cBuffer );
        printf( "Gateway IP Address: %s\r\n", cBuffer );

        /* Convert the IP address of the DNS server to a string then print it out. */
        FreeRTOS_inet_ntoa( ulDNSServerAddress, cBuffer );
        printf( "DNS server IP Address: %s\r\n", cBuffer );
    }
}

Example use of the FreeRTOS_GetAddressConfiguration() API function

The FreeRTOS Ecosystem Showcase . . . A Selection of Add-on and Complementary Products

FreeRTOS_GetAddressConfiguration() [FreeRTOS Embedded IP Stack API]

The FreeRTOS Ecosystem Showcase . . .
A Selection of Add-on and Complementary Products

FreeRTOS_GetAddressConfiguration()

[FreeRTOS Embedded IP Stack API]