* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library; if not, see <http://www.gnu.org/licenses/>.
*/
/*
*
* The GAsyncQueue struct is an opaque data structure which represents
* an asynchronous queue. It should only be accessed through the
- * <function>g_async_queue_*</function> functions.
+ * g_async_queue_* functions.
*/
struct _GAsyncQueue
{
*
* Creates a new asynchronous queue.
*
- * Return value: a new #GAsyncQueue. Free with g_async_queue_unref()
+ * Returns: a new #GAsyncQueue. Free with g_async_queue_unref()
*/
GAsyncQueue *
g_async_queue_new (void)
* function that is used to free any remaining queue items when
* the queue is destroyed after the final unref.
*
- * Return value: a new #GAsyncQueue. Free with g_async_queue_unref()
+ * Returns: a new #GAsyncQueue. Free with g_async_queue_unref()
*
* Since: 2.16
*/
*
* Increases the reference count of the asynchronous @queue by 1.
*
- * @Deprecated: Since 2.8, reference counting is done atomically
+ * Deprecated: 2.8: Reference counting is done atomically.
* so g_async_queue_ref() can be used regardless of the @queue's
* lock.
*/
* the @queue's lock. If the reference count went to 0, the @queue
* will be destroyed and the memory allocated will be freed.
*
- * @Deprecated: Since 2.8, reference counting is done atomically
+ * Deprecated: 2.8: Reference counting is done atomically.
* so g_async_queue_unref() can be used regardless of the @queue's
* lock.
*/
* Call g_async_queue_unlock() to drop the lock again.
*
* While holding the lock, you can only call the
- * <function>g_async_queue_*_unlocked()</function> functions
- * on @queue. Otherwise, deadlock may occur.
+ * g_async_queue_*_unlocked() functions on @queue. Otherwise,
+ * deadlock may occur.
*/
void
g_async_queue_lock (GAsyncQueue *queue)
* Pops data from the @queue. If @queue is empty, this function
* blocks until data becomes available.
*
- * Return value: data from the queue
+ * Returns: data from the queue
*/
gpointer
g_async_queue_pop (GAsyncQueue *queue)
*
* This function must be called while holding the @queue's lock.
*
- * Return value: data from the queue.
+ * Returns: data from the queue.
*/
gpointer
g_async_queue_pop_unlocked (GAsyncQueue *queue)
* Tries to pop data from the @queue. If no data is available,
* %NULL is returned.
*
- * Return value: data from the queue or %NULL, when no data is
+ * Returns: data from the queue or %NULL, when no data is
* available immediately.
*/
gpointer
*
* This function must be called while holding the @queue's lock.
*
- * Return value: data from the queue or %NULL, when no data is
+ * Returns: data from the queue or %NULL, when no data is
* available immediately.
*/
gpointer
*
* If no data is received before the timeout, %NULL is returned.
*
- * Return value: data from the queue or %NULL, when no data is
+ * Returns: data from the queue or %NULL, when no data is
* received before the timeout.
*/
gpointer
*
* This function must be called while holding the @queue's lock.
*
- * Return value: data from the queue or %NULL, when no data is
+ * Returns: data from the queue or %NULL, when no data is
* received before the timeout.
*/
gpointer
* To easily calculate @end_time, a combination of g_get_current_time()
* and g_time_val_add() can be used.
*
- * Return value: data from the queue or %NULL, when no data is
+ * Returns: data from the queue or %NULL, when no data is
* received before @end_time.
*
* Deprecated: use g_async_queue_timeout_pop().
if (end_time != NULL)
{
m_end_time = g_get_monotonic_time () +
- (end_time->tv_sec * G_USEC_PER_SEC + end_time->tv_usec -
- g_get_real_time ());
+ ((gint64) end_time->tv_sec * G_USEC_PER_SEC + end_time->tv_usec - g_get_real_time ());
}
else
m_end_time = -1;
*
* This function must be called while holding the @queue's lock.
*
- * Return value: data from the queue or %NULL, when no data is
+ * Returns: data from the queue or %NULL, when no data is
* received before @end_time.
*
* Deprecated: use g_async_queue_timeout_pop_unlocked().
if (end_time != NULL)
{
m_end_time = g_get_monotonic_time () +
- (end_time->tv_sec * G_USEC_PER_SEC + end_time->tv_usec -
- g_get_real_time ());
+ ((gint64) end_time->tv_sec * G_USEC_PER_SEC + end_time->tv_usec - g_get_real_time ());
}
else
m_end_time = -1;
* in the queue and n threads waiting. This can happen due to locking
* of the queue or due to scheduling.
*
- * Return value: the length of the @queue
+ * Returns: the length of the @queue
*/
gint
g_async_queue_length (GAsyncQueue *queue)
*
* This function must be called while holding the @queue's lock.
*
- * Return value: the length of the @queue.
+ * Returns: the length of the @queue.
*/
gint
g_async_queue_length_unlocked (GAsyncQueue *queue)
*
* If you were sorting a list of priority numbers to make sure the
* lowest priority would be at the top of the queue, you could use:
- * |[
+ * |[<!-- language="C" -->
* gint32 id1;
* gint32 id2;
*
projects / platform / upstream / glib.git / blobdiff