share/man/man9f/miocack.9f

   1 '\" te
   2 .\" Copyright (c) 2004, 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 MIOCACK 9F "Jun 9, 2004"
   7 .SH NAME
   8 miocack \- Positively acknowledge an M_IOCTL message
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/stream.h>
  13 #include <sys/strsun.h>
  14
  15
  16
  17 \fBvoid\fR \fBmiocack\fR(\fBqueue_t *\fR\fIwq\fR, \fBmblk_t *\fR\fImp\fR, \fBint\fR\fIcount\fR, \fBint\fR \fIrval\fR);
  18 .fi
  19
  20 .SH INTERFACE LEVEL
  21 .sp
  22 .LP
  23 Solaris DDI specific (Solaris DDI).
  24 .SH PARAMETERS
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fIwq\fR\fR
  29 .ad
  30 .RS 9n
  31 Write queue associated with the read queue to send the M_IOCACK on.
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fImp\fR\fR
  38 .ad
  39 .RS 9n
  40 M_IOCTL message.
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fIcount\fR\fR
  47 .ad
  48 .RS 9n
  49 Value to set the ioc_count of the \fBiocblk\fR(9S) to.
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fIrval\fR\fR
  56 .ad
  57 .RS 9n
  58 Value to set the ioc_rval of the \fBiocblk\fR(9S) to.
  59 .RE
  60
  61 .SH DESCRIPTION
  62 .sp
  63 .LP
  64 The \fBmiocack()\fR function converts an M_IOCTL message into a M_IOCACK
  65 message and sends the resulting message upstream.
  66 .sp
  67 .LP
  68 To convert the message, \fBmiocack()\fR changes the message type to M_IOCACK,
  69 sets the 'ioc_count' and 'ioc_rval' members of the \fBiocblk\fR(9S) associated
  70 with \fImp\fR to the passed-in values, and clears the 'ioc_error' field. If the
  71 caller specifies a non-zero value for count, it is expected that the caller has
  72 already set 'mp->b_cont' field to point to a message block with a length of at
  73 least \fIcount\fR bytes.
  74 .sp
  75 .LP
  76 Callers that only need to perform the message conversion, or need to perform
  77 additional steps between the conversion and the      sending of the M_IOCACK
  78 should use \fBmioc2ack\fR(9F).
  79 .SH RETURN VALUES
  80 .sp
  81 .LP
  82 None.
  83 .SH CONTEXT
  84 .sp
  85 .LP
  86 This function can be called from user, kernel or interrupt context.
  87 .SH NOTES
  88 .sp
  89 .LP
  90 Callers must not hold any locks across a \fBmiocack()\fR that can be acquired
  91 as part of \fBput\fR(9E) processing.
  92 .SH SEE ALSO
  93 .sp
  94 .LP
  95 \fBmioc2ack\fR(9F), \fBput\fR(9E), \fBiocblk\fR(9S)
  96 .sp
  97 .LP
  98 \fISTREAMS Programming Guide\fR