comparison include/freeDiameter/libfreeDiameter.h @ 637:22e8fac3b2d6

Split interface file in modules
author Sebastien Decugis <sdecugis@nict.go.jp>
date Thu, 16 Dec 2010 18:56:41 +0900
parents 04dbea46c7a2
children 9448cba86673
comparison
equal deleted inserted replaced
636:c23ca590fa57 637:22e8fac3b2d6
2179 * FUNCTION: fd_msg_source_(g/s)et 2179 * FUNCTION: fd_msg_source_(g/s)et
2180 * 2180 *
2181 * PARAMETERS: 2181 * PARAMETERS:
2182 * msg : A msg object. 2182 * msg : A msg object.
2183 * diamid : The diameter id of the peer from which this message was received. 2183 * diamid : The diameter id of the peer from which this message was received.
2184 * hash : The hash for the diamid value.
2185 * add_rr : if true, a Route-Record AVP is added to the message with content diamid. In that case, dict must be supplied. 2184 * add_rr : if true, a Route-Record AVP is added to the message with content diamid. In that case, dict must be supplied.
2186 * dict : a dictionary with definition of Route-Record AVP (if add_rr is true) 2185 * dict : a dictionary with definition of Route-Record AVP (if add_rr is true)
2187 * 2186 *
2188 * DESCRIPTION: 2187 * DESCRIPTION:
2189 * Store or retrieve the diameted id of the peer from which this message was received. 2188 * Store or retrieve the diameted id of the peer from which this message was received.
2358 * - for grouped AVPs, the children AVP are created and interpreted also. 2357 * - for grouped AVPs, the children AVP are created and interpreted also.
2359 * - for numerical AVPs, the value is converted to host byte order and saved in the avp_value field. 2358 * - for numerical AVPs, the value is converted to host byte order and saved in the avp_value field.
2360 * - for octetstring AVPs, the string is copied into a new buffer and its address is saved in avp_value. 2359 * - for octetstring AVPs, the string is copied into a new buffer and its address is saved in avp_value.
2361 * If the dictionary definition is not found, avp_model is set to NULL and 2360 * If the dictionary definition is not found, avp_model is set to NULL and
2362 * the content of the AVP is saved as an octetstring in an internal structure. avp_value is NULL. 2361 * the content of the AVP is saved as an octetstring in an internal structure. avp_value is NULL.
2363 * As a result, after this function has been called, there is no more dependency of the msg object to the message buffer, that is be freed. 2362 * As a result, after this function has been called, there is no more dependency of the msg object to the message buffer, that is freed.
2364 * 2363 *
2365 * RETURN VALUE: 2364 * RETURN VALUE:
2366 * 0 : The message has been fully parsed as described. 2365 * 0 : The message has been fully parsed as described.
2367 * EINVAL : The msg parameter is invalid for this operation. 2366 * EINVAL : The msg parameter is invalid for this operation.
2368 * ENOMEM : Unable to allocate enough memory to complete the operation. 2367 * ENOMEM : Unable to allocate enough memory to complete the operation.
"Welcome to our mercurial repository"