Blame lib/lwres/man/lwres_getipnode.html

Packit Service ae04f2
Packit Service ae04f2
Packit Service ae04f2
 - Copyright (C) 2000, 2001, 2003-2005, 2007, 2014-2016, 2018-2020 Internet Systems Consortium, Inc. ("ISC")
Packit Service ae04f2
 - 
Packit Service ae04f2
 - This Source Code Form is subject to the terms of the Mozilla Public
Packit Service ae04f2
 - License, v. 2.0. If a copy of the MPL was not distributed with this
Packit Service ae04f2
 - file, You can obtain one at http://mozilla.org/MPL/2.0/.
Packit Service ae04f2
-->
Packit Service ae04f2
<html lang="en">
Packit Service ae04f2
<head>
Packit Service ae04f2
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
Packit Service ae04f2
<title>lwres_getipnode</title>
Packit Service ae04f2
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
Packit Service ae04f2
</head>
Packit Service ae04f2
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit Service ae04f2
Packit Service ae04f2
  
Packit Service ae04f2
  
Packit Service ae04f2
Packit Service ae04f2
  
Packit Service ae04f2
Packit Service ae04f2
  
Packit Service ae04f2
Packit Service ae04f2
  
Packit Service ae04f2

Name

Packit Service ae04f2

Packit Service ae04f2
    lwres_getipnodebyname, 
Packit Service ae04f2
    lwres_getipnodebyaddr, 
Packit Service ae04f2
    lwres_freehostent
Packit Service ae04f2
     — lightweight resolver nodename / address translation API
Packit Service ae04f2
  

Packit Service ae04f2
Packit Service ae04f2
  
Packit Service ae04f2

Synopsis

Packit Service ae04f2
    
Packit Service ae04f2
#include <lwres/netdb.h>
Packit Service ae04f2
Packit Service ae04f2
Packit Service ae04f2
Packit Service ae04f2
struct hostent *
Packit Service ae04f2
lwres_getipnodebyname(
Packit Service ae04f2
const char *name, 
Packit Service ae04f2
Packit Service ae04f2
Packit Service ae04f2
 
Packit Service ae04f2
int af, 
Packit Service ae04f2
Packit Service ae04f2
Packit Service ae04f2
 
Packit Service ae04f2
int flags, 
Packit Service ae04f2
Packit Service ae04f2
Packit Service ae04f2
 
Packit Service ae04f2
int *error_num);
Packit Service ae04f2
Packit Service ae04f2
Packit Service ae04f2
 
Packit Service ae04f2
Packit Service ae04f2
Packit Service ae04f2
Packit Service ae04f2
struct hostent *
Packit Service ae04f2
lwres_getipnodebyaddr(
Packit Service ae04f2
const void *src, 
Packit Service ae04f2
Packit Service ae04f2
Packit Service ae04f2
 
Packit Service ae04f2
size_t len, 
Packit Service ae04f2
Packit Service ae04f2
Packit Service ae04f2
 
Packit Service ae04f2
int af, 
Packit Service ae04f2
Packit Service ae04f2
Packit Service ae04f2
 
Packit Service ae04f2
int *error_num);
Packit Service ae04f2
Packit Service ae04f2
Packit Service ae04f2
 
Packit Service ae04f2
Packit Service ae04f2
Packit Service ae04f2
void
Packit Service ae04f2
lwres_freehostent(
Packit Service ae04f2
struct hostent *he);
Packit Service ae04f2
Packit Service ae04f2
 
Packit Service ae04f2
Packit Service ae04f2
  
Packit Service ae04f2
Packit Service ae04f2
  
Packit Service ae04f2

DESCRIPTION

Packit Service ae04f2
Packit Service ae04f2
Packit Service ae04f2
    

Packit Service ae04f2
      These functions perform thread safe, protocol independent
Packit Service ae04f2
      nodename-to-address and address-to-nodename
Packit Service ae04f2
      translation as defined in RFC2553.
Packit Service ae04f2
    

Packit Service ae04f2
Packit Service ae04f2
    

Packit Service ae04f2
      They use a
Packit Service ae04f2
      struct hostent
Packit Service ae04f2
      which is defined in
Packit Service ae04f2
      namedb.h:
Packit Service ae04f2
    

Packit Service ae04f2
    
