serializer_shutdown_group.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
struct ast_serializer_shutdown_group *	ast_serializer_shutdown_group_alloc (void)
	Create a serializer group shutdown control object. More...
void	ast_serializer_shutdown_group_dec (struct ast_serializer_shutdown_group *shutdown_group)
	Decrement the number of serializer members in the group. More...
void	ast_serializer_shutdown_group_inc (struct ast_serializer_shutdown_group *shutdown_group)
	Increment the number of serializer members in the group. 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...

Function Documentation

ast_serializer_shutdown_group_alloc()

struct ast_serializer_shutdown_group * ast_serializer_shutdown_group_alloc

(

void

)

Create a serializer group shutdown control object.

Since

13.5.0

Returns

ao2 object to control shutdown of a serializer group.

Definition at line 42 of file serializer_shutdown_group.c.

{
    struct ast_serializer_shutdown_group *shutdown_group;
 
    shutdown_group = ao2_alloc(sizeof(*shutdown_group), serializer_shutdown_group_dtor);
    if (!shutdown_group) {
        return NULL;
    }
    ast_cond_init(&shutdown_group->cond, NULL);
    return shutdown_group;
}

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(), ast_serializer_taskpool_create(), load_module(), and sip_options_init_task().

ast_serializer_shutdown_group_dec()

void ast_serializer_shutdown_group_dec

(

struct ast_serializer_shutdown_group *

shutdown_group

)

Decrement the number of serializer members in the group.

Since

23.1.0

22.7.0

20.17.0

Parameters

shutdown_group

Group shutdown controller.

Definition at line 100 of file serializer_shutdown_group.c.

{
    ao2_lock(shutdown_group);
    --shutdown_group->count;
    if (!shutdown_group->count) {
        ast_cond_signal(&shutdown_group->cond);
    }
    ao2_unlock(shutdown_group);
}

References ao2_lock, ao2_unlock, ast_cond_signal, ast_serializer_shutdown_group::cond, ast_serializer_shutdown_group::count, and shutdown_group.

Referenced by serializer_shutdown().

ast_serializer_shutdown_group_inc()

void ast_serializer_shutdown_group_inc

(

struct ast_serializer_shutdown_group *

shutdown_group

)

Increment the number of serializer members in the group.

Since

23.1.0

22.7.0

20.17.0

Parameters

shutdown_group

Group shutdown controller.

Definition at line 93 of file serializer_shutdown_group.c.

{
    ao2_lock(shutdown_group);
    ++shutdown_group->count;
    ao2_unlock(shutdown_group);
}

References ao2_lock, ao2_unlock, ast_serializer_shutdown_group::count, and shutdown_group.

Referenced by ast_taskpool_serializer_group(), and ast_threadpool_serializer_group().

ast_serializer_shutdown_group_join()

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.

Since

13.5.0

Parameters

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.

Returns

Number of serializers that did not get shutdown within the timeout.

Definition at line 54 of file serializer_shutdown_group.c.

{
    int remaining;
    ast_mutex_t *lock;
 
    if (!shutdown_group) {
        return 0;
    }
 
    lock = ao2_object_get_lockaddr(shutdown_group);
    ast_assert(lock != NULL);
 
    ao2_lock(shutdown_group);
    if (timeout) {
        struct timeval start;
        struct timespec end;
 
        start = ast_tvnow();
        end.tv_sec = start.tv_sec + timeout;
        end.tv_nsec = start.tv_usec * 1000;
        while (shutdown_group->count) {
            if (ast_cond_timedwait(&shutdown_group->cond, lock, &end)) {
                /* Error or timed out waiting for the count to reach zero. */
                break;
            }
        }
    } else {
        while (shutdown_group->count) {
            if (ast_cond_wait(&shutdown_group->cond, lock)) {
                /* Error */
                break;
            }
        }
    }
    remaining = shutdown_group->count;
    ao2_unlock(shutdown_group);
    return remaining;
}

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().