/***********************************************************************
        Copyright (c) 2002 RADVISION Ltd.
************************************************************************
NOTICE:
This document contains information that is confidential and proprietary
to RADVISION Ltd.. No part of this document may be reproduced in any
form whatsoever without written prior approval by RADVISION Ltd..

RADVISION Ltd. reserve the right to revise this publication and make
changes without obligation to notify any person of such revisions or
changes.
***********************************************************************/

#ifndef _TRANSSTATES_H
#define _TRANSSTATES_H

#include "transportint.h"

#ifdef __cplusplus
extern "C" {
#endif


/**************************************************************************************
 * setMultiplexedParams
 *
 * putrpose: to set the multiplexed parameters into an outgoing message. The parameters
 *           are taken from the host parameters which are constatntly updated by incoming
 *           messages and user API calls.
 *
 * Input: transGlobals - The global data of the module.
 *        session      - the session from which the message is sent.
 *        host         - the host on which the message is to be sent.
 *        pvtNode      - the message into which the parameters are to be set.
 *        msgType      - which message we are dealing with.
 *
 ***************************************************************************************/
void setMultiplexedParams(cmTransGlobals *transGlobals,
                          cmTransSession *session,
                          cmTransHost *host,
                          int pvtNode,
                          int msgType);

/**************************************************************************************
 * setTheFastStartStateByMessage
 *
 * putrpose: to determine the faststart state of the session according to its previous
 *           state and the data within the outgoing message. This routine handles all
 *           outgoing messages (setup for outgoing calls and all the rest for incoming
 *           calls. The routine modifies the session state variables!
 *
 * Input: transGlobals      - The global data of the module.
 *        session           - the session on which the message is to be sent.
 *        messageBodyNode   - the UU-IE part of the message to be inspected.
 *        msgType           - The type of the message (setup or other)
 *
 ***************************************************************************************/
void setTheFastStartStateByMessage(cmTransGlobals *transGlobals,
                                   cmTransSession *session,
                                   int            messageBodyNode,
                                   int            msgType);

/**************************************************************************************
 * setTheTunnelingStateByMessage
 *
 * putrpose: to determine the tunneling state of the session according to its previous
 *           state and the data within the outgoing message. This routine handles all
 *           outgoing messages (setup for outgoing calls and all the rest for incoming
 *           calls. The routine modifies the session state variables!
 *
 * Input: transGlobals      - The global data of the module.
 *        session           - the session on which the message is to be sent.
 *        messageBodyNode   - the UU-IE part of the message to be inspected.
 *        msgType           - The type of the message (setup or other)
 *
 ***************************************************************************************/
void setTheTunnelingStateByMessage(cmTransGlobals *transGlobals,
                                   cmTransSession *session,
                                   int            messageBodyNode,
                                   int            msgType);

/**************************************************************************************
 * setTheParallelTunnelingStateByMessage
 *
 * putrpose: to determine the parallel tunneling state of the session according to its previous
 *           state and the faststart and tunneling states of the session.
 *           This routine handles all outgoing messages (setup for outgoing calls and all
 *           the rest for incoming calls. The routine modifies the session state variables!
 *
 * Input: transGlobals      - The global data of the module.
 *        session           - the session on which the message is to be sent.
 *        msgType           - The type of the message (setup or other)
 *        msgBody           - the node to the message UU-IE part
 *        outgoing          - RV_TRUE: an outgoing message; RV_FALSE - an incoming message.
 *
 ***************************************************************************************/
void setTheParallelTunnelingStateByMessage(cmTransGlobals *transGlobals,
                                           cmTransSession *session,
                                           int            msgType,
                                           int            msgBody,
                                           RvBool         outgoing);

/**************************************************************************************
 * needToOpenH245
 *
 * putrpose: to determine according to the session params whether
 *           we shall want to open an H.245 (actually doing the connect).
 * Input: session           - the session on which the message is to be sent.
 *        forceOpen         - we must open (due to a startH245 facility).
 *
 ***************************************************************************************/
RvBool needToOpenH245(cmTransSession *session, RvBool forceOpen);

/**************************************************************************************
 * determineIfToOpenH245
 *
 * putrpose: This routine checks if it's time to start a H.245 connection either by listenning
 *           if we have a H.245 address and it's time according to the H.245 stage to send
 *           that address. If so, the address is sent and the module starts listenning on
 *           that address. Or by trying to connect, if we have the remotes address.
 *
 * Input: outgoing          - RV_TRUE - if an outgoing message, RV_FALSE - if incoming one.
 *        transGlobals      - The global data of the module.
 *        session           - the session on which the message is to be sent.
 *        messageBodyNode   - the UU-IE part of the message to be inspected.
 *        msgType           - The type of the message (setup or other)
 *        manualRAS         - The RAS mode of the application
 *
 ***************************************************************************************/
RvBool determineIfToOpenH245(RvBool         outgoing,
                           cmTransGlobals *transGlobals,
                           cmTransSession *session,
                           int            messageBodyNode,
                           int            msgType);

/**************************************************************************************
 * reportH245
 *
 * putrpose: This routine checks if it is necessary to report to the user that an H.245 is opened.
 *           It bases its decision accrding to the state of the session in regard to tunneling
 *           and parallel tunneling and to the faststart state of the session as well.
 *           If the connection was already reported, we eliminate the notification.
 *           The routine handles both incoming and outgoing messages.
 *
 * Input: outgoing          - RV_TRUE - if an outgoing message, RV_FALSE - if incoming one.
 *        transGlobals      - The global data of the module.
 *        session           - the session on which the message is to be sent.
 *        messageBodyNode   - The body of the message (incoming or outgoing)
 *        msgType           - The type of the message (setup or other)
 *
 ***************************************************************************************/
void reportH245(RvBool          outgoing,
                cmTransGlobals  *transGlobals,
                cmTransSession  *session,
                int             messageBodyNode,
                int             msgType);

/**************************************************************************************
 * insertH245TunnelingFlag
 *