dd/d5f/serializer_8h_source.html

 /*
  * Asterisk -- An open source telephony toolkit.
  *
  * Copyright (C) 2019, Sangoma Technologies Corporation
  *
  * Kevin Harwell <[email protected]>
  *
  * See http://www.asterisk.org for more information about
  * the Asterisk project. Please do not directly contact
  * any of the maintainers of this project for assistance;
  * the project provides a web site, mailing lists and IRC
  * channels for your use.
  *
  * This program is free software, distributed under the terms of
  * the GNU General Public License Version 2. See the LICENSE file
  * at the top of the source tree.
  */

 #ifndef _AST_SERIALIZER_H
 #define _AST_SERIALIZER_H

 struct ast_threadpool;

 /*!
  * Maintains a named pool of thread pooled taskprocessors. Also if configured
  * a shutdown group can be enabled that will ensure all serializers have
  * completed any assigned task before destruction.
  */
 struct ast_serializer_pool;

 /*!
  * \brief Destroy the serializer pool.
  *
  * Attempt to destroy the serializer pool. If a shutdown group has been enabled,
  * and times out waiting for threads to complete, then this function will return
  * the number of remaining threads, and the pool will not be destroyed.
  *
  * \param pool The pool to destroy
  */
 int ast_serializer_pool_destroy(struct ast_serializer_pool *pool);

 /*!
  * \brief Create a serializer pool.
  *
  * Create a serializer pool with an optional shutdown group. If a timeout greater
  * than -1 is specified then a shutdown group is enabled on the pool.
  *
  * \param name The base name for the pool, and used when building taskprocessor(s)
  * \param size The size of the pool
  * \param threadpool The backing threadpool to use
  * \param timeout The timeout used if using a shutdown group (-1 = disabled)
  *
  * \retval A newly allocated serializer pool object, or NULL on error
  */
 struct ast_serializer_pool *ast_serializer_pool_create(const char *name,
  unsigned int size, struct ast_threadpool *threadpool, int timeout);

 /*!
  * \brief Retrieve the base name of the serializer pool.
  *
  * \param pool The pool object
  *
  * \retval The base name given to the pool
  */
 const char *ast_serializer_pool_name(const struct ast_serializer_pool *pool);

 /*!
  * \brief Retrieve a serializer from the pool.
  *
  * \param pool The pool object
  *
  * \retval A serializer/taskprocessor
  */
 struct ast_taskprocessor *ast_serializer_pool_get(struct ast_serializer_pool *pool);

 /*!
  * \brief Set taskprocessor alert levels for the serializers in the pool.
  *
  * \param pool The pool to destroy
  *
  * \retval 0 on success, or -1 on error.
  */
 int ast_serializer_pool_set_alerts(struct ast_serializer_pool *pool, long high, long low);

 #endif /* _AST_SERIALIZER_H */
ast_serializer_pool_destroy
int ast_serializer_pool_destroy(struct ast_serializer_pool *pool)
Destroy the serializer pool.
Definition: serializer.c:39

timeout
static int timeout
Definition: cdr_mysql.c:86

pool
static pj_pool_t * pool
Global memory pool for configuration and timers.
Definition: res_rtp_asterisk.c:236

ast_serializer_pool
Definition: serializer.c:28

threadpool
static struct ast_threadpool * threadpool
Thread pool for observers.
Definition: sorcery.c:86

name
static const char name[]
Definition: cdr_mysql.c:74

ast_serializer_pool_set_alerts
int ast_serializer_pool_set_alerts(struct ast_serializer_pool *pool, long high, long low)
Set taskprocessor alert levels for the serializers in the pool.
Definition: serializer.c:156

ast_serializer_pool_create
struct ast_serializer_pool * ast_serializer_pool_create(const char *name, unsigned int size, struct ast_threadpool *threadpool, int timeout)
Create a serializer pool.
Definition: serializer.c:76

ast_serializer_pool_name
const char * ast_serializer_pool_name(const struct ast_serializer_pool *pool)
Retrieve the base name of the serializer pool.
Definition: serializer.c:122

ast_taskprocessor
A ast_taskprocessor structure is a singleton by name.
Definition: taskprocessor.c:69

ast_threadpool
An opaque threadpool structure.
Definition: threadpool.c:36

ast_serializer_pool_get
struct ast_taskprocessor * ast_serializer_pool_get(struct ast_serializer_pool *pool)
Retrieve a serializer from the pool.
Definition: serializer.c:127