a011d42211
Previously, netmgr, taskmgr, timermgr and socketmgr all had their own isc_<*>mgr_create() and isc_<*>mgr_destroy() functions. The new isc_managers_create() and isc_managers_destroy() fold all four into a single function and makes sure the objects are created and destroy in correct order. Especially now, when taskmgr runs on top of netmgr, the correct order is important and when the code was duplicated at many places it's easy to make mistake. The former isc_<*>mgr_create() and isc_<*>mgr_destroy() functions were made private and a single call to isc_managers_create() and isc_managers_destroy() is required at the program startup / shutdown.
87 lines
2.4 KiB
C
87 lines
2.4 KiB
C
/*
|
|
* Copyright (C) Internet Systems Consortium, Inc. ("ISC")
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, you can obtain one at https://mozilla.org/MPL/2.0/.
|
|
*
|
|
* See the COPYRIGHT file distributed with this work for additional
|
|
* information regarding copyright ownership.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <isc/mem.h>
|
|
#include <isc/result.h>
|
|
#include <isc/task.h>
|
|
|
|
isc_result_t
|
|
isc__taskmgr_create(isc_mem_t *mctx, unsigned int default_quantum, isc_nm_t *nm,
|
|
isc_taskmgr_t **managerp);
|
|
/*%<
|
|
* Create a new task manager.
|
|
*
|
|
* Notes:
|
|
*
|
|
*\li If 'default_quantum' is non-zero, then it will be used as the default
|
|
* quantum value when tasks are created. If zero, then an implementation
|
|
* defined default quantum will be used.
|
|
*
|
|
*\li If 'nm' is set then netmgr is paused when an exclusive task mode
|
|
* is requested.
|
|
*
|
|
* Requires:
|
|
*
|
|
*\li 'mctx' is a valid memory context.
|
|
*
|
|
*\li managerp != NULL && *managerp == NULL
|
|
*
|
|
* Ensures:
|
|
*
|
|
*\li On success, '*managerp' will be attached to the newly created task
|
|
* manager.
|
|
*
|
|
* Returns:
|
|
*
|
|
*\li #ISC_R_SUCCESS
|
|
*\li #ISC_R_NOMEMORY
|
|
*\li #ISC_R_NOTHREADS No threads could be created.
|
|
*\li #ISC_R_UNEXPECTED An unexpected error occurred.
|
|
*\li #ISC_R_SHUTTINGDOWN The non-threaded, shared, task
|
|
* manager shutting down.
|
|
*/
|
|
|
|
void
|
|
isc__taskmgr_destroy(isc_taskmgr_t **managerp);
|
|
/*%<
|
|
* Destroy '*managerp'.
|
|
*
|
|
* Notes:
|
|
*
|
|
*\li Calling isc_taskmgr_destroy() will shutdown all tasks managed by
|
|
* *managerp that haven't already been shutdown. The call will block
|
|
* until all tasks have entered the done state.
|
|
*
|
|
*\li isc_taskmgr_destroy() must not be called by a task event action,
|
|
* because it would block forever waiting for the event action to
|
|
* complete. An event action that wants to cause task manager shutdown
|
|
* should request some non-event action thread of execution to do the
|
|
* shutdown, e.g. by signaling a condition variable or using
|
|
* isc_app_shutdown().
|
|
*
|
|
*\li Task manager references are not reference counted, so the caller
|
|
* must ensure that no attempt will be made to use the manager after
|
|
* isc_taskmgr_destroy() returns.
|
|
*
|
|
* Requires:
|
|
*
|
|
*\li '*managerp' is a valid task manager.
|
|
*
|
|
*\li isc_taskmgr_destroy() has not be called previously on '*managerp'.
|
|
*
|
|
* Ensures:
|
|
*
|
|
*\li All resources used by the task manager, and any tasks it managed,
|
|
* have been freed.
|
|
*/
|