share/man/man9f/RD.9f

   1 '\" te
   2 .\"  Copyright 1989 AT&T
   3 .\"  Copyright (c) 2006, Sun Microsystems, Inc.  All Rights Reserved
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH RD 9F "Jan 16, 2006"
   8 .SH NAME
   9 RD, rd \- get pointer to the read queue
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/stream.h>
  14 #include <sys/ddi.h>
  15
  16
  17
  18 \fBqueue_t *\fR\fBRD\fR(\fBqueue_t *\fR\fIq\fR);
  19 .fi
  20
  21 .SH INTERFACE LEVEL
  22 .sp
  23 .LP
  24 Architecture independent level 1 (\fBDDI/DKI)\fR.
  25 .SH PARAMETERS
  26 .sp
  27 .ne 2
  28 .na
  29 \fB\fIq\fR\fR
  30 .ad
  31 .RS 5n
  32 Pointer to the \fBwrite\fR queue whose \fBread\fR queue is to be returned.
  33 .RE
  34
  35 .SH DESCRIPTION
  36 .sp
  37 .LP
  38 The \fBRD()\fR function accepts a \fBwrite\fR queue pointer as an argument and
  39 returns a pointer to the \fBread\fR queue of the same module.
  40 .sp
  41 .LP
  42 \fBCAUTION:\fR Make sure the argument to this function is a pointer to a
  43 \fBwrite\fR queue. \fBRD()\fR will not check for queue type, and a system panic
  44 could result if it is not the right type.
  45 .SH RETURN VALUES
  46 .sp
  47 .LP
  48 The pointer to the \fBread\fR queue.
  49 .SH CONTEXT
  50 .sp
  51 .LP
  52 The \fBRD()\fR function can be called from user, interrupt, or kernel context.
  53 .SH EXAMPLES
  54 .LP
  55 \fBExample 1 \fRFunction page reference
  56 .sp
  57 .LP
  58 See the \fBqreply\fR(9F) function page for an example of \fBRD()\fR.
  59
  60 .SH SEE ALSO
  61 .sp
  62 .LP
  63 \fBqreply\fR(9F), \fBWR\fR(9F)
  64 .sp
  65 .LP
  66 \fIWriting Device Drivers\fR
  67 .sp
  68 .LP
  69 \fISTREAMS Programming Guide\fR