kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-10-31 02:37:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

channels: Fix for Doxygen.

Browse Source 
ASTERISK-29762

Change-Id: Ia8811ac12b93ff8c18164699c6fbc604cb0a23f7
This commit is contained in:
Alexander Traud
2021-11-19 10:46:06 +01:00
committed by Friendly Automation
parent 07d73dbc76
commit e8c18eeb28
15 changed files with 94 additions and 163 deletions
Download Patch File Download Diff File Expand all files Collapse all files

94
channels/chan_sip.c
View File

@@ -26,7 +26,7 @@
* \arg \ref AstCREDITS
*
* Implementation of RFC 3261 - without S/MIME, and experimental TCP and TLS support
* Configuration file \link Config_sip sip.conf \endlink
* Configuration file \ref sip.conf "Config_sip"
*
* ********** IMPORTANT *
* \note TCP/TLS support is EXPERIMENTAL and WILL CHANGE. This applies to configuration
@@ -2306,7 +2306,7 @@ static int sip_get_cc_information(struct sip_request *req, char *subscribe_uri,
return 0;
}
/*
/*!
* \brief Determine what, if any, CC has been offered and queue a CC frame if possible
*
* After taking care of some formalities to be sure that this call is eligible for CC,
@@ -2406,7 +2406,7 @@ static struct ast_tcptls_session_args sip_tls_desc = {
};
/*! \brief Append to SIP dialog history
\return Always returns 0 */
\retval 0 always */
#define append_history(p, event, fmt , args... ) append_history_full(p, "%-15s " fmt, event, ## args)
/*! \brief map from an integer value to a string.
@@ -2845,7 +2845,6 @@ done:
* 1) The message is a full SIP request
* 2) The message is a partial SIP request
* 3) The message contains a full SIP request along with another partial request
* \param data The unparsed incoming SIP message.
* \param request The resulting request with extra fragments removed.
* \param overflow If the message contains more than a full request, this is the remainder of the message
* \return The resulting integrity of the message
@@ -2912,10 +2911,13 @@ static enum message_integrity check_message_integrity(struct ast_str **request,
}
/*!
* \internal
* \brief Read SIP request or response from a TCP/TLS connection
*
* \param req The request structure to be filled in
* \param tcptls_session The TCP/TLS connection from which to read
* \param authenticated 0 means unauthenticated
* \param start timeout for unauthenticated server sessions
* \retval -1 Failed to read data
* \retval 0 Successfully read data
*/
@@ -3272,7 +3274,7 @@ static void unlink_peers_from_tables(peer_unlink_flag_t flag)
}
}
/* \brief Unlink all marked peers from ao2 containers */
/*! \brief Unlink all marked peers from ao2 containers */
static void unlink_marked_peers_from_tables(void)
{
unlink_peers_from_tables(SIP_PEERS_MARKED);
@@ -3283,7 +3285,9 @@ static void unlink_all_peers_from_tables(void)
unlink_peers_from_tables(SIP_PEERS_ALL);
}
/*! \brief maintain proper refcounts for a sip_pvt's outboundproxy
/*!
* \internal
* \brief maintain proper refcounts for a sip_pvt's outboundproxy
*
* This function sets pvt's outboundproxy pointer to the one referenced
* by the proxy parameter. Because proxy may be a refcounted object, and
@@ -3292,7 +3296,6 @@ static void unlink_all_peers_from_tables(void)
*
* \param pvt The sip_pvt for which we wish to set the outboundproxy
* \param proxy The sip_proxy which we will point pvt towards.
* \return Returns void
*/
static void ref_proxy(struct sip_pvt *pvt, struct sip_proxy *proxy)
{
@@ -4274,7 +4277,8 @@ static void sip_pkt_dtor(void *vdoomed)
/*!
* \internal
* \brief Transmit packet with retransmits
* \return 0 on success, -1 on failure to allocate packet
* \retval 0 on success
* \retval -1 on failure to allocate packet.
*/
static enum sip_result __sip_reliable_xmit(struct sip_pvt *p, uint32_t seqno, int resp, struct ast_str *data, int fatal, int sipmethod)
{
@@ -6040,7 +6044,8 @@ static int dialog_initialize_dtls_srtp(const struct sip_pvt *dialog, struct ast_
}
/*! \brief Initialize RTP portion of a dialog
* \return -1 on failure, 0 on success
* \retval -1 on failure.
* \retval 0 on success.
*/
static int dialog_initialize_rtp(struct sip_pvt *dialog)
{
@@ -6134,7 +6139,8 @@ static int __set_address_from_contact(const char *fullcontact, struct ast_sockad
* This function copies data from peer to the dialog, so we don't have to look up the peer
* again from memory or database during the life time of the dialog.
*
* \return -1 on error, 0 on success.
* \retval -1 on error.
* \retval 0 on success.
*
*/
static int create_addr_from_peer(struct sip_pvt *dialog, struct sip_peer *peer)
@@ -6841,8 +6847,8 @@ static void sip_pvt_dtor(void *vdoomed)
*
* Thought: For realtime, we should probably update storage with inuse counter...
*
* \return 0 if call is ok (no call limit, below threshold)
* -1 on rejection of call
* \retval 0 if call is ok (no call limit, below threshold).
* \retval -1 on rejection of call.
*
*/
static int update_call_counter(struct sip_pvt *fup, int event)
@@ -8858,8 +8864,6 @@ static void build_callid_pvt(struct sip_pvt *pvt)
*
* \param pvt SIP private structure to change callid
* \param callid Specified new callid to use. NULL if generate new callid.
*
* \return Nothing
*/
static void change_callid_pvt(struct sip_pvt *pvt, const char *callid)
{
@@ -9146,7 +9150,7 @@ static int process_via(struct sip_pvt *p, const struct sip_request *req)
return 0;
}
/* \brief arguments used for Request/Response to matching */
/*! \brief arguments used for Request/Response to matching */
struct match_req_args {
int method;
const char *callid;
@@ -9173,7 +9177,7 @@ enum match_req_res {
SIP_REQ_FORKED, /* An outgoing request has been forked as result of receiving two differing 200ok responses. */
};
/*
/*!
* \brief Match a incoming Request/Response to a dialog
*
* \retval enum match_req_res indicating if the dialog matches the arg
@@ -10050,7 +10054,8 @@ static int parse_request(struct sip_request *req)
/*!
\brief Determine whether a SIP message contains an SDP in its body
\param req the SIP request to process
\return 1 if SDP found, 0 if not found
\retval 1 if SDP found.
\retval 0 if not found.
Also updates req->sdp_start and req->sdp_count to indicate where the SDP
lives in the message body.
@@ -12779,7 +12784,9 @@ static int transmit_response_with_auth(struct sip_pvt *p, const char *msg, const
/*!
\brief Extract domain from SIP To/From header
\return -1 on error, 1 if domain string is empty, 0 if domain was properly extracted
\retval -1 on error.
\retval 1 if domain string is empty.
\retval 0 if domain was properly extracted.
\note TODO: Such code is all over SIP channel, there is a sense to organize
this patern in one function
*/
@@ -12885,8 +12892,6 @@ static int transmit_provisional_response(struct sip_pvt *p, const char *msg, con
* \brief Destroy all additional MESSAGE headers.
*
* \param pvt SIP private dialog struct.
*
* \return Nothing
*/
static void destroy_msg_headers(struct sip_pvt *pvt)
{
@@ -12904,8 +12909,6 @@ static void destroy_msg_headers(struct sip_pvt *pvt)
* \param pvt SIP private dialog struct.
* \param hdr_name Name of header for MESSAGE.
* \param hdr_value Value of header for MESSAGE.
*
* \return Nothing
*/
static void add_msg_header(struct sip_pvt *pvt, const char *hdr_name, const char *hdr_value)
{
@@ -14124,7 +14127,7 @@ static void add_cc_call_info_to_response(struct sip_pvt *p, struct sip_request *
}
/*! \brief Used for 200 OK and 183 early media
\return Will return XMIT_ERROR for network errors.
\retval XMIT_ERROR for network errors.
*/
static int transmit_response_with_sdp(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable, int oldsdp, int rpid)
{
@@ -14275,7 +14278,7 @@ static int transmit_reinvite_with_sdp(struct sip_pvt *p, int t38version, int old
return send_request(p, &req, XMIT_CRITICAL, p->ocseq);
}
/* \brief Remove URI parameters at end of URI, not in username part though */
/*! \brief Remove URI parameters at end of URI, not in username part though */
static char *remove_uri_parameters(char *uri)
{
char *atsign;
@@ -19979,7 +19982,9 @@ static char *transfermode2str(enum transfermodes mode)
}
/*! \brief Report Peer status in character string
* \return 0 if peer is unreachable, 1 if peer is online, -1 if unmonitored
* \retval 0 if peer is unreachable.
* \retval 1 if peer is online.
* \retval -1 if unmonitored.
*/
@@ -23060,7 +23065,7 @@ static int do_proxy_auth(struct sip_pvt *p, struct sip_request *req, enum sip_au
}
/*! \brief reply to authentication for outbound registrations
\return Returns -1 if we have no auth
\retval -1 if we have no auth
\note This is used for register= servers in sip.conf, SIP proxies we register
with for receiving calls from. */
static int reply_digest(struct sip_pvt *p, struct sip_request *req, char *header, int sipmethod, char *digest, int digest_len)
@@ -23136,7 +23141,7 @@ static int reply_digest(struct sip_pvt *p, struct sip_request *req, char *header
}
/*! \brief Build reply digest
\return Returns -1 if we have no auth
\retval -1 if we have no auth
\note Build digest challenge for authentication of registrations and calls
Also used for authentication of BYE
*/
@@ -23979,8 +23984,6 @@ static void handle_response_publish(struct sip_pvt *p, int resp, const char *res
* \param cause Hangup cause to queue. Zero if no cause.
*
* \pre p and p->owner are locked.
*
* \return Nothing
*/
static void sip_queue_hangup_cause(struct sip_pvt *p, int cause)
{
@@ -24564,7 +24567,7 @@ static void handle_response_invite(struct sip_pvt *p, int resp, const char *rest
}
}
/* \brief Handle SIP response in NOTIFY transaction
/*! \brief Handle SIP response in NOTIFY transaction
We've sent a NOTIFY, now handle responses to it
*/
static void handle_response_notify(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, uint32_t seqno)
@@ -24618,7 +24621,7 @@ static void handle_response_notify(struct sip_pvt *p, int resp, const char *rest
}
}
/* \brief Handle SIP response in SUBSCRIBE transaction */
/*! \brief Handle SIP response in SUBSCRIBE transaction */
static void handle_response_subscribe(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, uint32_t seqno)
{
if (p->subscribed == CALL_COMPLETION) {
@@ -24705,7 +24708,7 @@ static void handle_response_subscribe(struct sip_pvt *p, int resp, const char *r
}
}
/* \brief Handle SIP response in REFER transaction
/*! \brief Handle SIP response in REFER transaction
We've sent a REFER, now handle responses to it
*/
static void handle_response_refer(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, uint32_t seqno)
@@ -25069,7 +25072,7 @@ static void handle_response_info(struct sip_pvt *p, int resp, const char *rest,
/*!
* \internal
* \brief Handle auth requests to a MESSAGE request
* \return TRUE if authentication failed.
* \retval TRUE if authentication failed.
*/
static int do_message_auth(struct sip_pvt *p, int resp, const char *rest, struct sip_request *req, uint32_t seqno)
{
@@ -25652,8 +25655,8 @@ static int sip_pickup(struct ast_channel *chan)
/*! \brief Get tag from packet
*
* \return Returns the pointer to the provided tag buffer,
* or NULL if the tag was not found.
* \return pointer to the provided tag buffer.
* \retval NULL if the tag was not found.
*/
static const char *gettag(const struct sip_request *req, const char *header, char *tagbuf, int tagbufsize)
{
@@ -26203,8 +26206,9 @@ static int handle_request_update(struct sip_pvt *p, struct sip_request *req)
return 0;
}
/*
* \internal \brief Check Session Timers for an INVITE request
/*!
* \internal
* \brief Check Session Timers for an INVITE request
*
* \retval 0 ok
* \retval -1 failure
@@ -27247,7 +27251,7 @@ struct blind_transfer_cb_data {
* we may send out.
*
* \param chan The new outbound channel
* \param user_data A blind_transfer_cb_data struct
* \param user_data_wrapper A blind_transfer_cb_data struct
* \param transfer_type Unused
*/
static void blind_transfer_cb(struct ast_channel *chan, struct transfer_channel_data *user_data_wrapper,
@@ -29378,7 +29382,8 @@ static int handle_incoming(struct sip_pvt *p, struct sip_request *req, struct as
/*! \brief Read data from SIP UDP socket
\note sipsock_read locks the owner channel while we are processing the SIP message
\return 1 on error, 0 on success
\retval 1 on error.
\retval 0 on success.
\note Successful messages is connected to SIP call and forwarded to handle_incoming()
*/
static int sipsock_read(int *id, int fd, short events, void *ignore)
@@ -29755,7 +29760,8 @@ static int get_cached_mwi(struct sip_peer *peer, int *new, int *old)
* \note Both peer and associated sip_pvt must be unlocked prior to calling this function.
* It's possible that this function will get called during peer destruction as final messages
* are processed. The peer will still be valid however.
* \returns -1 on failure, 0 on success
* \retval -1 on failure.
* \retval 0 on success.
*/
static int sip_send_mwi_to_peer(struct sip_peer *peer, int cache_only)
{
@@ -31074,7 +31080,7 @@ static void set_insecure_flags (struct ast_flags *flags, const char *value, int
/*!
\brief Handle T.38 configuration options common to users and peers
\returns non-zero if any config options were handled, zero otherwise
\return non-zero if any config options were handled, zero otherwise
*/
static int handle_t38_options(struct ast_flags *flags, struct ast_flags *mask, struct ast_variable *v,
unsigned int *maxdatagram)
@@ -31119,7 +31125,7 @@ static int handle_t38_options(struct ast_flags *flags, struct ast_flags *mask, s
\param flags array of three struct ast_flags
\param mask array of three struct ast_flags
\param v linked list of config variables to process
\returns non-zero if any config options were handled, zero otherwise
\return non-zero if any config options were handled, zero otherwise
*/
static int handle_common_options(struct ast_flags *flags, struct ast_flags *mask, struct ast_variable *v)
{
@@ -31353,8 +31359,6 @@ static void clear_sip_domains(void)
* \brief Realm authentication container destructor.
*
* \param obj Container object to destroy.
*
* \return Nothing
*/
static void destroy_realm_authentication(void *obj)
{
@@ -31373,8 +31377,6 @@ static void destroy_realm_authentication(void *obj)
* \param credentials Realm authentication container to create/add authentication credentials.
* \param configuration Credential configuration value.
* \param lineno Line number in config file.
*
* \return Nothing
*/
static void add_realm_authentication(struct sip_auth_container **credentials, const char *configuration, int lineno)
{