usr/src/man/man9f/putnext.9f

   1 '\" te
   2 .\" Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" Copyright 1989 AT&T
   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 PUTNEXT 9F "Jan 16, 2006"
   8 .SH NAME
   9 putnext \- send a message to the next queue
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/stream.h>
  14 #include <sys/ddi.h>
  15
  16
  17
  18 \fBvoid\fR \fBputnext\fR(\fBqueue_t *\fR\fIq\fR, \fBmblk_t *\fR\fImp\fR);
  19 .fi
  20
  21 .SH INTERFACE LEVEL
  22 .sp
  23 .LP
  24 Architecture independent level 1 (DDI/DKI).
  25 .SH PARAMETERS
  26 .sp
  27 .ne 2
  28 .na
  29 \fB\fIq\fR\fR
  30 .ad
  31 .RS 6n
  32 Pointer to the queue from which the message \fImp\fR will be sent.
  33 .RE
  34
  35 .sp
  36 .ne 2
  37 .na
  38 \fB\fImp\fR\fR
  39 .ad
  40 .RS 6n
  41 Message to be passed.
  42 .RE
  43
  44 .SH DESCRIPTION
  45 .sp
  46 .LP
  47 The \fBputnext()\fR function is used to pass a message to the \fBput\fR(9E)
  48 routine of the next queue in the stream.
  49 .SH RETURN VALUES
  50 .sp
  51 .LP
  52 None.
  53 .SH CONTEXT
  54 .sp
  55 .LP
  56 The \fBputnext()\fR function can be called from user, interrupt, or kernel
  57 context.
  58 .SH EXAMPLES
  59 .sp
  60 .LP
  61 See \fBallocb\fR(9F) for an example of using \fBputnext()\fR.
  62 .SH SEE ALSO
  63 .sp
  64 .LP
  65 \fBput\fR(9E), \fBallocb\fR(9F), \fBput\fR(9F), \fBqprocson\fR(9F)
  66 .sp
  67 .LP
  68 \fIWriting Device Drivers\fR
  69 .sp
  70 .LP
  71 \fISTREAMS Programming Guide\fR
  72 .SH NOTES
  73 .sp
  74 .LP
  75 The \fBput()\fR and \fBputnext()\fR functions should be called only after
  76 \fBqprocson()\fR is finished.