Commit 3f3799c3 authored by Pekka Pessi's avatar Pekka Pessi

nta: updated documentation

darcs-hash:20070920182420-65a35-124e3a85f6b98d13b3d70eeaa1924bda3076b2db.gz
parent 8a0f2698
......@@ -4536,7 +4536,7 @@ nta_incoming_t *incoming_create(nta_agent_t *agent,
irq->irq_home = home = msg_home(msg_ref_create(msg));
irq->irq_agent = agent;
irq->irq_received = agent_now(agent);
irq->irq_received = agent_now(agent); /* Timestamp originally from tport */
irq->irq_method = method;
irq->irq_rq = sip_request_copy(home, sip->sip_request);
......@@ -5127,7 +5127,12 @@ nta_incoming_magic_t *nta_incoming_magic(nta_incoming_t *irq,
return irq && irq->irq_callback == callback ? irq->irq_magic : NULL;
}
/** When received */
/** When received.
*
* Return timestamp from the reception of the initial request.
*
* @NEW_1_12_7.
*/
sip_time_t nta_incoming_received(nta_incoming_t *irq,
su_nanotime_t *return_nano)
{
......@@ -6766,7 +6771,7 @@ unsigned nta_outgoing_delay(nta_outgoing_t const *orq)
return orq != NULL && orq != NONE ? orq->orq_delay : UINT_MAX;
}
/** Get the branch parameter. @NEW_1_12_7 */
/** Get the branch parameter. @NEW_1_12_7. */
char const *nta_outgoing_branch(nta_outgoing_t const *orq)
{
return orq != NULL && orq != NONE && orq->orq_branch
......
......@@ -26,7 +26,8 @@
/** Defined when <nta_internal.h> has been included. */
#define NTA_INTERNAL_H
/**@IFILE nta_internal.h
/**@internal @file nta_internal.h
*
* @brief Internals of NTA objects.
*
* @author Pekka Pessi <Pekka.Pessi@nokia.com>
......
This diff is collapsed.
......@@ -22,8 +22,8 @@
*
*/
/**@file portbind.c
* @brief bind a socket to an UDP/TCP port and return the port number
/**@internal @file portbind.c
* @brief Bind a socket to an UDP/TCP port and return the port number
*
* @author Pekka Pessi <Pekka.Pessi@nokia.com>
*
......
......@@ -63,25 +63,25 @@ typedef struct nta_incoming_s nta_incoming_t;
#ifndef NTA_AGENT_MAGIC_T
/** Default type of application context for NTA agents.
* Application may define this to appropriate type before including
* <nta.h>. */
* <sofia-sip/nta.h>. */
#define NTA_AGENT_MAGIC_T struct nta_agent_magic_s
#endif
#ifndef NTA_LEG_MAGIC_T
/** Default type of application context for NTA call legs.
* Application may define this to appropriate type before including
* <nta.h>. */
* <sofia-sip/nta.h>. */
#define NTA_LEG_MAGIC_T struct nta_leg_magic_s
#endif
#ifndef NTA_OUTGOING_MAGIC_T
/** Default type of application context for outgoing NTA requests.
* Application may define this to appropriate type before including
* <nta.h>. */
* <sofia-sip/nta.h>. */
#define NTA_OUTGOING_MAGIC_T struct nta_outgoing_magic_s
#endif
#ifndef NTA_INCOMING_MAGIC_T
/** Default type of application context for incoming NTA requests.
* Application may define this to appropriate type before including
* <nta.h>. */
* <sofia-sip/nta.h>. */
#define NTA_INCOMING_MAGIC_T struct nta_incoming_magic_s
#endif
......@@ -439,13 +439,13 @@ SOFIAPUBFUN int nta_outgoing_setrseq(nta_outgoing_t *orq, uint32_t rseq);
typedef struct nta_reliable_s nta_reliable_t;
#ifndef NTA_RELIABLE_MAGIC_T
/** Default type of application context for reliable NTA responses.
/** Default type of application context for reliable preliminary responses.
* Application may define this to appropriate type before including
* <nta.h>. */
* <sofia-sip/nta.h>. */
#define NTA_RELIABLE_MAGIC_T struct nta_reliable_magic_s
#endif
/** Application context for reliable NTA requests */
/** Application context for reliable preliminary responses. */
typedef NTA_RELIABLE_MAGIC_T nta_reliable_magic_t;
typedef int nta_prack_f(nta_reliable_magic_t *rmagic,
......
This diff is collapsed.
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