sip_xaction.h revision 40cb5e5daa7b80bb70fcf8dadfb20f9281566331
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi/*
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi * CDDL HEADER START
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi *
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi * The contents of this file are subject to the terms of the
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi * Common Development and Distribution License (the "License").
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi * You may not use this file except in compliance with the License.
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi *
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi * or http://www.opensolaris.org/os/licensing.
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi * See the License for the specific language governing permissions
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi * and limitations under the License.
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi *
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi * When distributing Covered Code, include this CDDL HEADER in each
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi * If applicable, add the following below this CDDL HEADER, with the
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi * fields enclosed by brackets "[]" replaced with your own identifying
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi * information: Portions Copyright [yyyy] [name of copyright owner]
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi *
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi * CDDL HEADER END
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi */
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi/*
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi * Use is subject to license terms.
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi */
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi#ifndef _SIP_XACTION_H
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi#define _SIP_XACTION_H
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi#pragma ident "%Z%%M% %I% %E% SMI"
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi#ifdef __cplusplus
40cb5e5daa7b80bb70fcf8dadfb20f9281566331viextern "C" {
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi#endif
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi#include <stdio.h>
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi#include <stdlib.h>
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi#include <string.h>
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi/* Various transaction timers */
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vitypedef enum sip_timer_type_s {
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi SIP_XACTION_TIMER_A = 0,
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi SIP_XACTION_TIMER_B,
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi SIP_XACTION_TIMER_D,
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi SIP_XACTION_TIMER_E,
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi SIP_XACTION_TIMER_F,
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi SIP_XACTION_TIMER_G,
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi SIP_XACTION_TIMER_H,
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi SIP_XACTION_TIMER_I,
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi SIP_XACTION_TIMER_J,
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi SIP_XACTION_TIMER_K
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi} sip_xaction_timer_type_t;
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi/* Increment transaction reference count */
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi#define SIP_XACTION_REFCNT_INCR(trans) \
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi (trans)->sip_xaction_ref_cnt++;
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi/* Decrement transaction reference count */
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi#define SIP_XACTION_REFCNT_DECR(trans) { \
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi (void) pthread_mutex_lock(&((trans)->sip_xaction_mutex)); \
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi assert((trans)->sip_xaction_ref_cnt > 0); \
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi (trans)->sip_xaction_ref_cnt--; \
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi if ((trans)->sip_xaction_ref_cnt == 0 && \
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi SIP_IS_XACTION_TERMINATED((trans)->sip_xaction_state)) { \
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi (void) pthread_mutex_unlock(&((trans)->sip_xaction_mutex));\
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi sip_xaction_delete(trans); \
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi } else { \
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi (void) pthread_mutex_unlock(&((trans)->sip_xaction_mutex));\
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi } \
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi}
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi/* True if transaction is in the terminated state */
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi#define SIP_IS_XACTION_TERMINATED(trans_state) \
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi ((trans_state) == SIP_CLNT_INV_TERMINATED || \
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi (trans_state) == SIP_CLNT_NONINV_TERMINATED || \
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi (trans_state) == SIP_SRV_INV_TERMINATED || \
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi (trans_state) == SIP_SRV_NONINV_TERMINATED)
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi/* Transaction structure */
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vitypedef struct sip_xaction {
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi char *sip_xaction_branch_id; /* Transaction id */
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi uint16_t sip_xaction_hash_digest[8];
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi _sip_msg_t *sip_xaction_orig_msg; /* orig request msg. */
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi _sip_msg_t *sip_xaction_last_msg; /* last msg sent */
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi sip_conn_object_t sip_xaction_conn_obj;
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi int sip_xaction_state; /* Transaction State */
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi sip_method_t sip_xaction_method;
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi uint32_t sip_xaction_ref_cnt;
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi pthread_mutex_t sip_xaction_mutex;
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi sip_timer_t sip_xaction_TA;
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi sip_timer_t sip_xaction_TB;
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi sip_timer_t sip_xaction_TD;
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi sip_timer_t sip_xaction_TE;
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi sip_timer_t sip_xaction_TF;
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi sip_timer_t sip_xaction_TG;
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi sip_timer_t sip_xaction_TH;
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi sip_timer_t sip_xaction_TI;
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi sip_timer_t sip_xaction_TJ;
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi sip_timer_t sip_xaction_TK;
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi void *sip_xaction_ctxt; /* currently unused */
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi} sip_xaction_t;
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi
40cb5e5daa7b80bb70fcf8dadfb20f9281566331viextern void sip_xaction_init(int (*ulp_trans_err)(sip_transaction_t,
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi int, void *), void (*ulp_state_cb)
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi (sip_transaction_t, sip_msg_t, int, int));
40cb5e5daa7b80bb70fcf8dadfb20f9281566331viextern int sip_xaction_output(sip_conn_object_t, sip_xaction_t *,
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi _sip_msg_t *);
40cb5e5daa7b80bb70fcf8dadfb20f9281566331viextern int sip_xaction_input(sip_conn_object_t, sip_xaction_t *,
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi _sip_msg_t **);
40cb5e5daa7b80bb70fcf8dadfb20f9281566331viextern sip_xaction_t *sip_xaction_get(sip_conn_object_t, sip_msg_t,
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi boolean_t, int, int *);
40cb5e5daa7b80bb70fcf8dadfb20f9281566331viextern void sip_xaction_delete(sip_xaction_t *);
40cb5e5daa7b80bb70fcf8dadfb20f9281566331viextern char *sip_get_xaction_state(int);
40cb5e5daa7b80bb70fcf8dadfb20f9281566331viextern int (*sip_xaction_ulp_trans_err)(sip_transaction_t, int,
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi void *);
40cb5e5daa7b80bb70fcf8dadfb20f9281566331viextern void (*sip_xaction_ulp_state_cb)(sip_transaction_t,
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi sip_msg_t, int, int);
40cb5e5daa7b80bb70fcf8dadfb20f9281566331viextern void sip_del_conn_obj_cache(sip_conn_object_t, void *);
40cb5e5daa7b80bb70fcf8dadfb20f9281566331viextern int sip_add_conn_obj_cache(sip_conn_object_t, void *);
40cb5e5daa7b80bb70fcf8dadfb20f9281566331viextern void sip_xaction_terminate(sip_xaction_t *, _sip_msg_t *,
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi int);
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi#ifdef __cplusplus
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi}
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi#endif
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi
40cb5e5daa7b80bb70fcf8dadfb20f9281566331vi#endif /* _SIP_XACTION_H */