usr/src/man/man9f/copymsg.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 COPYMSG 9F "Jan 16, 2006"
   8 .SH NAME
   9 copymsg \- copy a message
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/stream.h>
  14
  15
  16
  17 \fBmblk_t *\fR\fBcopymsg\fR(\fBmblk_t *\fR\fImp\fR);
  18 .fi
  19
  20 .SH INTERFACE LEVEL
  21 .sp
  22 .LP
  23 Architecture independent level 1 (DDI/DKI).
  24 .SH PARAMETERS
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fImp\fR\fR
  29 .ad
  30 .RS 6n
  31 Pointer to the message to be copied.
  32 .RE
  33
  34 .SH DESCRIPTION
  35 .sp
  36 .LP
  37 The \fBcopymsg()\fR function forms a new message by allocating new message
  38 blocks, and copying the contents of the message referred to by \fImp\fR (using
  39 the \fBcopyb\fR(9F) function). It returns a pointer to the new message.
  40 .SH RETURN VALUES
  41 .sp
  42 .LP
  43 If the copy is successful, \fBcopymsg()\fR returns a pointer to the new
  44 message. Otherwise, it returns a \fINULL\fR pointer.
  45 .SH CONTEXT
  46 .sp
  47 .LP
  48 The \fBcopymsg()\fR function can be called from user, interrupt, or kernel
  49 context.
  50 .SH EXAMPLES
  51 .LP
  52 \fBExample 1 \fR: Using copymsg
  53 .sp
  54 .LP
  55 The routine \fBlctouc()\fR converts all the lowercase \fBASCII \fRcharacters in
  56 the message to uppercase. If the reference count is greater than one (line 8),
  57 then the message is shared, and must be copied before changing the contents of
  58 the data buffer. If the call to the \fBcopymsg()\fR function fails (line 9),
  59 return \fINULL\fR (line 10), otherwise, free the original message (line 11). If
  60 the reference count was equal to \fB1\fR, the message can be modified. For each
  61 character (line 16) in each message block (line 15), if it is a lowercase
  62 letter, convert it to an uppercase letter (line 18). A pointer to the converted
  63 message is returned (line 21).
  64
  65 .sp
  66 .in +2
  67 .nf
  68
  69  1 mblk_t *lctouc(mp)
  70  2    mblk_t *mp;
  71  3 {
  72  4    mblk_t *cmp;
  73  5    mblk_t *tmp;
  74  6    unsigned char *cp;
  75  7
  76  8    if (mp->b_datap->db_ref > 1) {
  77  9            if ((cmp = copymsg(mp)) == NULL)
  78 10                     return (NULL);
  79 11            freemsg(mp);
  80 12    } else {
  81 13            cmp = mp;
  82 14    }
  83 15    for (tmp = cmp; tmp; tmp = tmp->b_cont) {
  84 16            for (cp = tmp->b_rptr; cp < tmp->b_wptr; cp++) {
  85 17                    if ((*cp <= 'z') && (*cp >= 'a'))
  86 18                             *cp -= 0x20;
  87 19            }
  88 20    }
  89 21    return(cmp);
  90 22 }
  91 .fi
  92 .in -2
  93
  94 .SH SEE ALSO
  95 .sp
  96 .LP
  97 \fBallocb\fR(9F), \fBcopyb\fR(9F), \fBmsgb\fR(9S)
  98 .sp
  99 .LP
 100 \fIWriting Device Drivers\fR
 101 .sp
 102 .LP
 103 \fISTREAMS Programming Guide\fR