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

   1 '\" te
   2 .\"  Copyright 1989 AT&T
   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 DUPMSG 9F "Apr 11, 1991"
   7 .SH NAME
   8 dupmsg \- duplicate a message
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/stream.h>
  13
  14
  15
  16 \fBmblk_t *\fR\fBdupmsg\fR(\fBmblk_t *\fR\fImp\fR);
  17 .fi
  18
  19 .SH INTERFACE LEVEL
  20 .sp
  21 .LP
  22 Architecture independent level 1 (DDI/DKI).
  23 .SH PARAMETERS
  24 .sp
  25 .ne 2
  26 .na
  27 \fB\fImp\fR \fR
  28 .ad
  29 .RS 7n
  30 Pointer to the message.
  31 .RE
  32
  33 .SH DESCRIPTION
  34 .sp
  35 .LP
  36 \fBdupmsg()\fR forms a new message by copying the message block descriptors
  37 pointed to by  \fImp\fR and linking them. \fBdupb\fR(9F) is called for each
  38 message block. The data blocks themselves are not duplicated.
  39 .SH RETURN VALUES
  40 .sp
  41 .LP
  42 If successful,  \fBdupmsg()\fR returns a pointer to the new message block.
  43 Otherwise, it returns a  \fINULL\fR pointer. A return value of  \fINULL\fR
  44 indicates either memory depletion or the data block reference count,
  45 \fBdb_ref\fR (see \fBdatab\fR(9S)), has reached a limit  (\fB255\fR). See
  46 \fBdupb\fR(9F).
  47 .SH CONTEXT
  48 .sp
  49 .LP
  50 \fBdupmsg()\fR can be called from user, kernel, or interrupt context.
  51 .SH EXAMPLES
  52 .LP
  53 \fBExample 1 \fRUsing \fBdupmsg()\fR
  54 .sp
  55 .LP
  56 See \fBcopyb\fR(9F) for an example using \fBdupmsg()\fR.
  57
  58 .SH SEE ALSO
  59 .sp
  60 .LP
  61 \fBcopyb\fR(9F), \fBcopymsg\fR(9F), \fBdupb\fR(9F), \fBdatab\fR(9S)
  62 .sp
  63 .LP
  64 \fIWriting Device Drivers\fR
  65 .sp
  66 .LP
  67 \fISTREAMS Programming Guide\fR