Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add helper APIs for adding & removing port destroy handler #4244

Merged
merged 3 commits into from
Jan 10, 2025
Merged

Add helper APIs for adding & removing port destroy handler #4244

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cc01209
Add helper APIs for adding & removing port destroy handler.
nanangizz Jan 7, 2025
cfd75a7
Update docs
nanangizz Jan 7, 2025
bb0aabe
Added APIs for conference
nanangizz Jan 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions pjmedia/include/pjmedia/port.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -563,6 +563,37 @@ PJ_DECL(pj_status_t) pjmedia_port_add_ref( pjmedia_port *port );
PJ_DECL(pj_status_t) pjmedia_port_dec_ref( pjmedia_port *port );


/**
* This is a helper function to add port destructor handler.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not obvious when users can, or should, call this function? Should we call pjmedia_port_init_grp_lock() first? Or after adding the port to conf?

Copy link
Member Author

@nanangizz nanangizz Jan 7, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After adding the port to conf (where port is guaranted to have a group lock, i.e: added by conf if not yet). Updated #3928 desc issue 1 point ii. Should it be added to the function docs (also about avoiding premature pool release)?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, please.

Adding to the doc will be of great help in the future so we can easily recall how we're supposed to do this.

*
* @param port The PJMEDIA port.
* @param member A pointer to be passed to the handler.
* @param handler The destroy handler.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_port_add_destroy_handler(
pjmedia_port* port,
void *member,
pj_grp_lock_handler handler);


/**
* This is a helper function to remove previously registered
* destructor handler.
*
* @param port The PJMEDIA port.
* @param member A pointer to be passed to the handler.
* @param handler The destroy handler.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_port_del_destroy_handler(
pjmedia_port* port,
void *member,
pj_grp_lock_handler handler);


PJ_END_DECL

/**
Expand Down
30 changes: 30 additions & 0 deletions pjmedia/src/pjmedia/port.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,3 +232,33 @@ PJ_DEF(pj_status_t) pjmedia_port_dec_ref( pjmedia_port *port )

return pj_grp_lock_dec_ref(port->grp_lock);
}


/**
* Add destructor handler.
*/
PJ_DEF(pj_status_t) pjmedia_port_add_destroy_handler(
pjmedia_port* port,
void* member,
pj_grp_lock_handler handler)
{
PJ_ASSERT_RETURN(port && handler, PJ_EINVAL);
PJ_ASSERT_RETURN(port->grp_lock, PJ_EINVALIDOP);

return pj_grp_lock_add_handler(port->grp_lock, NULL, member, handler);
}


/**
* Remove previously registered destructor handler.
*/
PJ_DEF(pj_status_t) pjmedia_port_del_destroy_handler(
pjmedia_port* port,
void* member,
pj_grp_lock_handler handler)
{
PJ_ASSERT_RETURN(port && handler, PJ_EINVAL);
PJ_ASSERT_RETURN(port->grp_lock, PJ_EINVALIDOP);

return pj_grp_lock_del_handler(port->grp_lock, member, handler);
}
Loading