Asterisk - The Open Source Telephony Project GIT-master-0644429
|
Go to the source code of this file.
Data Structures | |
struct | ast_threadpool_listener_callbacks |
struct | ast_threadpool_options |
Macros | |
#define | AST_THREADPOOL_OPTIONS_VERSION 1 |
Functions | |
struct ast_serializer_shutdown_group * | ast_serializer_shutdown_group_alloc (void) |
Create a serializer group shutdown control object. More... | |
int | ast_serializer_shutdown_group_join (struct ast_serializer_shutdown_group *shutdown_group, int timeout) |
Wait for the serializers in the group to shutdown with timeout. More... | |
struct ast_threadpool * | ast_threadpool_create (const char *name, struct ast_threadpool_listener *listener, const struct ast_threadpool_options *options) |
Create a new threadpool. More... | |
struct ast_threadpool_listener * | ast_threadpool_listener_alloc (const struct ast_threadpool_listener_callbacks *callbacks, void *user_data) |
Allocate a threadpool listener. More... | |
void * | ast_threadpool_listener_get_user_data (const struct ast_threadpool_listener *listener) |
Get the threadpool listener's user data. More... | |
int | ast_threadpool_push (struct ast_threadpool *pool, int(*task)(void *data), void *data) attribute_warn_unused_result |
Push a task to the threadpool. More... | |
long | ast_threadpool_queue_size (struct ast_threadpool *pool) |
Return the size of the threadpool's task queue. More... | |
struct ast_taskprocessor * | ast_threadpool_serializer (const char *name, struct ast_threadpool *pool) |
Serialized execution of tasks within a ast_threadpool. More... | |
struct ast_taskprocessor * | ast_threadpool_serializer_get_current (void) |
Get the threadpool serializer currently associated with this thread. More... | |
struct ast_taskprocessor * | ast_threadpool_serializer_group (const char *name, struct ast_threadpool *pool, struct ast_serializer_shutdown_group *shutdown_group) |
Serialized execution of tasks within a ast_threadpool. More... | |
void | ast_threadpool_set_size (struct ast_threadpool *threadpool, unsigned int size) |
Set the number of threads for the thread pool. More... | |
void | ast_threadpool_shutdown (struct ast_threadpool *pool) |
Shut down a threadpool and destroy it. More... | |
#define AST_THREADPOOL_OPTIONS_VERSION 1 |
Definition at line 71 of file threadpool.h.
struct ast_serializer_shutdown_group * ast_serializer_shutdown_group_alloc | ( | void | ) |
Create a serializer group shutdown control object.
Definition at line 1229 of file threadpool.c.
References ao2_alloc, ast_cond_init, ast_serializer_shutdown_group::cond, NULL, serializer_shutdown_group_dtor(), and shutdown_group.
Referenced by ast_serializer_pool_create(), load_module(), and sip_options_init_task().
int ast_serializer_shutdown_group_join | ( | struct ast_serializer_shutdown_group * | shutdown_group, |
int | timeout | ||
) |
Wait for the serializers in the group to shutdown with timeout.
shutdown_group | Group shutdown controller. (Returns 0 immediately if NULL) |
timeout | Number of seconds to wait for the serializers in the group to shutdown. Zero if the timeout is disabled. |
Definition at line 1241 of file threadpool.c.
References ao2_lock, ao2_object_get_lockaddr(), ao2_unlock, ast_assert, ast_cond_timedwait, ast_cond_wait, ast_tvnow(), ast_serializer_shutdown_group::cond, ast_serializer_shutdown_group::count, end, lock, NULL, and shutdown_group.
Referenced by ast_res_pjsip_cleanup_options_handling(), ast_serializer_pool_destroy(), and unload_module().
struct ast_threadpool * ast_threadpool_create | ( | const char * | name, |
struct ast_threadpool_listener * | listener, | ||
const struct ast_threadpool_options * | options | ||
) |
Create a new threadpool.
This function creates a threadpool. Tasks may be pushed onto this thread pool and will be automatically acted upon by threads within the pool.
Only a single threadpool with a given name may exist. This function will fail if a threadpool with the given name already exists.
name | The unique name for the threadpool |
listener | The listener the threadpool will notify of changes. Can be NULL. |
options | The behavioral options for this threadpool |
NULL | Failed to create the threadpool |
non-NULL | The newly-created threadpool |
Definition at line 916 of file threadpool.c.
References ao2_cleanup, ao2_ref, ast_alloca, ast_log, ast_taskprocessor_create_with_listener(), ast_taskprocessor_listener_alloc(), AST_THREADPOOL_OPTIONS_VERSION, ast_threadpool_set_size(), listener(), LOG_WARNING, name, NULL, options, RAII_VAR, threadpool_alloc(), and threadpool_tps_listener_callbacks.
Referenced by ast_sorcery_init(), AST_TEST_DEFINE(), load_module(), and stasis_init().
struct ast_threadpool_listener * ast_threadpool_listener_alloc | ( | const struct ast_threadpool_listener_callbacks * | callbacks, |
void * | user_data | ||
) |
Allocate a threadpool listener.
This function will call back into the alloc callback for the listener.
callbacks | Listener callbacks to assign to the listener |
user_data | User data to be stored in the threadpool listener |
NULL | Failed to allocate the listener |
non-NULL | The newly-created threadpool listener |
Definition at line 894 of file threadpool.c.
References ao2_alloc, callbacks, listener(), NULL, and ast_threadpool_listener::user_data.
Referenced by AST_TEST_DEFINE().
void * ast_threadpool_listener_get_user_data | ( | const struct ast_threadpool_listener * | listener | ) |
Get the threadpool listener's user data.
listener | The threadpool listener |
Definition at line 906 of file threadpool.c.
References listener().
Referenced by listener_check(), test_emptied(), test_shutdown(), test_state_changed(), test_task_pushed(), and wait_for_task_pushed().
int ast_threadpool_push | ( | struct ast_threadpool * | pool, |
int(*)(void *data) | task, | ||
void * | data | ||
) |
Push a task to the threadpool.
Tasks pushed into the threadpool will be automatically taken by one of the threads within
pool | The threadpool to add the task to |
task | The task to add |
data | The parameter for the task |
0 | success |
-1 | failure |
Definition at line 957 of file threadpool.c.
References ast_taskprocessor_push(), lock, SCOPED_AO2LOCK, ast_threadpool::shutting_down, task(), and ast_threadpool::tps.
Referenced by AST_TEST_DEFINE(), and serializer_task_pushed().
long ast_threadpool_queue_size | ( | struct ast_threadpool * | pool | ) |
Return the size of the threadpool's task queue.
Definition at line 1433 of file threadpool.c.
References ast_taskprocessor_size(), and ast_threadpool::tps.
Referenced by ast_sip_threadpool_queue_size().
struct ast_taskprocessor * ast_threadpool_serializer | ( | const char * | name, |
struct ast_threadpool * | pool | ||
) |
Serialized execution of tasks within a ast_threadpool.
A ast_taskprocessor with the same contract as a default taskprocessor (tasks execute serially) except instead of executing out of a dedicated thread, execution occurs in a thread from a ast_threadpool. Think of it as a lightweight thread.
While it guarantees that each task will complete before executing the next, there is no guarantee as to which thread from the pool
individual tasks will execute. This normally only matters if your code relies on thread specific information, such as thread locals.
Use ast_taskprocessor_unreference() to dispose of the returned ast_taskprocessor.
Only a single taskprocessor with a given name may exist. This function will fail if a taskprocessor with the given name already exists.
name | Name of the serializer. (must be unique) |
pool | ast_threadpool for execution. |
NULL | on error. |
Definition at line 1428 of file threadpool.c.
References ast_threadpool_serializer_group(), name, and NULL.
Referenced by AST_TEST_DEFINE(), internal_stasis_subscribe(), and sorcery_object_type_alloc().
struct ast_taskprocessor * ast_threadpool_serializer_get_current | ( | void | ) |
Get the threadpool serializer currently associated with this thread.
serializer | on success. |
NULL | on error or no serializer associated with the thread. |
Definition at line 1393 of file threadpool.c.
References ast_threadstorage_get_ptr().
Referenced by record_serializer(), rfc3326_outgoing_request(), and rfc3326_outgoing_response().
struct ast_taskprocessor * ast_threadpool_serializer_group | ( | const char * | name, |
struct ast_threadpool * | pool, | ||
struct ast_serializer_shutdown_group * | shutdown_group | ||
) |
Serialized execution of tasks within a ast_threadpool.
A ast_taskprocessor with the same contract as a default taskprocessor (tasks execute serially) except instead of executing out of a dedicated thread, execution occurs in a thread from a ast_threadpool. Think of it as a lightweight thread.
While it guarantees that each task will complete before executing the next, there is no guarantee as to which thread from the pool
individual tasks will execute. This normally only matters if your code relies on thread specific information, such as thread locals.
Use ast_taskprocessor_unreference() to dispose of the returned ast_taskprocessor.
Only a single taskprocessor with a given name may exist. This function will fail if a taskprocessor with the given name already exists.
name | Name of the serializer. (must be unique) |
pool | ast_threadpool for execution. |
shutdown_group | Group shutdown controller. (NULL if no group association) |
NULL | on error. |
Definition at line 1398 of file threadpool.c.
References ao2_ref, ast_taskprocessor_create_with_listener(), ast_taskprocessor_listener_alloc(), listener(), name, NULL, serializer_create(), serializer_shutdown_group_inc(), serializer_tps_listener_callbacks, and shutdown_group.
Referenced by ast_serializer_pool_create(), ast_sip_create_serializer_group(), and ast_threadpool_serializer().
void ast_threadpool_set_size | ( | struct ast_threadpool * | threadpool, |
unsigned int | size | ||
) |
Set the number of threads for the thread pool.
This number may be more or less than the current number of threads in the threadpool.
threadpool | The threadpool to adjust |
size | The new desired size of the threadpool |
Definition at line 875 of file threadpool.c.
References ast_free, ast_taskprocessor_push(), ast_threadpool::control_tps, lock, set_size_data::pool, queued_set_size(), SCOPED_AO2LOCK, set_size_data_alloc(), ast_threadpool::shutting_down, and set_size_data::size.
Referenced by AST_TEST_DEFINE(), and ast_threadpool_create().
void ast_threadpool_shutdown | ( | struct ast_threadpool * | pool | ) |
Shut down a threadpool and destroy it.
pool | The pool to shut down |
Definition at line 966 of file threadpool.c.
References ao2_lock, ao2_unlock, ast_taskprocessor_unreference(), ast_threadpool::control_tps, ast_threadpool::shutting_down, and ast_threadpool::tps.
Referenced by AST_TEST_DEFINE(), load_module(), sorcery_cleanup(), stasis_cleanup(), and unload_module().