lib/libares/ares_send.3

   1 .\" $Id: ares_send.3,v 1.1 1998/08/13 18:07:35 ghudson Exp $
   2 .\"
   3 .\" Copyright 1998 by the Massachusetts Institute of Technology.
   4 .\"
   5 .\" Permission to use, copy, modify, and distribute this
   6 .\" software and its documentation for any purpose and without
   7 .\" fee is hereby granted, provided that the above copyright
   8 .\" notice appear in all copies and that both that copyright
   9 .\" notice and this permission notice appear in supporting
  10 .\" documentation, and that the name of M.I.T. not be used in
  11 .\" advertising or publicity pertaining to distribution of the
  12 .\" software without specific, written prior permission.
  13 .\" M.I.T. makes no representations about the suitability of
  14 .\" this software for any purpose.  It is provided "as is"
  15 .\" without express or implied warranty.
  16 .\"
  17 .TH ARES_SEND 3 "25 July 1998"
  18 .SH NAME
  19 ares_send \- Initiate a DNS query
  20 .SH SYNOPSIS
  21 .nf
  22 .B #include <ares.h>
  23 .PP
  24 .B typedef void (*ares_callback)(void *\fIarg\fP, int \fIstatus\fP,
  25 .B      unsigned char *\fIabuf\fP, int \fIalen\fP)
  26 .PP
  27 .B
  28 void ares_send(ares_channel \fIchannel\fP, const unsigned char *\fIqbuf\fP,
  29 .B      int \fIqlen\fP, ares_callback \fIcallback\fP, void *\fIarg\fP)
  30 .fi
  31 .SH DESCRIPTION
  32 The
  33 .B ares_send
  34 function initiates a DNS query on the name service channel identified
  35 by
  36 .IR channel .
  37 The parameters
  38 .I qbuf
  39 and
  40 .I qlen
  41 give the DNS query, which should already have been formatted according
  42 to the DNS protocol.  When the query is complete or has failed, the
  43 ares library will invoke
  44 .IR callback .
  45 Completion or failure of the query may happen immediately, or may
  46 happen during a later call to
  47 .BR ares_process (3)
  48 or
  49 .BR ares_destroy (3).
  50 .PP
  51 The callback argument
  52 .I arg
  53 is copied from the
  54 .B ares_send
  55 argument
  56 .IR arg .
  57 The callback argument
  58 .I status
  59 indicates whether the query succeeded and, if not, how it failed.  It
  60 may have any of the following values:
  61 .TP 19
  62 .B ARES_SUCCESS
  63 The query completed.
  64 .TP 19
  65 .B ARES_EBADQUERY
  66 The query buffer was poorly formed (was not long enough for a DNS
  67 header or was too long for TCP transmission).
  68 .TP 19
  69 .B ARES_ETIMEOUT
  70 No name servers responded within the timeout period.
  71 .TP 19
  72 .B ARES_ECONNREFUSED
  73 No name servers could be contacted.
  74 .TP 19
  75 .B ARES_ENOMEM
  76 Memory was exhausted.
  77 .TP 19
  78 .B ARES_EDESTRUCTION
  79 The name service channel
  80 .I channel
  81 is being destroyed; the query will not be completed.
  82 .PP
  83 If the query completed, the callback argument
  84 .I abuf
  85 points to a result buffer of length
  86 .IR alen .
  87 If the query did not complete,
  88 .I abuf
  89 will be NULL and
  90 .I alen
  91 will be 0.
  92 .PP
  93 Unless the flag
  94 .B ARES_FLAG_NOCHECKRESP
  95 was set at channel initialization time,
  96 .B ares_send
  97 will normally ignore responses whose questions do not match the
  98 questions in
  99 .IR qbuf ,
 100 as well as responses with reply codes of
 101 .BR SERVFAIL ,
 102 .BR NOTIMP ,
 103 and
 104 .BR REFUSED .
 105 Unlike other query functions in the ares library, however,
 106 .B ares_send
 107 does not inspect the header of the reply packet to determine the error
 108 status, so a callback status of
 109 .B ARES_SUCCESS
 110 does not reflect as much about the response as for other query
 111 functions.
 112 .SH SEE ALSO
 113 .BR ares_process (3)
 114 .SH AUTHOR
 115 Greg Hudson, MIT Information Systems
 116 .br
 117 Copyright 1998 by the Massachusetts Institute of Technology.