usr/src/man/man9f/datamsg.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 DATAMSG 9F "Jan 16, 2006"
   8 .SH NAME
   9 datamsg \- test whether a message is a data message
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/stream.h>
  14 #include <sys/ddi.h>
  15
  16
  17
  18 \fBint\fR \fBdatamsg\fR(\fBunsigned char\fR \fItype\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\fItype\fR\fR
  30 .ad
  31 .RS 8n
  32 The type of message to be tested. The \fBdb_type\fR field of the
  33 \fBdatab\fR(9S) structure contains the message type. This field may be accessed
  34 through the message block using \fBmp->b_datap->db_type\fR.
  35 .RE
  36
  37 .SH DESCRIPTION
  38 .sp
  39 .LP
  40 The \fBdatamsg()\fR function tests the type of message to determine if it is a
  41 data message type (\fBM_DATA\fR, \fBM_DELAY\fR, \fBM_PROTO\fR , or
  42 \fBM_PCPROTO\fR).
  43 .SH RETURN VALUES
  44 .sp
  45 .LP
  46 \fBdatamsg\fR returns
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fB1\fR\fR
  51 .ad
  52 .RS 5n
  53 if the message is a data message
  54 .RE
  55
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fB0\fR\fR
  60 .ad
  61 .RS 5n
  62 otherwise.
  63 .RE
  64
  65 .SH CONTEXT
  66 .sp
  67 .LP
  68 The \fBdatamsg()\fR function can be called from user, interrupt, or kernel
  69 context.
  70 .SH EXAMPLES
  71 .sp
  72 .LP
  73 The \fBput\fR(9E) routine enqueues all data messages for handling by the
  74 \fBsrv\fR(9E) (service) routine. All non-data messages are handled in the
  75 \fBput\fR(9E) routine.
  76 .sp
  77 .in +2
  78 .nf
  79 1 \fIxxx\fRput(q, mp)
  80 2      queue_t *q;
  81 3      mblk_t *mp;
  82 4 {
  83 5    if (datamsg(mp->b_datap->db_type)) {
  84 6            putq(q, mp);
  85 7            return;
  86 8    }
  87 9    switch (mp->b_datap->db_type) {
  88 10    case M_FLUSH:
  89                        \&.\|.\|.
  90 11    }
  91 12 }
  92 .fi
  93 .in -2
  94
  95 .SH SEE ALSO
  96 .sp
  97 .LP
  98 \fBput\fR(9E), \fBsrv\fR(9E), \fBallocb\fR(9F), \fBdatab\fR(9S), \fBmsgb\fR(9S)
  99 .sp
 100 .LP
 101 \fIWriting Device Drivers\fR
 102 .sp
 103 .LP
 104 \fISTREAMS Programming Guide\fR