crypto/heimdal/lib/krb5/krb5_get_all_client_addrs.3

   1 .\" $Id: krb5_get_all_client_addrs.3,v 1.4 2002/08/28 15:30:52 joda Exp $
   2 .Dd July  1, 2001
   3 .Dt KRB5_GET_ADDRS 3
   4 .Sh NAME
   5 .Nm krb5_get_all_client_addrs ,
   6 .Nm krb5_get_all_server_addrs
   7 .Nd return local addresses
   8 .Sh LIBRARY
   9 Kerberos 5 Library (libkrb5, -lkrb5)
  10 .Sh SYNOPSIS
  11 .Fd #include <krb5.h>
  12 .Ft "krb5_error_code"
  13 .Fn krb5_get_all_client_addrs "krb5_context context" "krb5_addresses *addrs"
  14 .Ft "krb5_error_code"
  15 .Fn krb5_get_all_server_addrs "krb5_context context" "krb5_addresses *addrs"
  16 .Sh DESCRIPTION
  17 These functions return in
  18 .Fa addrs
  19 a list of addresses associated with the local
  20 host.
  21 .Pp
  22 The server variant returns all configured interface addresses (if
  23 possible), including loop-back addresses. This is useful if you want
  24 to create sockets to listen to.
  25 .Pp
  26 The client version will also scan local interfaces (can be turned off
  27 by setting
  28 .Li libdefaults/scan_interfaces
  29 to false in
  30 .Pa krb5.conf ) ,
  31 but will not include loop-back addresses, unless there are no other
  32 addresses found. It will remove all addresses included in
  33 .Li libdefaults/ignore_addresses
  34 but will unconditionally include addresses in
  35 .Li libdefaults/extra_addresses .
  36 .Pp
  37 The returned addresses should be freed by calling
  38 .Fn krb5_free_addresses .
  39 .\".Sh EXAMPLE
  40 .Sh SEE ALSO
  41 .Xr krb5_free_addresses 3