Commit bbb88ad4 authored by Pekka Pessi's avatar Pekka Pessi

Updated RELEASE, adding @since to document entries.

darcs-hash:20061129102938-65a35-6aae333b704e3cbf4a8ee69cafbac56425163ad3.gz
parent c11dad56
......@@ -22,12 +22,11 @@ API/ABI changes and versioning
libsofia-sip-ua:
- Added sdp_media_red, sdp_proto_udptl.
- Added host_cmp() for comparing host names or IP addresses in numeric
format.
- Added auth_mod_name() to <sofia-sip/auth_module.c>
- Added msg_make() and msg_as_string() to <sofia-sip/msg.h>
- Added SU_TIME_EPOCH to <sofia-sip/su_time.h>
- Added host_cmp() to <sofia-sip/hostdomain.h>
- Added host_cmp() for comparing host names or IP addresses in numeric
format to <sofia-sip/hostdomain.h>
- Added nua_method() and NUTAG_METHOD() to <sofia-sip/nua.h>
- Added nth_request_auth(), NTHTAG_AUTH_MODULE(), nth_site_url(), and
nth_site_access_time() to <sofia-sip/nth.h>
......@@ -37,7 +36,7 @@ libsofia-sip-ua:
msg_header_remove_item()
(handling Allow and Allow-Events headers)
- Added function msg_parse_next_field() for parsing headers with
multiple fields
multiple fields
- Added functions for handling SIP headers encoded in SIP URL:
sip_headers_as_url_query(), sip_url_query_as_taglist(),
url_query_as_header_string(), url_unescape_to(),
......@@ -47,11 +46,12 @@ libsofia-sip-ua:
- Added NUTAG_INCLUDE_EXTRA_SDP()
- Added nua_handle_by_replaces(), nua_handle_make_replaces(),
nua_handle_magic() and nua_magic() functions
- Added Refer-Sub header
- Added nua_i_register event for incoming REGISTER requests (nua.h)
- Added NUTAG_WITH(), nutag_with, NUTAG_WITH_CURRENT(),
- Added NUTAG_WITH(), nutag_with, NUTAG_WITH_THIS(),
nua_current_request(), NUTAG_WITH_SAVED(), nua_saved_event_request()
(nua_tag.h, nua.h)
- Added <sofia-sip/su_osx_runloop.h>, su_root_osx_runloop_create() and
su_root_osx_prepare_run()
- Added tport_is_closed() and tport_is_shutdown() to the public API.
- This release is ABI/API compatible with applications linked against
any 1.12.x release. However, applications built against this release won't
......
......@@ -39,5 +39,7 @@ ALIASES = \
"ENDGPL2=\endif \n" \
"ERRORS=\par Errors: " \
"ERROR=\par \n \b " \
"NEW_1_12_2=@since New in <a href=\"http://sofia-sip.sf.net/relnotes/relnotes-sofia-sip-1.12.2.txt\">1.12.2</a>" \
"VERSION_1_12_2=<a href=\"http://sofia-sip.sf.net/relnotes/relnotes-sofia-sip-1.12.2.txt\">1.12.2</a>" \
"NEW_1_12_4=@since New in <a href=\"http://sofia-sip.sf.net/relnotes/relnotes-sofia-sip-1.12.4.txt\">1.12.4</a>" \
"VERSION_1_12_4=<a href=\"http://sofia-sip.sf.net/relnotes/relnotes-sofia-sip-1.12.4.txt\">1.12.4</a>" \
......@@ -278,7 +278,7 @@ void auth_mod_unref(auth_mod_t *am)
auth_mod_destroy(am);
}
/** Get authenticatin module name */
/** Get authenticatin module name. @NEW_1_12_4. */
char const *auth_mod_name(auth_mod_t *am)
{
return am ? am->am_scheme->asch_method : "<nil>";
......
......@@ -1202,7 +1202,7 @@ msg_header_t *error_header_parse(msg_t *msg, msg_pub_t *mo,
* separating header fields)
* @param slen ignored
*
* @since New in @VERSION_1_12_4
* @since New in @VERSION_1_12_4.
*
* @retval >= 0 when successful
* @retval -1 upon an error
......@@ -2785,7 +2785,7 @@ int msg_header_add_str(msg_t *msg,
*
* @sa msg_header_add_str(), url_headers_as_string()
*
* @since New in @VERSION_1_12_4
* @since New in @VERSION_1_12_4.
*/
int msg_header_parse_str(msg_t *msg,
msg_pub_t *pub,
......
......@@ -1138,7 +1138,7 @@ char const *msg_header_find_item(msg_common_t const *h, char const *item)
* @retval 1 if item was replaced
* @retval -1 upon an error
*
* @since New in @VERSION_1_12_4
* @since New in @VERSION_1_12_4.
*
* @sa msg_header_remove_item(), @Allow, @AllowEvents,
* msg_header_replace_param(), msg_header_remove_param(),
......@@ -1168,7 +1168,7 @@ int msg_header_replace_item(su_home_t *home,
* @retval 1 if item was replaced
* @retval -1 upon an error
*
* @since New in @VERSION_1_12_4
* @since New in @VERSION_1_12_4.
*
* @sa msg_header_replace_item(), @Allow, @AllowEvents,
* msg_header_replace_param(), msg_header_remove_param(),
......
......@@ -472,7 +472,7 @@ void nth_site_bind(nth_site_t *site,
}
/** Get the site URL. */
/** Get the site URL. @NEW_1_12_4. */
url_t const *nth_site_url(nth_site_t const *site)
{
return site ? site->site_url : NULL;
......@@ -484,7 +484,7 @@ char const *nth_site_server_version(void)
return "nth/" NTH_VERSION;
}
/** Get the time last time served. */
/** Get the time last time served. @NEW_1_12_4. */
su_time_t nth_site_access_time(nth_site_t const *site)
{
su_time_t const never = { 0, 0 };
......
......@@ -179,7 +179,7 @@ NTH_DLL extern tag_typedef_t nthtag_strict_host_ref;
#define NTHTAG_STRICT_HOST_REF(x) nthtag_strict_host_ref, tag_bool_vr(&(x))
NTH_DLL extern tag_typedef_t nthtag_auth_module;
/** Pointer to authentication module. @HI */
/** Pointer to authentication module. @HI. @NEW_1_12_4. */
#define NTHTAG_AUTH_MODULE(x) nthtag_auth_module, tag_ptr_v((x))
NTH_DLL extern tag_typedef_t nthtag_auth_module_ref;
......
......@@ -232,6 +232,8 @@ void nua_destroy(nua_t *nua)
* @param nua Pointer to @nua stack object
*
* @return Callback context pointer.
*
* @NEW_1_12_4.
*/
nua_magic_t *nua_magic(nua_t *nua)
{
......@@ -344,6 +346,8 @@ void nua_handle_bind(nua_handle_t *nh, nua_hmagic_t *hmagic)
*
* @par Events:
* none
*
* @NEW_1_12_4.
*/
nua_hmagic_t *nua_handle_magic(nua_handle_t *nh)
{
......@@ -1019,13 +1023,13 @@ void nua_event(nua_t *root_magic, su_msg_r sumsg, event_t *e)
su_msg_destroy(nua->nua_current);
}
/** Get current request message. */
/** Get current request message. @NEW_1_12_4. */
msg_t *nua_current_request(nua_t const *nua)
{
return nua && nua->nua_current ? su_msg_data(nua->nua_current)->e_msg : NULL;
}
/** Get request message from saved nua event. */
/** Get request message from saved nua event. @NEW_1_12_4. */
msg_t *nua_saved_event_request(nua_saved_event_t const *saved)
{
return saved ? su_msg_data(saved)->e_msg : NULL;
......
......@@ -152,8 +152,9 @@ typedef enum nua_event_e {
/* NOTE: Post 1.12 release events come here (below) to keep ABI
compatibility! */
nua_i_network_changed, /**< Local IP(v6) address has changed */
nua_i_register, /**< Incoming REGISTER */
nua_i_network_changed, /**< Local IP(v6) address has changed.
@NEW_1_12_2 */
nua_i_register, /**< Incoming REGISTER. @NEW_1_12_4. */
} nua_event_t;
typedef struct event_s {
......
......@@ -123,18 +123,55 @@ SOFIAPUBVAR tag_typedef_t nutag_address;
SOFIAPUBVAR tag_typedef_t nutag_address_ref;
/**Specify request to respond to.
*
* @par Used with
* nua_respond()
*
* @par Parameter type
* msg_t *
*
* @par Values
* Pointer to a request message.
*
* @NEW_1_12_4.
*
* @sa NUTAG_WITH_THIS(), NUTAG_WITH_SAVED()
*/
#define NUTAG_WITH(x) nutag_with, tag_ptr_v(x)
SOFIAPUBVAR tag_typedef_t nutag_with;
/**Specify request to respond to.
*
* @par Used with
* nua_respond()
*
* @par Parameter type
* nua_t *
*
* @par Values
* Pointer to the nua agent instance object.
*
* @NEW_1_12_4.
*
* @sa nua_save_event(), NUTAG_WITH(), NUTAG_WITH_SAVED()
*/
#define NUTAG_WITH_THIS(nua) nutag_with, tag_ptr_v(nua_current_request((nua)))
/**Specify request to respond to.
*
* @par Used with
* nua_respond()
*
* @par Parameter type
* msg_t *
*
* @par Values
* Pointer to a saved event.
*
* @NEW_1_12_4.
*
* @sa nua_save_event(), NUTAG_WITH(), NUTAG_WITH_THIS()
*/
#define NUTAG_WITH_SAVED(e) nutag_with, tag_ptr_v(nua_saved_event_request((e)))
/**Set request retry count.
......@@ -153,6 +190,8 @@ SOFIAPUBVAR tag_typedef_t nutag_with;
* @par Values
* @c 0 Never retry automatically \n
*
* @NEW_1_12_4.
*
* Corresponding tag taking reference parameter is NUTAG_RETRY_COUNT_REF()
*/
#define NUTAG_RETRY_COUNT(x) nutag_retry_count, tag_uint_v(x)
......@@ -1725,6 +1764,8 @@ SOFIAPUBVAR tag_typedef_t nutag_supported_ref;
* nua_subscribe(), nua_publish(), SIPTAG_ALLOW_EVENTS(),
* SIPTAG_ALLOW_EVENTS_STR()
*
* @NEW_1_12_4.
*
* Corresponding tag taking reference parameter is NUTAG_ALLOW_EVENTS_REF()
*/
#define NUTAG_ALLOW_EVENTS(x) nutag_allow_events, tag_str_v(x)
......
......@@ -230,7 +230,7 @@ typedef enum
sdp_media_control, /**< Additional conference control */
sdp_media_message, /**< Messaging sessions*/
sdp_media_image, /**< Image browsing sessions for JPIP, and T.38 */
sdp_media_red /**< Redundancy */
sdp_media_red /**< Redundancy. @NEW_1_12_4 */
} sdp_media_e;
/** Media transport protocol. */
......@@ -241,7 +241,7 @@ typedef enum
sdp_proto_udp = 17, /**< Plain UDP */
sdp_proto_rtp = 256, /**< RTP/AVP */
sdp_proto_srtp = 257, /**< RTP/SAVP */
sdp_proto_udptl = 258, /**< UDPTL */
sdp_proto_udptl = 258, /**< UDPTL. @NEW_1_12_4 */
sdp_proto_tls = 511, /**< TLS over TCP */
sdp_proto_any = 512 /**< * wildcard */
} sdp_proto_e;
......
......@@ -378,6 +378,8 @@ char const *append_escaped(su_strlst_t *l,
* sip_headers_as_url_query(), url_query_as_header_string(),
* @RFC3261 section 19.1.1 "Headers", #url_t, url_s#url_headers
*
* @NEW_1_12_4.
*
* @bug Extension headers are ignored. The @a parser parameter is not used
* at the moment.
*/
......
......@@ -28,12 +28,13 @@
/**
* @file sofia-sip/su_osx_runloop.h
* @brief
* @brief OSX Run Loop integration.
*
* @author Martti Mela <Martti.Mela@nokia.com>
*
* @date Created: Fri Sep 22 16:49:51 EEST 2006 mela
*
* @NEW_1_12_4.
*/
#ifndef SU_WAIT_H
......
......@@ -78,7 +78,7 @@ typedef uint64_t su_ntp_t;
#define SU_TIME_CMP(t1, t2) su_time_cmp(t1, t2)
/** Seconds from 1.1.1900 to 1.1.1970 */
/** Seconds from 1.1.1900 to 1.1.1970. @NEW_1_12_4 */
#define SU_TIME_EPOCH 2208988800UL
SOFIAPUBFUN su_time_t su_now(void);
......
......@@ -406,6 +406,8 @@ static void su_port_osx_destroy(su_port_t *self);
* @param magic pointer to user data
*
* @return A pointer to allocated su_root_t instance, NULL on error.
*
* @NEW_1_12_4.
*/
su_root_t *su_root_osx_runloop_create(su_root_magic_t *magic)
{
......@@ -1398,6 +1400,7 @@ int su_port_osx_threadsafe(su_port_t *port)
*
* @param root pointer to root object
*
* @NEW_1_12_4.
*/
void su_root_osx_prepare_run(su_root_t *root)
{
......
......@@ -264,6 +264,8 @@ char *url_escape(char *d, char const *s, char const reserved[])
* @param n maximum number of characters to unescape
*
* @return Length of unescaped string
*
* @NEW_1_12_4.
*/
size_t url_unescape_to(char *d, char const *s, size_t n)
{
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment