77 lines
2.8 KiB
C
77 lines
2.8 KiB
C
/*****************************************************************************
|
|
|
|
Copyright (c) 2006, 2018, Oracle and/or its affiliates. All Rights Reserved.
|
|
|
|
This program is free software; you can redistribute it and/or modify it under
|
|
the terms of the GNU General Public License, version 2.0, as published by the
|
|
Free Software Foundation.
|
|
|
|
This program is also distributed with certain software (including but not
|
|
limited to OpenSSL) that is licensed under separate terms, as designated in a
|
|
particular file or component or in included license documentation. The authors
|
|
of MySQL hereby grant you an additional permission to link the program and
|
|
your derivative works with the separately licensed software that they have
|
|
included with MySQL.
|
|
|
|
This program is distributed in the hope that it will be useful, but WITHOUT
|
|
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
|
FOR A PARTICULAR PURPOSE. See the GNU General Public License, version 2.0,
|
|
for more details.
|
|
|
|
You should have received a copy of the GNU General Public License along with
|
|
this program; if not, write to the Free Software Foundation, Inc.,
|
|
51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
|
|
|
*****************************************************************************/
|
|
|
|
/** @file include/ut0wqueue.h
|
|
A work queue
|
|
|
|
Created 4/26/2006 Osku Salerma
|
|
************************************************************************/
|
|
|
|
/** A Work queue. Threads can add work items to the queue and other threads can
|
|
wait for work items to be available and take them off the queue for
|
|
processing.
|
|
************************************************************************/
|
|
|
|
#ifndef IB_WORK_QUEUE_H
|
|
#define IB_WORK_QUEUE_H
|
|
|
|
#include "mem0mem.h"
|
|
#include "sync0sync.h"
|
|
#include "ut0list.h"
|
|
|
|
// Forward declaration
|
|
struct ib_list_t;
|
|
struct ib_wqueue_t;
|
|
|
|
/** Create a new work queue.
|
|
@return work queue */
|
|
ib_wqueue_t *ib_wqueue_create();
|
|
|
|
/** Free a work queue. */
|
|
void ib_wqueue_free(ib_wqueue_t *wq); /*!< in: work queue */
|
|
|
|
/** Add a work item to the queue. */
|
|
void ib_wqueue_add(ib_wqueue_t *wq, /*!< in: work queue */
|
|
void *item, /*!< in: work item */
|
|
mem_heap_t *heap); /*!< in: memory heap to use for
|
|
allocating the list node */
|
|
|
|
/********************************************************************
|
|
Check if queue is empty. */
|
|
ibool ib_wqueue_is_empty(
|
|
/* out: TRUE if queue empty
|
|
else FALSE */
|
|
const ib_wqueue_t *wq); /* in: work queue */
|
|
|
|
/********************************************************************
|
|
Wait for a work item to appear in the queue for specified time. */
|
|
void *ib_wqueue_timedwait(
|
|
/* out: work item or NULL on timeout*/
|
|
ib_wqueue_t *wq, /* in: work queue */
|
|
ib_time_t wait_in_usecs); /* in: wait time in micro seconds */
|
|
|
|
#endif /* IB_WORK_QUEUE_H */
|