usr/src/man/man9s/datab.9s

   1 '\" te
   2 .\" Copyright (c) 2003 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 DATAB 9S "Oct 24, 2003"
   8 .SH NAME
   9 datab, dblk \- STREAMS message data structure
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/stream.h>
  14 .fi
  15
  16 .SH INTERFACE LEVEL
  17 .sp
  18 .LP
  19 Architecture independent level 1 (DDI/DKI).
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 The \fBdatab\fR structure describes the data of a STREAMS message. The actual
  24 data contained in a STREAMS message is stored in a data buffer pointed to by
  25 this structure. A  \fBmsgb\fR (message block) structure includes a field that
  26 points to a \fBdatab\fR structure.
  27 .sp
  28 .LP
  29 Because a data block can have more than one message block pointing to it at one
  30 time, the \fBdb_ref\fR member keeps track of a data block's references,
  31 preventing it from being deallocated until all message blocks are finished with
  32 it.
  33 .SH STRUCTURE MEMBERS
  34 .sp
  35 .in +2
  36 .nf
  37 unsigned char     *db_base;     /* first byte of buffer */
  38 unsigned char     *db_lim;      /* last byte (+1) of buffer */
  39 unsigned char      db_ref;      /* # of message pointers to this data */
  40 unsigned char      db_type;     /* message type */
  41 .fi
  42 .in -2
  43
  44 .sp
  45 .LP
  46 A \fBdatab\fR structure is defined as type \fBdblk_t\fR.
  47 .SH SEE ALSO
  48 .sp
  49 .LP
  50 \fBfree_rtn\fR(9S), \fBmsgb\fR(9S)
  51 .sp
  52 .LP
  53 \fIWriting Device Drivers\fR
  54 .sp
  55 .LP
  56 \fISTREAMS Programming Guide\fR