share/man/man9f/qsize.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 QSIZE 9F "Jan 16, 2006"
   8 .SH NAME
   9 qsize \- find the number of messages on a queue
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/stream.h>
  14
  15
  16
  17 \fBint\fR \fBqsize\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 Queue to be evaluated.
  32 .RE
  33
  34 .SH DESCRIPTION
  35 .sp
  36 .LP
  37 The \fBqsize()\fR function evaluates the queue \fIq\fR and returns the number
  38 of messages it contains.
  39 .SH RETURN VALUES
  40 .sp
  41 .LP
  42 If there are no message on the queue, \fBqsize()\fR returns \fB0\fR. Otherwise,
  43 it returns the integer representing the number of messages on the queue.
  44 .SH CONTEXT
  45 .sp
  46 .LP
  47 The \fBqsize()\fR function can be called from user, interrupt, or kernel
  48 context.
  49 .SH SEE ALSO
  50 .sp
  51 .LP
  52 \fIWriting Device Drivers\fR
  53 .sp
  54 .LP
  55 \fISTREAMS Programming Guide\fR