Updated some documentation stating that endpoint identifiers registered without
a name are place at the front of the lookup list. Also renamed register method
'ast_sip_register_endpoint_identifier_by_name' to
'ast_sip_register_endpoint_identifier_with_name'
ASTERISK-24840
Reported by: Mark Michelson
git-svn-id: https://origsvn.digium.com/svn/asterisk/branches/13@433031
65c4cc65-6c06-0410-ace0-
fbb531ad65f3
* \retval 0 Success
* \retval -1 Failure
*/
-int ast_sip_register_endpoint_identifier_by_name(struct ast_sip_endpoint_identifier *identifier,
- const char *name);
+int ast_sip_register_endpoint_identifier_with_name(struct ast_sip_endpoint_identifier *identifier,
+ const char *name);
/*!
* \brief Register a SIP endpoint identifier
* be sure to load individual endpoint identifier modules in the order you wish
* for them to be run in modules.conf
*
+ * \note endpoint identifiers registered using this method (no name specified)
+ * are placed at the front of the endpoint identifiers list ahead of any
+ * named identifiers.
+ *
* \param identifier The SIP endpoint identifier to register
* \retval 0 Success
* \retval -1 Failure
static AST_RWLIST_HEAD_STATIC(endpoint_identifiers, endpoint_identifier_list);
-int ast_sip_register_endpoint_identifier_by_name(struct ast_sip_endpoint_identifier *identifier,
+int ast_sip_register_endpoint_identifier_with_name(struct ast_sip_endpoint_identifier *identifier,
const char *name)
{
char *prev, *current, *identifier_order;
int ast_sip_register_endpoint_identifier(struct ast_sip_endpoint_identifier *identifier)
{
- return ast_sip_register_endpoint_identifier_by_name(identifier, NULL);
+ return ast_sip_register_endpoint_identifier_with_name(identifier, NULL);
}
void ast_sip_unregister_endpoint_identifier(struct ast_sip_endpoint_identifier *identifier)
{
CHECK_PJSIP_MODULE_LOADED();
- ast_sip_register_endpoint_identifier_by_name(&anonymous_identifier, "anonymous");
+ ast_sip_register_endpoint_identifier_with_name(&anonymous_identifier, "anonymous");
return AST_MODULE_LOAD_SUCCESS;
}
ast_sorcery_object_field_register_custom(ast_sip_get_sorcery(), "identify", "match", "", ip_identify_match_handler, match_to_str, match_to_var_list, 0, 0);
ast_sorcery_reload_object(ast_sip_get_sorcery(), "identify");
- ast_sip_register_endpoint_identifier_by_name(&ip_identifier, "ip");
+ ast_sip_register_endpoint_identifier_with_name(&ip_identifier, "ip");
ast_sip_register_endpoint_formatter(&endpoint_identify_formatter);
cli_formatter = ao2_alloc(sizeof(struct ast_sip_cli_formatter_entry), NULL);
{
CHECK_PJSIP_MODULE_LOADED();
- ast_sip_register_endpoint_identifier_by_name(&username_identifier, "username");
+ ast_sip_register_endpoint_identifier_with_name(&username_identifier, "username");
return AST_MODULE_LOAD_SUCCESS;
}