share/man/man9f/SAMESTR.9f

   1 '\" te
   2 .\" Copyright (c) 2006, 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 SAMESTR 9F "Jan 16, 2006"
   8 .SH NAME
   9 SAMESTR, samestr \- test if next queue is in the same stream
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/stream.h>
  14
  15
  16
  17 \fBint\fR \fBSAMESTR\fR(\fBqueue_t *\fR\fIq\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\fIq\fR\fR
  29 .ad
  30 .RS 5n
  31 Pointer to the queue.
  32 .RE
  33
  34 .SH DESCRIPTION
  35 .sp
  36 .LP
  37 The \fBSAMESTR()\fR function is used to see if the next queue in a stream (if
  38 it exists) is the same type as the current queue (that is, both are read queues
  39 or both are write queues). This function accounts for the twisted queue
  40 connections that occur in a STREAMS pipe and should be used in preference to
  41 direct examination of the \fBq_next\fR field of \fBqueue\fR(9S) to see if the
  42 stream continues beyond \fIq\fR.
  43 .SH RETURN VALUES
  44 .sp
  45 .LP
  46 The \fBSAMESTR()\fR function returns \fB1\fR if the next queue is the same type
  47 as the current queue. It returns \fB0\fR if the next queue does not exist or if
  48 it is not the same type.
  49 .SH CONTEXT
  50 .sp
  51 .LP
  52 The \fBSAMESTR()\fR function can be called from user, interrupt, context.
  53 .SH SEE ALSO
  54 .sp
  55 .LP
  56 \fBOTHERQ\fR(9F)
  57 .sp
  58 .LP
  59 \fIWriting Device Drivers\fR
  60 .sp
  61 .LP
  62 \fISTREAMS Programming Guide\fR