Commit 17ecb1fd authored by bergengruen's avatar bergengruen
Browse files

Description of our main function f_imsIot_receive added

parent d9d9dab5
Loading
Loading
Loading
Loading
+8 −8
Original line number Diff line number Diff line
@@ -36,17 +36,17 @@ module AtsImsIot_Behavior {
	group general_td_functions {
	 	
		/**
		 * @desc Generic function for reading and verifying messages from the interface
		 * @desc Generic function for reading and verifying messages on the interface
         *    associated to the ImsInterfaceMonitor instance.
         *    This functions works as follows:
         *    First, messages are skipped according to the p_skip template. The p_skip template
         *    template contains a message template and a counter indicating the number of received
         *    contains a message template and a counter indicating the number of received
         *    messages matching the message template to be skipped. If not enough messages matching
         *    the message template arrive at the interface, the function fails after timout.
         *    Next, messages are consumed from the interface and matched against the 
         *    p_passCriteria template list and the p_failCriteria template list.
         *    The function terminates with pass if a message is received matching the
         *    a pass-template and terminates with fail if a fail-template is matched.
         *    The function terminates with pass if a message is received matching a
         *    pass-template and terminates with fail if a fail-template matches.
         *    Matching against pass-templates occurs bevor matching agains fail-templates.
         *    If neither pass-templates nor fail-templates match, then the functions continues
         *    reading from the interface until a match arises, or timeout. 
@@ -54,13 +54,13 @@ module AtsImsIot_Behavior {
         *    Finally, if p_forwardMtc is set to true, the last received message
         *    is stored to be fetched and used later by the main test component.
         *    Some special use cases: 
         *     - Set p_skip.skipCounter = 0  to avoid skipping, i.e. no skippin
         *     - Set p_skip.skipCounter = 0 and p_skip.skipMessage to ? to skip
         *     - Set p_skip.skipCounter to 0 to avoid skipping, i.e. no skippin
         *     - Set p_skip.skipCounter to 0 and p_skip.skipMessage to ? to skip
         *       exactly one message of any type will be skipped.
         *     - If the list of fail-templates is empty, then the function will
         *       wait for the first message maching a pass-message, or fail after timeout.
		 * @param p_passCriteria templates which lead to pass
		 * @param p_failCriteria templates which lead to fail
		 * @param p_passCriteria list of message templates which lead to pass
		 * @param p_failCriteria list of message templates which lead to fail
		 * @param p_skip  
		 *     Indicate how many messages from a specific sip template should be skipped prior to checking
		 * @param p_tpId The Test Purpose identifier