Changeset 1190 for pjproject/trunk/pjsip/include/pjsip/sip_transaction.h
- Timestamp:
- Apr 11, 2007 6:32:30 PM (18 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
pjproject/trunk/pjsip/include/pjsip/sip_transaction.h
r974 r1190 75 75 76 76 /** 77 * Transaction timeout timer policy, to control the UAC transaction timeout78 * scheduling (see #pjsip_tsx_set_uac_timeout()).79 */80 typedef enum pjsip_tsx_timeout_policy81 {82 PJSIP_TSX_IGNORE_100 = 1, /**< To make the UAC transaction NOT to cancel83 the timeout timer when 100 response is84 received.*/85 PJSIP_TSX_IGNORE_1xx = 3 /**< To make the UAC transaction NOT to cancel86 the timeout timer when any 1xx responses87 are received. */88 } pjsip_tsx_timeout_policy;89 90 91 /**92 77 * This structure describes SIP transaction object. The transaction object 93 78 * is used to handle both UAS and UAC transaction. … … 146 131 pj_timer_entry timeout_timer; /**< Timeout timer. */ 147 132 148 unsigned msec_timeout; /**< User set timeout. */149 pjsip_tsx_timeout_policy timeout_policy; /**< Timeout policy. */150 151 133 /** Module specific data. */ 152 134 void *mod_data[PJSIP_MAX_MODULE]; … … 249 231 const pjsip_tpselector *sel); 250 232 251 252 /**253 * Set the UAC absolute transaction timeout. Normally UAC transaction will254 * stop its timeout timer (timer B for INVITE and timer F for non-INVITE255 * transactions) after a provisional response is received.256 *257 * When this timer is set, the transaction's timer B and F will use this258 * value, and if the \a flag flag is set, the transaction will continue259 * the scheduling of the timeout timer even when provisional response has260 * been received.261 *262 * Note that this function MUST be called AFTER the transaction has been263 * created AND BEFORE any request is transmitted.264 *265 * @param tsx The client/UAC transaction.266 * @param msec_time The timeout value, in miliseconds. Currently this267 * value must be non-zero (value zero is reserved for268 * future use).269 * @param flag Option flags to control whether the transaction should270 * cancel the timeout timer on arrival of provisional271 * responses (which is yes according to RFC 3261).272 * The valid values are:273 * - PJSIP_TSX_IGNORE_100, to make the UAC transaction274 * NOT to cancel the timeout timer when 100 response275 * is received.276 * - PJSIP_TSX_IGNORE_1xx, to make the UAC transaction277 * NOT to cancel the timeout timer when any 1xx278 * responses are received.279 *280 * Note that regardless of the values in the \a flag281 * argument, the provisional response would still be282 * delivered to transaction user and it will still283 * affect the transaction state. The \a flag flag only284 * changes the behavior of the timeout timer of the285 * transaction.286 */287 PJ_DECL(pj_status_t) pjsip_tsx_set_uac_timeout(pjsip_transaction *tsx,288 unsigned msec_time,289 pjsip_tsx_timeout_policy flag);290 291 292 233 /** 293 234 * Call this function to manually feed a message to the transaction.
Note: See TracChangeset
for help on using the changeset viewer.