Functions | |
EFI_STATUS EFIAPI | Dns4GetModeData (IN EFI_DNS4_PROTOCOL *This, OUT EFI_DNS4_MODE_DATA *DnsModeData) |
EFI_STATUS EFIAPI | Dns4Configure (IN EFI_DNS4_PROTOCOL *This, IN EFI_DNS4_CONFIG_DATA *DnsConfigData) |
EFI_STATUS EFIAPI | Dns4HostNameToIp (IN EFI_DNS4_PROTOCOL *This, IN CHAR16 *HostName, IN EFI_DNS4_COMPLETION_TOKEN *Token) |
EFI_STATUS EFIAPI | Dns4IpToHostName (IN EFI_DNS4_PROTOCOL *This, IN EFI_IPv4_ADDRESS IpAddress, IN EFI_DNS4_COMPLETION_TOKEN *Token) |
EFI_STATUS EFIAPI | Dns4GeneralLookUp (IN EFI_DNS4_PROTOCOL *This, IN CHAR8 *QName, IN UINT16 QType, IN UINT16 QClass, IN EFI_DNS4_COMPLETION_TOKEN *Token) |
EFI_STATUS EFIAPI | Dns4UpdateDnsCache (IN EFI_DNS4_PROTOCOL *This, IN BOOLEAN DeleteFlag, IN BOOLEAN Override, IN EFI_DNS4_CACHE_ENTRY DnsCacheEntry) |
EFI_STATUS EFIAPI | Dns4Poll (IN EFI_DNS4_PROTOCOL *This) |
EFI_STATUS EFIAPI | Dns4Cancel (IN EFI_DNS4_PROTOCOL *This, IN EFI_DNS4_COMPLETION_TOKEN *Token) |
EFI_STATUS EFIAPI | Dns6GetModeData (IN EFI_DNS6_PROTOCOL *This, OUT EFI_DNS6_MODE_DATA *DnsModeData) |
EFI_STATUS EFIAPI | Dns6Configure (IN EFI_DNS6_PROTOCOL *This, IN EFI_DNS6_CONFIG_DATA *DnsConfigData) |
EFI_STATUS EFIAPI | Dns6HostNameToIp (IN EFI_DNS6_PROTOCOL *This, IN CHAR16 *HostName, IN EFI_DNS6_COMPLETION_TOKEN *Token) |
EFI_STATUS EFIAPI | Dns6IpToHostName (IN EFI_DNS6_PROTOCOL *This, IN EFI_IPv6_ADDRESS IpAddress, IN EFI_DNS6_COMPLETION_TOKEN *Token) |
EFI_STATUS EFIAPI | Dns6GeneralLookUp (IN EFI_DNS6_PROTOCOL *This, IN CHAR8 *QName, IN UINT16 QType, IN UINT16 QClass, IN EFI_DNS6_COMPLETION_TOKEN *Token) |
EFI_STATUS EFIAPI | Dns6UpdateDnsCache (IN EFI_DNS6_PROTOCOL *This, IN BOOLEAN DeleteFlag, IN BOOLEAN Override, IN EFI_DNS6_CACHE_ENTRY DnsCacheEntry) |
EFI_STATUS EFIAPI | Dns6Poll (IN EFI_DNS6_PROTOCOL *This) |
EFI_STATUS EFIAPI | Dns6Cancel (IN EFI_DNS6_PROTOCOL *This, IN EFI_DNS6_COMPLETION_TOKEN *Token) |
Variables | |
EFI_DNS4_PROTOCOL | mDns4Protocol |
EFI_DNS6_PROTOCOL | mDns6Protocol |
Copyright (c) 2015, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
EFI_STATUS EFIAPI Dns4Cancel | ( | IN EFI_DNS4_PROTOCOL * | This, | |
IN EFI_DNS4_COMPLETION_TOKEN * | Token | |||
) |
This function is used to abort a pending resolution request. After calling this function, Token.Status will be set to EFI_ABORTED and then Token.
[in] | This | Pointer to EFI_DNS4_PROTOCOL instance. |
[in] | Token | Pointer to a token that has been issued by EFI_DNS4_PROTOCOL.HostNameToIp(), EFI_DNS4_PROTOCOL.IpToHostName() or EFI_DNS4_PROTOCOL.GeneralLookup(). If NULL, all pending tokens are aborted. |
EFI_SUCCESS | Incoming or outgoing data was processed. | |
EFI_INVALID_PARAMETER | This is NULL. | |
EFI_NOT_STARTED | This EFI DNS Protocol instance has not been started. | |
EFI_NOT_FOUND | When Token is not NULL, and the asynchronous DNS operation was not found in the transmit queue. It was either completed or was not issued by HostNameToIp(), IpToHostName() or GeneralLookup(). |
References Dns4InstanceCancelToken(), DNS_INSTANCE_FROM_THIS_PROTOCOL4, DNS_STATE_UNCONFIGED, and _DNS_INSTANCE::State.
EFI_STATUS EFIAPI Dns4Configure | ( | IN EFI_DNS4_PROTOCOL * | This, | |
IN EFI_DNS4_CONFIG_DATA * | DnsConfigData | |||
) |
This function is used to configure DNS configuration data for this DNS instance.
[in] | This | Pointer to EFI_DNS4_PROTOCOL instance. |
[in] | DnsConfigData | Pointer to caller-allocated buffer containing EFI_DNS4_CONFIG_DATA structure. If NULL, the driver will reinitialize the protocol instance to the unconfigured state. |
EFI_SUCCESS | The operation completed successfully. | |
EFI_UNSUPPORTED | The designated protocol is not supported. | |
EFI_OUT_OF_RESOURCES | Failed to allocate needed resources. | |
EFI_INVALID_PARAMETER | This is NULL. The StationIp address provided in DnsConfigData is not a valid unicast. DnsServerList is NULL while DnsServerListCount is not equal to Zero. DnsServerListCount is Zero while DnsServerListCount is not equal to NULL. | |
EFI_DEVICE_ERROR | An unexpected system or network error occurred. The EFI DNSv4 Protocol instance is not configured. |
References AddDns4ServerIp(), _DNS_INSTANCE::Dns4CfgData, Dns4ConfigUdp(), Dns4CopyConfigure(), Dns4InstanceCancelToken(), _DNS_DRIVER_DATA::Dns4ServerList, _DNS_INSTANCE::Dns4TxTokens, DNS_INSTANCE_FROM_THIS_PROTOCOL4, DNS_PROTOCOL_UDP, DNS_STATE_CONFIGED, DNS_STATE_UNCONFIGED, GetDns4ServerFromDhcp4(), _DNS_INSTANCE::MaxRetry, mDriverData, _DNS_INSTANCE::SessionDnsServer, _DNS_INSTANCE::State, and _DNS_INSTANCE::UdpIo.
EFI_STATUS EFIAPI Dns4GeneralLookUp | ( | IN EFI_DNS4_PROTOCOL * | This, | |
IN CHAR8 * | QName, | |||
IN UINT16 | QType, | |||
IN UINT16 | QClass, | |||
IN EFI_DNS4_COMPLETION_TOKEN * | Token | |||
) |
This function retrieves arbitrary information from the DNS. The caller supplies a QNAME, QTYPE, and QCLASS, and all of the matching RRs are returned. All RR content (e.g., Ttl) was returned. The caller need parse the returned RR to get required information. This function is optional.
[in] | This | Pointer to EFI_DNS4_PROTOCOL instance. |
[in] | QName | Pointer to Query Name. |
[in] | QType | Query Type. |
[in] | QClass | Query Name. |
[in] | Token | Point to the caller-allocated completion token to retrieve arbitrary information. |
EFI_SUCCESS | The operation completed successfully. | |
EFI_OUT_OF_RESOURCES | Failed to allocate needed resources. | |
EFI_INVALID_PARAMETER | This is NULL. Token is NULL. Token.Event is NULL. QName is NULL. | |
EFI_NO_MAPPING | There's no source address is available for use. | |
EFI_ALREADY_STARTED | This Token is being used in another DNS session. | |
EFI_UNSUPPORTED | This function is not supported. Or the requested QType is not supported |
EFI_STATUS EFIAPI Dns4GetModeData | ( | IN EFI_DNS4_PROTOCOL * | This, | |
OUT EFI_DNS4_MODE_DATA * | DnsModeData | |||
) |
This function is used to retrieve DNS mode data for this DNS instance.
[in] | This | Pointer to EFI_DNS4_PROTOCOL instance. |
[out] | DnsModeData | Pointer to the caller-allocated storage for the EFI_DNS4_MODE_DATA structure. |
EFI_SUCCESS | The operation completed successfully. | |
EFI_NOT_STARTED | When DnsConfigData is queried, no configuration data is available because this instance has not been configured. | |
EFI_OUT_OF_RESOURCES | Failed to allocate needed resources. | |
EFI_INVALID_PARAMETER | This is NULL or DnsModeData is NULL. |
References _DNS_DRIVER_DATA::Dns4CacheList, _DNS_INSTANCE::Dns4CfgData, Dns4CopyConfigure(), DNS4_SERVER_IP::Dns4ServerIp, _DNS_DRIVER_DATA::Dns4ServerList, DNS_INSTANCE_FROM_THIS_PROTOCOL4, DNS_STATE_UNCONFIGED, DNS4_CACHE::DnsCache, mDriverData, and _DNS_INSTANCE::State.
EFI_STATUS EFIAPI Dns4HostNameToIp | ( | IN EFI_DNS4_PROTOCOL * | This, | |
IN CHAR16 * | HostName, | |||
IN EFI_DNS4_COMPLETION_TOKEN * | Token | |||
) |
The function is used to translate the host name to host IP address. A type A query is used to get the one or more IP addresses for this host.
[in] | This | Pointer to EFI_DNS4_PROTOCOL instance. |
[in] | HostName | Pointer to caller-supplied buffer containing Host name to be translated. This buffer contains 16 bit characters but these are translated to ASCII for use with DNSv4 server and there is no requirement for driver to support non-ASCII Unicode characters. |
[in] | Token | Pointer to the caller-allocated completion token to return at the completion of the process to translate host name to host address. |
EFI_SUCCESS | The operation completed successfully. | |
EFI_OUT_OF_RESOURCES | Failed to allocate needed resources. | |
EFI_INVALID_PARAMETER | This is NULL. Token is NULL. Token.Event is.NULL HostName is NULL | |
EFI_NO_MAPPING | There's no source address is available for use. | |
EFI_NOT_STARTED | This instance has not been started. |
References ConstructDNSQueryIp(), _DNS_DRIVER_DATA::Dns4CacheList, _DNS_INSTANCE::Dns4CfgData, _DNS_INSTANCE::Dns4TxTokens, DNS_DEFAULT_RETRY, DNS_DEFAULT_TIMEOUT, DNS_INSTANCE_FROM_THIS_PROTOCOL4, DNS_STATE_CONFIGED, DNS_TYPE_A, DNS4_CACHE::DnsCache, DoDnsQuery(), _DNS_INSTANCE::MaxRetry, mDriverData, DNS4_TOKEN_ENTRY::PacketToLive, DNS4_TOKEN_ENTRY::QueryHostName, _DNS_INSTANCE::State, and DNS4_TOKEN_ENTRY::Token.
EFI_STATUS EFIAPI Dns4IpToHostName | ( | IN EFI_DNS4_PROTOCOL * | This, | |
IN EFI_IPv4_ADDRESS | IpAddress, | |||
IN EFI_DNS4_COMPLETION_TOKEN * | Token | |||
) |
The function is used to translate the host address to host name. A type PTR query is used to get the primary name of the host.
[in] | This | Pointer to EFI_DNS4_PROTOCOL instance. |
[in] | IpAddress | IP address. |
[in] | Token | Pointer to the caller-allocated completion used token to translate host address to host name. |
EFI_SUCCESS | The operation completed successfully. | |
EFI_OUT_OF_RESOURCES | Failed to allocate needed resources. | |
EFI_INVALID_PARAMETER | This is NULL. Token is NULL. Token.Event is NULL. IpAddress is not valid IP address. | |
EFI_NO_MAPPING | There's no source address is available for use. | |
EFI_NOT_STARTED | This instance has not been started. | |
EFI_UNSUPPORTED | This function is not supported. |
EFI_STATUS EFIAPI Dns4Poll | ( | IN EFI_DNS4_PROTOCOL * | This | ) |
This function can be used by network drivers and applications to increase the rate that data packets are moved between the communications device and the transmit and receive queues. In some systems, the periodic timer event in the managed network driver may not poll the underlying communications device fast enough to transmit and/or receive all data packets without missing incoming packets or dropping outgoing packets.
[in] | This | Pointer to EFI_DNS4_PROTOCOL instance. |
EFI_SUCCESS | Incoming or outgoing data was processed. | |
EFI_INVALID_PARAMETER | This is NULL. | |
EFI_NOT_STARTED | This EFI DNS Protocol instance has not been started. | |
EFI_DEVICE_ERROR | An unexpected system or network error occurred. | |
EFI_TIMEOUT | Data was dropped out of the transmit and/or receive queue. Consider increasing the polling rate. |
References DNS_INSTANCE_FROM_THIS_PROTOCOL4, DNS_STATE_DESTROY, DNS_STATE_UNCONFIGED, _DNS_INSTANCE::State, and _DNS_INSTANCE::UdpIo.
EFI_STATUS EFIAPI Dns4UpdateDnsCache | ( | IN EFI_DNS4_PROTOCOL * | This, | |
IN BOOLEAN | DeleteFlag, | |||
IN BOOLEAN | Override, | |||
IN EFI_DNS4_CACHE_ENTRY | DnsCacheEntry | |||
) |
This function is used to add/delete/modify DNS cache entry. DNS cache can be normally dynamically updated after the DNS resolve succeeds. This function provided capability to manually add/delete/modify the DNS cache.
[in] | This | Pointer to EFI_DNS4_PROTOCOL instance. |
[in] | DeleteFlag | If FALSE, this function is to add one entry to the DNS Cache. If TRUE, this function will delete matching DNS Cache entry. |
[in] | Override | If TRUE, the matching DNS cache entry will be overwritten with the supplied parameter. If FALSE, EFI_ACCESS_DENIED will be returned if the entry to be added is already exists. |
[in] | DnsCacheEntry | Pointer to DNS Cache entry. |
EFI_SUCCESS | The operation completed successfully. | |
EFI_INVALID_PARAMETER | This is NULL. DnsCacheEntry.HostName is NULL. DnsCacheEntry.IpAddress is NULL. DnsCacheEntry.Timeout is zero. | |
EFI_ACCESS_DENIED | The DNS cache entry already exists and Override is not TRUE. |
References _DNS_DRIVER_DATA::Dns4CacheList, mDriverData, and UpdateDns4Cache().
EFI_STATUS EFIAPI Dns6Cancel | ( | IN EFI_DNS6_PROTOCOL * | This, | |
IN EFI_DNS6_COMPLETION_TOKEN * | Token | |||
) |
This function is used to abort a pending resolution request. After calling this function, Token.Status will be set to EFI_ABORTED and then Token.
[in] | This | Pointer to EFI_DNS6_PROTOCOL instance. |
[in] | Token | Pointer to a token that has been issued by EFI_DNS6_PROTOCOL.HostNameToIp(), EFI_DNS6_PROTOCOL.IpToHostName() or EFI_DNS6_PROTOCOL.GeneralLookup(). If NULL, all pending tokens are aborted. |
EFI_SUCCESS | Incoming or outgoing data was processed. | |
EFI_INVALID_PARAMETER | This is NULL. | |
EFI_NOT_STARTED | This EFI DNS Protocol instance has not been started. | |
EFI_NOT_FOUND | When Token is not NULL, and the asynchronous DNS operation was not found in the transmit queue. It was either completed or was not issued by HostNameToIp(), IpToHostName() or GeneralLookup(). |
References Dns6InstanceCancelToken(), DNS_INSTANCE_FROM_THIS_PROTOCOL6, DNS_STATE_UNCONFIGED, and _DNS_INSTANCE::State.
EFI_STATUS EFIAPI Dns6Configure | ( | IN EFI_DNS6_PROTOCOL * | This, | |
IN EFI_DNS6_CONFIG_DATA * | DnsConfigData | |||
) |
The function is used to set and change the configuration data for this EFI DNSv6 Protocol driver instance. Reset the DNS instance if DnsConfigData is NULL.
[in] | This | Pointer to EFI_DNS6_PROTOCOL instance. |
[in] | DnsConfigData | Pointer to the configuration data structure. All associated storage to be allocated and released by caller. |
EFI_SUCCESS | The operation completed successfully. | |
EFI_UNSUPPORTED | The designated protocol is not supported. | |
EFI_OUT_OF_RESOURCES | Failed to allocate needed resources. | |
EFI_INVALID_PARAMETER | This is NULL. The StationIp address provided in DnsConfigData is not a valid unicast. DnsServerList is NULL while DnsServerListCount is not equal to Zero. DnsServerListCount is Zero while DnsServerList is not equal to NULL. | |
EFI_DEVICE_ERROR | An unexpected system or network error occurred. The EFI DNSv6 Protocol instance is not configured. |
References AddDns6ServerIp(), _DNS_SERVICE::ControllerHandle, _DNS_INSTANCE::Dns6CfgData, Dns6ConfigUdp(), Dns6CopyConfigure(), Dns6InstanceCancelToken(), _DNS_DRIVER_DATA::Dns6ServerList, _DNS_INSTANCE::Dns6TxTokens, DNS_INSTANCE_FROM_THIS_PROTOCOL6, DNS_PROTOCOL_UDP, DNS_STATE_CONFIGED, DNS_STATE_UNCONFIGED, GetDns6ServerFromDhcp6(), _DNS_SERVICE::ImageHandle, _DNS_INSTANCE::MaxRetry, mDriverData, _DNS_INSTANCE::Service, _DNS_INSTANCE::SessionDnsServer, _DNS_INSTANCE::State, and _DNS_INSTANCE::UdpIo.
EFI_STATUS EFIAPI Dns6GeneralLookUp | ( | IN EFI_DNS6_PROTOCOL * | This, | |
IN CHAR8 * | QName, | |||
IN UINT16 | QType, | |||
IN UINT16 | QClass, | |||
IN EFI_DNS6_COMPLETION_TOKEN * | Token | |||
) |
This function retrieves arbitrary information from the DNS. The caller supplies a QNAME, QTYPE, and QCLASS, and all of the matching RRs are returned. All RR content (e.g., Ttl) was returned. The caller need parse the returned RR to get required information. This function is optional.
[in] | This | Pointer to EFI_DNS6_PROTOCOL instance. |
[in] | QName | Pointer to Query Name. |
[in] | QType | Query Type. |
[in] | QClass | Query Name. |
[in] | Token | Point to the caller-allocated completion token to retrieve arbitrary information. |
EFI_SUCCESS | The operation completed successfully. | |
EFI_OUT_OF_RESOURCES | Failed to allocate needed resources. | |
EFI_INVALID_PARAMETER | This is NULL. Token is NULL. Token.Event is NULL. QName is NULL. | |
EFI_NO_MAPPING | There's no source address is available for use. | |
EFI_NOT_STARTED | This instance has not been started. | |
EFI_UNSUPPORTED | This function is not supported. Or the requested QType is not supported |
EFI_STATUS EFIAPI Dns6GetModeData | ( | IN EFI_DNS6_PROTOCOL * | This, | |
OUT EFI_DNS6_MODE_DATA * | DnsModeData | |||
) |
This function is used to retrieve DNS mode data for this DNS instance.
[in] | This | Pointer to EFI_DNS6_PROTOCOL instance. |
[out] | DnsModeData | Pointer to the caller-allocated storage for the EFI_DNS6_MODE_DATA structure. |
EFI_SUCCESS | The operation completed successfully. | |
EFI_NOT_STARTED | When DnsConfigData is queried, no configuration data is available because this instance has not been configured. | |
EFI_OUT_OF_RESOURCES | Failed to allocate needed resources. | |
EFI_INVALID_PARAMETER | This is NULL or DnsModeData is NULL. |
References _DNS_DRIVER_DATA::Dns6CacheList, _DNS_INSTANCE::Dns6CfgData, Dns6CopyConfigure(), DNS6_SERVER_IP::Dns6ServerIp, _DNS_DRIVER_DATA::Dns6ServerList, DNS_INSTANCE_FROM_THIS_PROTOCOL6, DNS_STATE_UNCONFIGED, DNS6_CACHE::DnsCache, mDriverData, and _DNS_INSTANCE::State.
EFI_STATUS EFIAPI Dns6HostNameToIp | ( | IN EFI_DNS6_PROTOCOL * | This, | |
IN CHAR16 * | HostName, | |||
IN EFI_DNS6_COMPLETION_TOKEN * | Token | |||
) |
The function is used to translate the host name to host IP address. A type AAAA query is used to get the one or more IPv6 addresses for this host.
[in] | This | Pointer to EFI_DNS6_PROTOCOL instance. |
[in] | HostName | Pointer to caller-supplied buffer containing Host name to be translated. This buffer contains 16 bit characters but these are translated to ASCII for use with DNSv4 server and there is no requirement for driver to support non-ASCII Unicode characters. |
[in] | Token | Pointer to the caller-allocated completion token to return at the completion of the process to translate host name to host address. |
EFI_SUCCESS | The operation completed successfully. | |
EFI_OUT_OF_RESOURCES | Failed to allocate needed resources. | |
EFI_INVALID_PARAMETER | This is NULL. Token is NULL. Token.Event is.NULL HostName is NULL | |
EFI_NO_MAPPING | There's no source address is available for use. | |
EFI_NOT_STARTED | This instance has not been started. |
References ConstructDNSQueryIp(), _DNS_DRIVER_DATA::Dns6CacheList, _DNS_INSTANCE::Dns6CfgData, _DNS_INSTANCE::Dns6TxTokens, DNS_DEFAULT_RETRY, DNS_DEFAULT_TIMEOUT, DNS_INSTANCE_FROM_THIS_PROTOCOL6, DNS_STATE_CONFIGED, DNS_TYPE_AAAA, DNS6_CACHE::DnsCache, DoDnsQuery(), _DNS_INSTANCE::MaxRetry, mDriverData, DNS6_TOKEN_ENTRY::PacketToLive, DNS6_TOKEN_ENTRY::QueryHostName, _DNS_INSTANCE::State, and DNS6_TOKEN_ENTRY::Token.
EFI_STATUS EFIAPI Dns6IpToHostName | ( | IN EFI_DNS6_PROTOCOL * | This, | |
IN EFI_IPv6_ADDRESS | IpAddress, | |||
IN EFI_DNS6_COMPLETION_TOKEN * | Token | |||
) |
The function is used to translate the host address to host name. A type PTR query is used to get the primary name of the host.
[in] | This | Pointer to EFI_DNS6_PROTOCOL instance. |
[in] | IpAddress | IP address. |
[in] | Token | Pointer to the caller-allocated completion used token to translate host address to host name. |
EFI_SUCCESS | The operation completed successfully. | |
EFI_OUT_OF_RESOURCES | Failed to allocate needed resources. | |
EFI_INVALID_PARAMETER | This is NULL. Token is NULL. Token.Event is NULL. IpAddress is not valid IP address. | |
EFI_NO_MAPPING | There's no source address is available for use. | |
EFI_NOT_STARTED | This instance has not been started. | |
EFI_UNSUPPORTED | This function is not supported. |
EFI_STATUS EFIAPI Dns6Poll | ( | IN EFI_DNS6_PROTOCOL * | This | ) |
This function can be used by network drivers and applications to increase the rate that data packets are moved between the communications device and the transmit and receive queues. In some systems, the periodic timer event in the managed network driver may not poll the underlying communications device fast enough to transmit and/or receive all data packets without missing incoming packets or dropping outgoing packets.
[in] | This | Pointer to EFI_DNS6_PROTOCOL instance. |
EFI_SUCCESS | Incoming or outgoing data was processed. | |
EFI_INVALID_PARAMETER | This is NULL. | |
EFI_NOT_STARTED | This EFI DNS Protocol instance has not been started. | |
EFI_DEVICE_ERROR | An unexpected system or network error occurred. | |
EFI_TIMEOUT | Data was dropped out of the transmit and/or receive queue. Consider increasing the polling rate. |
References DNS_INSTANCE_FROM_THIS_PROTOCOL6, DNS_STATE_DESTROY, DNS_STATE_UNCONFIGED, _DNS_INSTANCE::State, and _DNS_INSTANCE::UdpIo.
EFI_STATUS EFIAPI Dns6UpdateDnsCache | ( | IN EFI_DNS6_PROTOCOL * | This, | |
IN BOOLEAN | DeleteFlag, | |||
IN BOOLEAN | Override, | |||
IN EFI_DNS6_CACHE_ENTRY | DnsCacheEntry | |||
) |
This function is used to add/delete/modify DNS cache entry. DNS cache can be normally dynamically updated after the DNS resolve succeeds. This function provided capability to manually add/delete/modify the DNS cache.
[in] | This | Pointer to EFI_DNS6_PROTOCOL instance. |
[in] | DeleteFlag | If FALSE, this function is to add one entry to the DNS Cache. If TRUE, this function will delete matching DNS Cache entry. |
[in] | Override | If TRUE, the matching DNS cache entry will be overwritten with the supplied parameter. If FALSE, EFI_ACCESS_DENIED will be returned if the entry to be added is already exists. |
[in] | DnsCacheEntry | Pointer to DNS Cache entry. |
EFI_SUCCESS | The operation completed successfully. | |
EFI_INVALID_PARAMETER | This is NULL. DnsCacheEntry.HostName is NULL. DnsCacheEntry.IpAddress is NULL. DnsCacheEntry.Timeout is zero. | |
EFI_ACCESS_DENIED | The DNS cache entry already exists and Override is not TRUE. |
References _DNS_DRIVER_DATA::Dns6CacheList, mDriverData, and UpdateDns6Cache().
EFI_DNS4_PROTOCOL mDns4Protocol |
Initial value:
{ Dns4GetModeData, Dns4Configure, Dns4HostNameToIp, Dns4IpToHostName, Dns4GeneralLookUp, Dns4UpdateDnsCache, Dns4Poll, Dns4Cancel }
Referenced by DnsCreateInstance().
EFI_DNS6_PROTOCOL mDns6Protocol |
Initial value:
{ Dns6GetModeData, Dns6Configure, Dns6HostNameToIp, Dns6IpToHostName, Dns6GeneralLookUp, Dns6UpdateDnsCache, Dns6Poll, Dns6Cancel }
Referenced by DnsCreateInstance().