polyphony 0.85 → 0.86

data/vendor/liburing/man/io_uring_cq_advance.3

@@ -0,0 +1,35 @@
+.\" Copyright (C) 2022 Stefan Roesch <shr@fb.com>
+.\"
+.\" SPDX-License-Identifier: LGPL-2.0-or-later
+.\"
+.TH io_uring_cq_advance 3 "January 25, 2022" "liburing-2.1" "liburing Manual"
+.SH NAME
+io_uring_cq_advance - Mark one or more io_uring completion events as processed
+.SH SYNOPSIS
+.nf
+.BR "#include <liburing.h>"
+.PP
+.BI "void io_uring_cqe_advance(struct io_uring *ring,"
+.BI "                          unsigned nr)"
+.fi
+.PP
+.SH DESCRIPTION
+.PP
+The io_uring_cq_advance() function marks
+.I nr
+IO completions
+belonging to the
+.I ring
+param as processed.
+
+After the caller has submitted a request with io_uring_submit(), he can retrieve
+the completion with io_uring_wait_cqe() and mark it then as processed with
+io_uring_cqe_seen(). 
+
+The function io_uring_cqe_seen() calls the function io_uring_cq_advance().
+
+Completions must be marked as completed, so their slot can get reused.
+.SH RETURN VALUE
+None
+.SH SEE ALSO
+.BR io_uring_submit (3), io_uring_wait_cqe (3), io_uring_cqe_seen (3)

data/vendor/liburing/man/io_uring_cq_ready.3

@@ -0,0 +1,25 @@
+.\" Copyright (C) 2022 Stefan Roesch <shr@fb.com>
+.\"
+.\" SPDX-License-Identifier: LGPL-2.0-or-later
+.\"
+.TH io_uring_cq_ready "January 25, 2022" "liburing-2.1" "liburing Manual"
+.SH NAME
+io_uring_cq_ready - number of unconsumed ready entries in the CQ ring
+.SH SYNOPSIS
+.nf
+.BR "#include <liburing.h>"
+.PP
+.BI "unsigned io_uring_cq_ready(const struct io_uring *ring)"
+.fi
+.PP
+.SH DESCRIPTION
+.PP
+The io_uring_cq_ready() function retuns the number of unconsumed entries that
+are ready belonging to the
+.I ring
+param.
+
+.SH RETURN VALUE
+Returns the number of unconsumed ready entries in the CQ ring.
+.SH SEE ALSO
+.BR io_uring_submit (3),  io_uring_wait_cqe (3)

data/vendor/liburing/man/io_uring_cqe_get_data.3

@@ -0,0 +1,34 @@
+.\" Copyright (C) 2021 Stefan Roesch <shr@fb.com>
+.\"
+.\" SPDX-License-Identifier: LGPL-2.0-or-later
+.\"
+.TH io_uring_cqe_get_data 3 "November 15, 2021" "liburing-2.1" "liburing Manual"
+.SH NAME
+io_uring_cqe_get_data - get user data for completion event
+.SH SYNOPSIS
+.nf
+.BR "#include <liburing.h>"
+.PP
+.BI "void *io_uring_cqe_get_data(struct io_uring_cqe *cqe)"
+.fi
+.PP
+.SH DESCRIPTION
+.PP
+The io_uring_cqe_get_data() function returns the user_data
+with the completion queue entry
+.I cqe.
+
+After the caller has received a completion queue entry (CQE) with io_uring_wait_cqe(),
+he can call he io_uring_cqe_get_data() function to retrieve the
+.I user_data
+value. This requires that
+.I user_data
+has been set earlier with the function io_uring_sqe_set_data().
+
+.SH RETURN VALUE
+If the
+.I user_data
+value has been set before submitting the request, it will be returned. Otherwise
+the functions returns NULL.
+.SH SEE ALSO
+.BR io_uring_get_sqe (3), io_uring_sqe_set_data (3),  io_uring_sqe_submit(3)

data/vendor/liburing/man/io_uring_cqe_seen.3

@@ -0,0 +1,32 @@
+.\" Copyright (C) 2021 Stefan Roesch <shr@fb.com>
+.\"
+.\" SPDX-License-Identifier: LGPL-2.0-or-later
+.\"
+.TH io_uring_cqe_seen 3 "November 15, 2021" "liburing-2.1" "liburing Manual"
+.SH NAME
+io_uring_cqe_seen - Mark io_uring completion event as processed
+.SH SYNOPSIS
+.nf
+.BR "#include <liburing.h>"
+.PP
+.BI "void io_uring_cqe_seen(struct io_uring *ring,"
+.BI "                       struct io_uring_cqe *cqe)"
+.fi
+.PP
+.SH DESCRIPTION
+.PP
+The io_uring_cqe_seen() function marks the IO completion
+.I cqe
+belonging to the
+.I ring
+param as processed.
+
+After the caller has submitted a request with io_uring_submit(), he can retrieve
+the completion with io_uring_wait_cqe() and mark it then as processed with
+io_uring_cqe_seen().
+
+Completions must be marked as completed, so their slot can get reused.
+.SH RETURN VALUE
+None
+.SH SEE ALSO
+.BR io_uring_submit (3),  io_uring_wait_cqe(3)