1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) Index Data.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of Index Data nor the names of its contributors
13 * may be used to endorse or promote products derived from this
14 * software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 * \file thread_create.h
30 * \brief Implements thread creation wrappers
32 #ifndef YAZ_THREAD_CREATE_H
33 #define YAZ_THREAD_CREATE_H
37 #include <yaz/yconfig.h>
41 /** \brief Thread Identifier opaque pointer */
42 typedef struct yaz_thread *yaz_thread_t;
44 /** \brief create thread
45 \param start_routine thread handler
46 \param arg user data to be passed to handler
47 \returns thread_id identifier if successful; NULL on failure
49 YAZ_EXPORT yaz_thread_t yaz_thread_create(void *(*start_routine)(void *p), void *arg);
51 /** \brief join thread
52 \param tp thread_id reference .. Will be 0 upon completion
53 \param value_ptr ref pointer to routine result (0 if not needed)
55 YAZ_EXPORT void yaz_thread_join(yaz_thread_t *tp, void **value_ptr);
57 /** \brief detach thread
58 \param tp thread_id reference .. Will be 0 upon completion
60 void yaz_thread_detach(yaz_thread_t *tp);
68 * c-file-style: "Stroustrup"
69 * indent-tabs-mode: nil
71 * vim: shiftwidth=4 tabstop=8 expandtab