Changeset View
Changeset View
Standalone View
Standalone View
share/man/man9/alq.9
Show All 25 Lines | |||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | ||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||||
.\" SUCH DAMAGE. | .\" SUCH DAMAGE. | ||||
.\" | .\" | ||||
.\" $FreeBSD$ | .\" $FreeBSD$ | ||||
.\" | .\" | ||||
.Dd April 26, 2010 | .Dd March 22, 2016 | ||||
.Dt ALQ 9 | .Dt ALQ 9 | ||||
.Os | .Os | ||||
.Sh NAME | .Sh NAME | ||||
.Nm alq , | .Nm alq , | ||||
.Nm alq_open_flags , | .Nm alq_open_flags , | ||||
.Nm alq_open , | .Nm alq_open , | ||||
.Nm alq_writen , | .Nm alq_writen , | ||||
.Nm alq_write , | .Nm alq_write , | ||||
Show All 25 Lines | |||||
.Fa "int count" | .Fa "int count" | ||||
.Fc | .Fc | ||||
.Ft int | .Ft int | ||||
.Fn alq_writen "struct alq *alq" "void *data" "int len" "int flags" | .Fn alq_writen "struct alq *alq" "void *data" "int len" "int flags" | ||||
.Ft int | .Ft int | ||||
.Fn alq_write "struct alq *alq" "void *data" "int flags" | .Fn alq_write "struct alq *alq" "void *data" "int flags" | ||||
.Ft void | .Ft void | ||||
.Fn alq_flush "struct alq *alq" | .Fn alq_flush "struct alq *alq" | ||||
.Ft void | .Ft int | ||||
.Fn alq_close "struct alq *alq" | .Fn alq_close "struct alq *alq" | ||||
.Ft struct ale * | .Ft struct ale * | ||||
.Fn alq_getn "struct alq *alq" "int len" "int flags" | .Fn alq_getn "struct alq *alq" "int len" "int flags" | ||||
.Ft struct ale * | .Ft struct ale * | ||||
.Fn alq_get "struct alq *alq" "int flags" | .Fn alq_get "struct alq *alq" "int flags" | ||||
.Ft void | .Ft void | ||||
.Fn alq_post_flags "struct alq *alq" "struct ale *ale" "int flags" | .Fn alq_post_flags "struct alq *alq" "struct ale *ale" "int flags" | ||||
.Ft void | .Ft void | ||||
▲ Show 20 Lines • Show All 323 Lines • ▼ Show 20 Lines | |||||
.Fn alq_get | .Fn alq_get | ||||
functions return | functions return | ||||
.Dv NULL | .Dv NULL | ||||
if | if | ||||
.Dv ALQ_NOWAIT | .Dv ALQ_NOWAIT | ||||
was set in | was set in | ||||
.Fa flags | .Fa flags | ||||
and either the queue is full or the system is shutting down. | and either the queue is full or the system is shutting down. | ||||
.Pp | |||||
The | |||||
.Fn alq_close | |||||
function will return any error encountered from | |||||
.Xr VOP_WRITE 9 | |||||
or | |||||
.Xr VOP_CLOSE 9 . | |||||
kib: I do not think that this is either correct or useful explanation. E.g. it does not mention mac… | |||||
.Pp | .Pp | ||||
NOTE: invalid arguments to non-void functions will result in | NOTE: invalid arguments to non-void functions will result in | ||||
undefined behaviour. | undefined behaviour. | ||||
.Sh SEE ALSO | .Sh SEE ALSO | ||||
.Xr syslog 3 , | .Xr syslog 3 , | ||||
.Xr kproc 9 , | .Xr kproc 9 , | ||||
.Xr ktr 9 , | .Xr ktr 9 , | ||||
.Xr msleep_spin 9 , | .Xr msleep_spin 9 , | ||||
Show All 18 Lines |
I do not think that this is either correct or useful explanation. E.g. it does not mention mac checks.
It would be more useful to say that errors encountered while final file operations are returned, without descending into specific ops.