share/man/man3dns_sd/DNSServiceRefSockFD.3dns_sd

   1 '\" te
   2 .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH DNSSERVICEREFSOCKFD 3DNS_SD "Aug 20, 2007"
   7 .SH NAME
   8 DNSServiceRefSockFD \- access underlying UNIX domain socket descriptor
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-ldns_sd\fR [ \fIlibrary\fR ... ]
  13 #include <dns_sd.h>
  14
  15 \fBDNSServiceRefSockFD\fR(\fBDNSServiceRef\fR *\fIsdRef\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 Access the underlying UNIX\u\s-2TM\s+2\d domain socket from the initialized
  22 \fBDNSServiceRef\fR returned from \fBDNS\fR Service calls. Applications should
  23 only access the underlying UNIX domain socket to poll for results from the
  24 \fBmDNS\fR daemon. Applications should not directly read or write to the
  25 socket. When results are available, applications should call
  26 \fBDNSServiceProcessResult()\fR. The application is responsible for processing
  27 the data on the socket in a timely fashion. The daemon can terminate its
  28 connection with a client that does not clear its socket buffer.
  29 .SH RETURN VALUES
  30 .sp
  31 .LP
  32 The underlying UNIX domain socket descriptor of the \fBDNSServiceRef\fR or
  33 \fB-1\fR is returned in case of error.
  34 .SH ATTRIBUTES
  35 .sp
  36 .LP
  37 See \fBattributes\fR(5) for description of the following attributes:
  38 .sp
  39
  40 .sp
  41 .TS
  42 box;
  43 c | c
  44 l | l .
  45 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  46 _
  47 Interface Stability     Committed
  48 _
  49 MT-Level        Safe
  50 .TE
  51
  52 .SH SEE ALSO
  53 .sp
  54 .LP
  55 \fBDNSServiceBrowse\fR(3DNS_SD), \fBDNSServiceRegister\fR(3DNS_SD),
  56 \fBattributes\fR(5)