svn commit: r1225894 - /jmeter/trunk/src/functions/org/apache/jmeter/functions/package.html

[pm...@apache.org]

Author: pmouawad
Date: Fri Dec 30 18:51:47 2011
New Revision: 1225894

URL: http://svn.apache.org/viewvc?rev=1225894&view=rev
Log:
put revisions back to package.html

Added:
    jmeter/trunk/src/functions/org/apache/jmeter/functions/package.html

Added: jmeter/trunk/src/functions/org/apache/jmeter/functions/package.html
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/functions/org/apache/jmeter/functions/package.html?rev=1225894&view=auto
==============================================================================
--- jmeter/trunk/src/functions/org/apache/jmeter/functions/package.html (added)
+++ jmeter/trunk/src/functions/org/apache/jmeter/functions/package.html Fri Dec 30 18:51:47 2011
@@ -0,0 +1,41 @@
+<html>
+<!--
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * 
+*/
+-->
+<body>
+	<h1>Functions</h1>
+	<h2>Methods to be implemented</h2>
+	setParameters(Collection)
+	
+		<br></br>
+	execute(prevResult,currentSampler)
+	Note that either or both of the parameters may be null.
+	
+	<h2>Calling sequence</h2>
+	When the test plan is prepared for running, one instance of the class is created for each occurrence
+	of a function call.	The setParameters() method is then called on each instance.
+	Once the test is running, the execute method can be called by any thread, and is
+	therefore synchronized.
+	
+	This is unlike most of (all?) the JMeter test elements, which are created for each thread.
+	
+	Any context that needs to be maintained for a thread must be done using ThreadLocal or similar.
+	
+</body>
+</html>
\ No newline at end of file