Packit Service ae04f2
struct  hostent {
Packit Service ae04f2
        char    *h_name;        /* official name of host */
Packit Service ae04f2
        char    **h_aliases;    /* alias list */
Packit Service ae04f2
        int     h_addrtype;     /* host address type */
Packit Service ae04f2
        int     h_length;       /* length of address */
Packit Service ae04f2
        char    **h_addr_list;  /* list of addresses from name server */
Packit Service ae04f2
};
Packit Service ae04f2
#define h_addr  h_addr_list[0]  /* address, for backward compatibility */
Packit Service ae04f2
Packit Service ae04f2

Packit Service ae04f2
    

Packit Service ae04f2
Packit Service ae04f2
    

Packit Service ae04f2
      The members of this structure are:
Packit Service ae04f2
      

Packit Service ae04f2
Packit Service ae04f2
h_name
Packit Service ae04f2
Packit Service ae04f2
            

Packit Service ae04f2
              The official (canonical) name of the host.
Packit Service ae04f2
            

Packit Service ae04f2
          
Packit Service ae04f2
h_aliases
Packit Service ae04f2
Packit Service ae04f2
            

Packit Service ae04f2
              A NULL-terminated array of alternate names (nicknames) for the
Packit Service ae04f2
              host.
Packit Service ae04f2
            

Packit Service ae04f2
          
Packit Service ae04f2
h_addrtype
Packit Service ae04f2
Packit Service ae04f2
            

Packit Service ae04f2
              The type of address being returned - usually
Packit Service ae04f2
              PF_INET
Packit Service ae04f2
              or
Packit Service ae04f2
              PF_INET6.
Packit Service ae04f2
Packit Service ae04f2
            

Packit Service ae04f2
          
Packit Service ae04f2
h_length
Packit Service ae04f2
Packit Service ae04f2
            

Packit Service ae04f2
              The length of the address in bytes.
Packit Service ae04f2
            

Packit Service ae04f2
          
Packit Service ae04f2
h_addr_list
Packit Service ae04f2
Packit Service ae04f2
            

Packit Service ae04f2
              A
Packit Service ae04f2
              NULL
Packit Service ae04f2
              terminated array of network addresses for the host.
Packit Service ae04f2
              Host addresses are returned in network byte order.
Packit Service ae04f2
            

Packit Service ae04f2
          
Packit Service ae04f2
Packit Service ae04f2

Packit Service ae04f2
    

Packit Service ae04f2
Packit Service ae04f2
    

lwres_getipnodebyname()

Packit Service ae04f2
      looks up addresses of protocol family af
Packit Service ae04f2
      for the hostname name.  The
Packit Service ae04f2
      flags parameter contains ORed flag bits
Packit Service ae04f2
      to specify the types of addresses that are searched for, and the
Packit Service ae04f2
      types of addresses that are returned.  The flag bits are:
Packit Service ae04f2
Packit Service ae04f2
      

Packit Service ae04f2
Packit Service ae04f2
AI_V4MAPPED
Packit Service ae04f2
Packit Service ae04f2
            

Packit Service ae04f2
              This is used with an
Packit Service ae04f2
              af
Packit Service ae04f2
              of AF_INET6, and causes IPv4 addresses to be returned as
Packit Service ae04f2
              IPv4-mapped
Packit Service ae04f2
              IPv6 addresses.
Packit Service ae04f2
            

Packit Service ae04f2
          
Packit Service ae04f2
AI_ALL
Packit Service ae04f2
Packit Service ae04f2
            

Packit Service ae04f2
              This is used with an
Packit Service ae04f2
              af
Packit Service ae04f2
              of AF_INET6, and causes all known addresses (IPv6 and IPv4) to
Packit Service ae04f2
              be returned.
Packit Service ae04f2
              If AI_V4MAPPED is also set, the IPv4 addresses are return as
Packit Service ae04f2
              mapped
Packit Service ae04f2
              IPv6 addresses.
Packit Service ae04f2
            

Packit Service ae04f2
          
Packit Service ae04f2
AI_ADDRCONFIG
Packit Service ae04f2
Packit Service ae04f2
            

Packit Service ae04f2
              Only return an IPv6 or IPv4 address if here is an active network
Packit Service ae04f2
              interface of that type.  This is not currently implemented
Packit Service ae04f2
              in the BIND 9 lightweight resolver, and the flag is ignored.
Packit Service ae04f2
            

Packit Service ae04f2
          
Packit Service ae04f2
AI_DEFAULT
Packit Service ae04f2
Packit Service ae04f2
            

Packit Service ae04f2
              This default sets the
Packit Service ae04f2
              AI_V4MAPPED
Packit Service ae04f2
              and
Packit Service ae04f2
              AI_ADDRCONFIG
Packit Service ae04f2
              flag bits.
Packit Service ae04f2
            

