Mercurial > illumos > git > illumos-core
changeset 14981:b17b8113f882
fixes #141 wordsmithing on canputnext(9F) needed
author | Garrett D'Amore <garrett@damore.org> |
---|---|
date | Tue, 16 Dec 2014 06:24:14 -0800 |
parents | 3738d4fefe85 |
children | 5961423f6c15 |
files | usr/src/man/man9f/canputnext.9f |
diffstat | 1 files changed, 11 insertions(+), 5 deletions(-) [+] |
line wrap: on
line diff
--- a/usr/src/man/man9f/canputnext.9f Tue Dec 16 06:22:02 2014 -0800 +++ b/usr/src/man/man9f/canputnext.9f Tue Dec 16 06:24:14 2014 -0800 @@ -11,7 +11,7 @@ .\" .\" Copyright 2014 Garrett D'Amore <garrett@damore.org> .\" -.Dd "Dec 3, 2014" +.Dd "Dec 15, 2014" .Dt CANPUTNEXT 9F .Os .Sh NAME @@ -37,12 +37,15 @@ .Fn canputnext and .Fn bcanputnext -functions are functionality equivalent, and preferable to calling +functions atomically test for available space in the next +linked queue or priority band. +They are preferable to and safer than calling .Xr canput 9F and .Xr bcanput 9F -with the queue linked to by +directly on the the queue linked to by .Fa q Ns No -> Ns Fa q_next . +.Lp Drivers and modules should call these routines to ensure that room on the next queue exists before calling .Xr putnext 9F . @@ -51,16 +54,19 @@ .Sh PARAMETERS .Bl -tag -width Ds .It Fa q -STREAMs queue. +STREAMS queue. .It Fa pri Priority band to test. .El +.Sh CONTEXT +These functions may be called in user, kernel, or interrupt +context. .Sh RETURN VALUES .Bl -tag -width Ds .It 1 If the next message queue is not full. .It 0 -If the next message is full. +If the next message queue is full. .El .Sh SEE ALSO .Rs