NetworkPkg/HttpDxe/HttpDns.h

   1 /** @file
   2   The header file of routines for HttpDxe driver to perform DNS resolution based on UEFI DNS protocols.
   3
   4 Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>
   5 SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7 **/
   8
   9 #ifndef __EFI_HTTP_DNS_H__
  10 #define __EFI_HTTP_DNS_H__
  11
  12 /**
  13   Retrieve the host address using the EFI_DNS4_PROTOCOL.
  14
  15   @param[in]  HttpInstance        Pointer to HTTP_PROTOCOL instance.
  16   @param[in]  HostName            Pointer to buffer containing hostname.
  17   @param[out] IpAddress           On output, pointer to buffer containing IPv4 address.
  18
  19   @retval EFI_SUCCESS             Operation succeeded.
  20   @retval EFI_OUT_OF_RESOURCES    Failed to allocate needed resources.
  21   @retval EFI_DEVICE_ERROR        An unexpected network error occurred.
  22   @retval Others                  Other errors as indicated.
  23
  24 **/
  25 EFI_STATUS
  26 HttpDns4 (
  27   IN     HTTP_PROTOCOL            *HttpInstance,
  28   IN     CHAR16                   *HostName,
  29      OUT EFI_IPv4_ADDRESS         *IpAddress
  30   );
  31
  32 /**
  33   Retrieve the host address using the EFI_DNS6_PROTOCOL.
  34
  35   @param[in]  HttpInstance        Pointer to HTTP_PROTOCOL instance.
  36   @param[in]  HostName            Pointer to buffer containing hostname.
  37   @param[out] IpAddress           On output, pointer to buffer containing IPv6 address.
  38
  39   @retval EFI_SUCCESS             Operation succeeded.
  40   @retval EFI_OUT_OF_RESOURCES    Failed to allocate needed resources.
  41   @retval EFI_DEVICE_ERROR        An unexpected network error occurred.
  42   @retval Others                  Other errors as indicated.
  43
  44 **/
  45 EFI_STATUS
  46 HttpDns6 (
  47   IN     HTTP_PROTOCOL            *HttpInstance,
  48   IN     CHAR16                   *HostName,
  49      OUT EFI_IPv6_ADDRESS         *IpAddress
  50   );
  51
  52 #endif