putbq.9

7号信令功能代码,为开源代码

'\" tr
.\" -*- nroff -*-
.\"
.\" @(#) putbq.9,v 1.1.4.1 2004/01/12 23:33:09 brian Exp
.\"
.\" =========================================================================
.\"
.\" Copyright (C) 2001-2004  OpenSS7 Corp. <www.openss7.com>
.\"
.\" All Rights Reserved.
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one
.\" 
.\" Since the Linux kernel and libraries are constantly changing, this
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein.  The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\" 
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\"
.\" =========================================================================
.\"
.\" Modified 2004/01/12 23:33:09 by brian
.\"
.\" =========================================================================
.so lis.macros
.R1
bracket-label "\fR[\fB" "\fR]" "\fR, \fB"
no-default-database
database lis.refs
accumulate
move-punctuation
abbreviate A
join-authors ", " ", " " and "
et-al " et al" 2 3
abbreviate-label-ranges ".."
sort-adjacent-labels
.R2
.\"
.\"
.TH PUTBQ 9 "2004/01/12 23:33:09" "LiS-2_16_18-8" "Linux STREAMS DDI/DKI"
.SH NAME
.B putbq, lis_putbq
\- puts a message back on a \fISTREAMS\fR message queue
.SH SYNOPSIS
.PP
.B #include <sys/stream.h>
.HP 8
.BI "int " retval " = putbq(queue_t *" q ", struct msgb *" mp );
.SH DESCRIPTION
.PP
.BR putbq ()
places the message pointed to by
.I mp
back onto the queue pointed to by
.IR q .
When the message is placed back on the queue, it is placed on the head of the
queue, rahter than the tail of the queue as would result from a call to
.BR putq (9).
.PP
.BR putbq ()
is normally called from within queue service routines to place a message back
on the queue subsequent to a call to
.BR getq (9)
that removes a message which it turns out cannot be processed at the moment.
.SH "RETURN VALUES"
.PP
Upon success,
.BR putbq ()
returns true (1).
.PP
Upon failure,
.BR putbq ()
returns false (0) and the message pointed to by
.I mp
is freed using
.BR freemsg  (9).
.PP
Regardless of whether
.BR putbq ()
returns success or failure, the message pointed to by
.I mp
is
placed on the queue pointed to by
.I q
or freed, so that the caller to
.BR putbq ()
always loses ownership of the message pointed to by
.I mp
upon return from the call.
.SH ERRORS
.PP
.BR putbq ()
fails if the passed in message pointer
.I mp
is
.BR NULL ;
or, the passed in queue pointer
.I q
is
.BR NULL ,
points to a structure other than a queue structure, or refers to a queue that
is closing or for which
put and service routine processing has been
turned off (e.g. with
.BR qprocsoff (9)).
.SH CAVEATS
.PP
None.
.SH "SEE ALSO"
.PP
.BR getq (9),
.BR putq (9).
.SH VERSIONS
.PP
This manpage was written for
.B LiS\c
.
.[
LiS
.]
.PP
.BR putbq ()
first appeared in SVR 3.
.[
svr3
.]
.\"
.\"
.XX
.[
magic
.]
.[
svr42
.]
.[
svr4
.]
.\"
.\"
.[
$LIST$
.]
.TA