sin/samba-mirror
1
0
Fork 0
mirror of https://github.com/samba-team/samba.git synced 2024-12-25 23:21:54 +03:00
Code

s3: Tiny doc for pthreadpool

Browse Source
This commit is contained in:
Volker Lendecke 2011-04-23 22:25:36 +02:00
parent 62689d8166
commit 3c405f5e1d
1 changed files with 59 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
source3/lib/pthreadpool/pthreadpool.h
View File

@ -1,7 +1,7 @@
/*
* Unix SMB/CIFS implementation.
* threadpool implementation based on pthreads
* Copyright (C) Volker Lendecke 2009
* Copyright (C) Volker Lendecke 2009,2011
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
@ -22,21 +22,73 @@
struct pthreadpool;
/**
* @defgroup pthreadpool The pthreadpool API
*
* This API provides a way to run threadsafe functions in a helper
* thread. It is initially intended to run getaddrinfo asynchronously.
*/
/**
* @brief Create a pthreadpool
*
* A struct pthreadpool is the basis for for running threads in the
* background.
*
* @param[in] max_threads Maximum parallelism in this pool
* @param[out] presult Pointer to the threadpool returned
* @return success: 0, failure: errno
*/
int pthreadpool_init(unsigned max_threads, struct pthreadpool **presult);
/**
* @brief Destroy a pthreadpool
*
* Destroy a pthreadpool. If jobs are still active, this returns
* EBUSY.
*
* @param[in] pool The pool to destroy
* @return success: 0, failure: errno
*/
int pthreadpool_destroy(struct pthreadpool *pool);
/*
* Add a job to a pthreadpool.
/**
* @brief Add a job to a pthreadpool
*
* This adds a job to a pthreadpool. The job can be identified by
* job_id. This integer will be returned from
* pthreadpool_finished_job() then the job is completed.
*
* @param[in] pool The pool to run the job on
* @param[in] job_id A custom identifier
* @param[in] fn The function to run asynchronously
* @param[in] private_data Pointer passed to fn
* @return success: 0, failure: errno
*/
int pthreadpool_add_job(struct pthreadpool *pool, int job_id,
void (*fn)(void *private_data), void *private_data);
/*
* Get the signalling fd out of a thread pool. This fd will become readable
* when a job is finished. The job that finished can be retrieved via
* pthreadpool_finished_job().
/**
* @brief Get the signalling fd from a pthreadpool
*
* Completion of a job is indicated by readability of the fd retuned
* by pthreadpool_sig_fd().
*
* @param[in] pool The pool in question
* @return The fd to listen on for readability
*/
int pthreadpool_sig_fd(struct pthreadpool *pool);
/**
* @brief Get the job_id of a finished job
*
* This blocks until a job has finished unless the fd returned by
* pthreadpool_sig_fd() is readable.
*
* @param[in] pool The pool to query for finished jobs
* @return The job_id of the finished job
*/
int pthreadpool_finished_job(struct pthreadpool *pool);
#endif