/**
 * @author     STF 346, STF366, STF368, STF369, STF450, STF471
 * @version    $Id$
 * @desc        This module provides module parameters used within the SIP
 *             protocol for timers, SDP formats etc.
 *             This module is part of LibSipV3.
 */
module LibSip_PIXITS {
    // LibCommon
    import from LibCommon_BasicTypesAndValues all;
    import from LibCommon_DataStrings all;

    // ____________________________ PIXIT-S_______________________________
    group SIP_PIXITparameters {
        group SDPParameter {

            /**
             * @desc charstring for SDP user name
             */
            modulepar charstring PX_SIP_SDP_USER_NAME := "voicesession";

            /**
             * @desc charstring for SDP session identifier
             */
            modulepar charstring PX_SIP_SDP_SESSION_ID := "30000";

            /**
             * @desc charstring for SDP dynamic port
             */
            modulepar charstring PX_SIP_SDP_DYN := "0";

            /**
             * @desc charstring for SDP bandwidth modifier
             */
            modulepar charstring PX_SIP_SDP_B_MODIFIER := "AS";

            /**
             * @desc integer for SDP bandwidth value
             */
            modulepar integer PX_SIP_SDP_B_BANDWIDTH := 64;

            /**
             * @desc charstring for SDP media attribute encoding supported by the IUT
             */
            modulepar charstring PX_SIP_SDP_ENCODING := "PCMU";

            /**
             * @desc charstring for SDP media attribute encoding clockrate supported by the IUT
             */
            modulepar charstring PX_SIP_SDP_CLOCKRATE := "8000";

        } // group SDP Parameter
        group XMLCOnfiguration{
            
            /**
             * @desc boolean for MessageBody length calculation based on encvalue operation result
             */
            modulepar boolean PX_MB_LENGTH_FROM_ENCVAL := true;
            
            /**
             * @desc boolean for MessageBody length calculation to be performed by external function
             */
            modulepar boolean PX_USE_FX_FOR_XML_LENGTH := false;
        }

        group SupportedOptions {

            /**
             * @desc charstring for Used Transport in upper case "UDP"/"TCP"
             */
            modulepar charstring PX_SIP_TRANSPORT := "UDP";


        } // group SupportedOptions{

        group RegistrationParameters {

            /**
             * @desc boolean for the SIP user if it have to register itself before executing a test case
             */
            modulepar boolean PX_SIP_REGISTRATION := false;

            /**
             * @desc charstring for PX_AUTH_ALGORITHM security algorithm Possible values: MD5 or AKAv1-MD5
             */
            modulepar charstring PX_AUTH_ALGORITHM := "AKAv1-MD5";


        } // group Registration parameters
        
        group SwitchToEnableAuthentication {
            /**
             * @desc boolean for option controlling if authentication is enabled/disabled for REGISTER messages
             */
            modulepar boolean PX_SIP_REGISTER_AUTHENTICATION_ENABLED := true;

            /**
             * @desc boolean for option controlling if authentication is enabled/disabled for INVITE messages
             */
            modulepar boolean PX_SIP_INVITE_AUTHENTICATION_ENABLED := false;


        } // group SwitchToEnableAuthentication

        group SIP_Timers {
            /**
             * @desc float for TWait default value for waiting an operator action
             */
            modulepar float PX_SIP_TWAIT := 30.0;

            /**
             * @desc float for TAck default value for waiting an acknowledgement
             */
            modulepar float PX_SIP_TACK := 8.0;

            /**
             * @desc float for TResp default value for waiting for a response from the IUT
             */
            modulepar float PX_SIP_TRESP := 15.0;

            /**
             * @desc float for TNoAct default value for waiting no message from the IUT Value given for PX_TNOACT should be less than value of SHORT_REGISTRATION constant (which is currently "3" (seconds))
             */
            modulepar float PX_SIP_TNOACT := 1.0;

        } // group SIP_Timers

        group MimePart {
            /**
             * @desc charstring for delimiter value used in mime multipart message to separate message body parts
             */
            modulepar charstring PX_SIP_MIME_BOUNDARY := "boundary1";

        } // group MimePart

    } // group SIP_PIXITparameters

    /**
     * @desc Set to true to force fixed random value (debug mode)
     */
    modulepar boolean PX_SEED := false;
    
} // end module LibSip_PIXITS