Packit Service ae04f2
          
Packit Service ae04f2
Packit Service ae04f2

Packit Service ae04f2
    

Packit Service ae04f2
Packit Service ae04f2
    

lwres_getipnodebyaddr()

Packit Service ae04f2
      performs a reverse lookup of address src
Packit Service ae04f2
      which is len bytes long.
Packit Service ae04f2
      af denotes the protocol family, typically
Packit Service ae04f2
      PF_INET or PF_INET6.
Packit Service ae04f2
    

Packit Service ae04f2
    

lwres_freehostent()

Packit Service ae04f2
      releases all the memory associated with the struct
Packit Service ae04f2
      hostent pointer he.  Any memory
Packit Service ae04f2
      allocated for the h_name,
Packit Service ae04f2
      h_addr_list and
Packit Service ae04f2
      h_aliases is freed, as is the memory for
Packit Service ae04f2
      the hostent structure itself.
Packit Service ae04f2
    

Packit Service ae04f2
  
Packit Service ae04f2
  
Packit Service ae04f2

RETURN VALUES

Packit Service ae04f2
Packit Service ae04f2
    

Packit Service ae04f2
      If an error occurs,
Packit Service ae04f2
      lwres_getipnodebyname()
Packit Service ae04f2
      and
Packit Service ae04f2
      lwres_getipnodebyaddr()
Packit Service ae04f2
      set
Packit Service ae04f2
      *error_num
Packit Service ae04f2
      to an appropriate error code and the function returns a
Packit Service ae04f2
      NULL
Packit Service ae04f2
      pointer.
Packit Service ae04f2
      The error codes and their meanings are defined in
Packit Service ae04f2
      <lwres/netdb.h>:
Packit Service ae04f2
      

Packit Service ae04f2
Packit Service ae04f2
HOST_NOT_FOUND
Packit Service ae04f2
Packit Service ae04f2
            

Packit Service ae04f2
              No such host is known.
Packit Service ae04f2
            

Packit Service ae04f2
          
Packit Service ae04f2
NO_ADDRESS
Packit Service ae04f2
Packit Service ae04f2
            

Packit Service ae04f2
              The server recognised the request and the name but no address is
Packit Service ae04f2
              available.  Another type of request to the name server for the
Packit Service ae04f2
              domain might return an answer.
Packit Service ae04f2
            

Packit Service ae04f2
          
Packit Service ae04f2
TRY_AGAIN
Packit Service ae04f2
Packit Service ae04f2
            

Packit Service ae04f2
              A temporary and possibly transient error occurred, such as a
Packit Service ae04f2
              failure of a server to respond.  The request may succeed if
Packit Service ae04f2
              retried.
Packit Service ae04f2
            

Packit Service ae04f2
          
Packit Service ae04f2
NO_RECOVERY
Packit Service ae04f2
Packit Service ae04f2
            

Packit Service ae04f2
              An unexpected failure occurred, and retrying the request
Packit Service ae04f2
              is pointless.
Packit Service ae04f2
            

Packit Service ae04f2
          
Packit Service ae04f2
Packit Service ae04f2

Packit Service ae04f2
    

Packit Service ae04f2
    

Packit Service ae04f2
        lwres_hstrerror(3)
Packit Service ae04f2
      
Packit Service ae04f2
      translates these error codes to suitable error messages.
Packit Service ae04f2
    

Packit Service ae04f2
  
Packit Service ae04f2
  
Packit Service ae04f2

SEE ALSO

Packit Service ae04f2
Packit Service ae04f2
    

Packit Service ae04f2
        RFC2553
Packit Service ae04f2
      ,
Packit Service ae04f2
Packit Service ae04f2
      
Packit Service ae04f2
        lwres(3)
Packit Service ae04f2
      ,
Packit Service ae04f2
Packit Service ae04f2
      
Packit Service ae04f2
        lwres_gethostent(3)
Packit Service ae04f2
      ,
Packit Service ae04f2
Packit Service ae04f2
      
Packit Service ae04f2
        lwres_getaddrinfo(3)
Packit Service ae04f2
      ,
Packit Service ae04f2
Packit Service ae04f2
      
Packit Service ae04f2
        lwres_getnameinfo(3)
Packit Service ae04f2
      ,
Packit Service ae04f2
Packit Service ae04f2
      
Packit Service ae04f2
        lwres_hstrerror(3)
Packit Service ae04f2
      .
Packit Service ae04f2
    

Packit Service ae04f2
  
Packit Service ae04f2
</body>
Packit Service ae04f2
</html>