* \param chan ast_channel The channel to attach the hook on to.
* \param i framehook interface, The framehook's callback functions and stored data.
*
- * \pre XXX The Channel must be locked during this function all.
+ * \pre The Channel must be locked during this function all.
*
* \note The data pointer is never touched by the framehook API except to
* provide it during the event and destruction callbacks. It is entirely up to the
* \brief Detach an framehook from a channel.
* \since 1.8
*
- * \pre XXX The Channel must be locked during this function all.
+ * \pre The Channel must be locked during this function all.
* If this function is never called after attaching an framehook,
* the framehook will be detached and destroyed during channel
* destruction.
* framehooks on a channel during channel destruction.
* \since 1.8
*
- * \pre XXX The Channel must be locked during this function all.
+ * \pre The Channel must be locked during this function all.
*
* \param chan channel containing the framehook list to destroy.
* \retval 0 success
* even NULL. There is nothing to keep up with after this function. If the frame is modified, the
* framehook callback is in charge of any memory management associated with that modification.
*
- * \pre XXX The Channel must be locked during this function all.
+ * \pre The Channel must be locked during this function all.
*
* \param framehooks list to push event to.
* \param frame being pushed to the framehook list.
* even NULL. There is nothing to keep up with after this function. If the frame is modified, the
* framehook callback is in charge of any memory management associated with that modification.
*
- * \pre XXX The Channel must be locked during this function all.
+ * \pre The Channel must be locked during this function all.
*
* \param framehooks list to push event to.
* \param frame being pushed to the framehook list.
/*!
* \brief Determine if an framehook list is empty or not
* \since 1.8
- * \pre XXX The Channel must be locked during this function all.
+ * \pre The Channel must be locked during this function all.
*
* \param framehooks the framehook list
* \retval 0, not empty
* \retval 1, is empty
*/
int ast_framehook_list_is_empty(struct ast_framehook_list *framehooks);
+
+/*!
+ * \brief Determine if a framehook list is free of active framehooks or not
+ * \since 12.0.0
+ * \pre The channel must be locked during this function all.
+ *
+ * \param framehooks the framehook list
+ * \retval 0, not empty
+ * \retval 1, is empty (aside from dying framehooks)
+ *
+ * \note This function is very similar to ast_framehook_list_is_empty, but it checks individual
+ * framehooks to see if they have been marked for destruction and doesn't count them if they are.
+ */
+int ast_framehook_list_contains_no_active(struct ast_framehook_list *framehooks);
+
#endif /* _AST_FRAMEHOOK_H */
return AST_LIST_EMPTY(&framehooks->list) ? 1 : 0;
}
+int ast_framehook_list_contains_no_active(struct ast_framehook_list *framehooks)
+{
+ struct ast_framehook *cur;
+
+ if (!framehooks) {
+ return 1;
+ }
+
+ if (AST_LIST_EMPTY(&framehooks->list)) {
+ return 1;
+ }
+
+ AST_LIST_TRAVERSE(&framehooks->list, cur, list) {
+ if (cur->detach_and_destroy_me) {
+ continue;
+ }
+ return 0;
+ }
+
+ return 1;
+}
+
struct ast_frame *ast_framehook_list_write_event(struct ast_framehook_list *framehooks, struct ast_frame *frame)
{
return framehook_list_push_event(framehooks, frame, AST_FRAMEHOOK_EVENT_WRITE);