| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>SampleProducer (Apache JMeter dist API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.jmeter.report.processor, interface: SampleProducer"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <div class="about-language"><b>Apache JMeter</b></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.jmeter.report.processor</a></div> |
| <h1 title="Interface SampleProducer" class="title">Interface SampleProducer</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="SampleProcessor.html" title="interface in org.apache.jmeter.report.processor">SampleProcessor</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="graph/AbstractGraphConsumer.html" title="class in org.apache.jmeter.report.processor.graph">AbstractGraphConsumer</a></code>, <code><a href="graph/AbstractOverTimeGraphConsumer.html" title="class in org.apache.jmeter.report.processor.graph">AbstractOverTimeGraphConsumer</a></code>, <code><a href="AbstractSampleConsumer.html" title="class in org.apache.jmeter.report.processor">AbstractSampleConsumer</a></code>, <code><a href="AbstractSummaryConsumer.html" title="class in org.apache.jmeter.report.processor">AbstractSummaryConsumer</a></code>, <code><a href="graph/AbstractVersusRequestsGraphConsumer.html" title="class in org.apache.jmeter.report.processor.graph">AbstractVersusRequestsGraphConsumer</a></code>, <code><a href="graph/impl/ActiveThreadsGraphConsumer.html" title="class in org.apache.jmeter.report.processor.graph.impl">ActiveThreadsGraphConsumer</a></code>, <code><a href="AggregateConsumer.html" title="class in org.apache.jmeter.report.processor">AggregateConsumer</a></code>, <code><a href="ApdexSummaryConsumer.html" title="class in org.apache.jmeter.report.processor">ApdexSummaryConsumer</a></code>, <code><a href="graph/impl/BytesThroughputGraphConsumer.html" title="class in org.apache.jmeter.report.processor.graph.impl">BytesThroughputGraphConsumer</a></code>, <code><a href="graph/impl/CodesPerSecondGraphConsumer.html" title="class in org.apache.jmeter.report.processor.graph.impl">CodesPerSecondGraphConsumer</a></code>, <code><a href="graph/impl/ConnectTimeOverTimeGraphConsumer.html" title="class in org.apache.jmeter.report.processor.graph.impl">ConnectTimeOverTimeGraphConsumer</a></code>, <code><a href="graph/impl/CustomGraphConsumer.html" title="class in org.apache.jmeter.report.processor.graph.impl">CustomGraphConsumer</a></code>, <code><a href="ErrorsSummaryConsumer.html" title="class in org.apache.jmeter.report.processor">ErrorsSummaryConsumer</a></code>, <code><a href="ExternalSampleSorter.html" title="class in org.apache.jmeter.report.processor">ExternalSampleSorter</a></code>, <code><a href="FilterConsumer.html" title="class in org.apache.jmeter.report.processor">FilterConsumer</a></code>, <code><a href="graph/impl/HitsPerSecondGraphConsumer.html" title="class in org.apache.jmeter.report.processor.graph.impl">HitsPerSecondGraphConsumer</a></code>, <code><a href="graph/impl/LatencyOverTimeGraphConsumer.html" title="class in org.apache.jmeter.report.processor.graph.impl">LatencyOverTimeGraphConsumer</a></code>, <code><a href="graph/impl/LatencyVSRequestGraphConsumer.html" title="class in org.apache.jmeter.report.processor.graph.impl">LatencyVSRequestGraphConsumer</a></code>, <code><a href="NormalizerSampleConsumer.html" title="class in org.apache.jmeter.report.processor">NormalizerSampleConsumer</a></code>, <code><a href="RequestsSummaryConsumer.html" title="class in org.apache.jmeter.report.processor">RequestsSummaryConsumer</a></code>, <code><a href="graph/impl/ResponseCustomGraphGraphConsumer.html" title="class in org.apache.jmeter.report.processor.graph.impl">ResponseCustomGraphGraphConsumer</a></code>, <code><a href="graph/impl/ResponseTimeDistributionGraphConsumer.html" title="class in org.apache.jmeter.report.processor.graph.impl">ResponseTimeDistributionGraphConsumer</a></code>, <code><a href="graph/impl/ResponseTimeOverTimeGraphConsumer.html" title="class in org.apache.jmeter.report.processor.graph.impl">ResponseTimeOverTimeGraphConsumer</a></code>, <code><a href="graph/impl/ResponseTimePercentilesGraphConsumer.html" title="class in org.apache.jmeter.report.processor.graph.impl">ResponseTimePercentilesGraphConsumer</a></code>, <code><a href="graph/impl/ResponseTimePercentilesOverTimeGraphConsumer.html" title="class in org.apache.jmeter.report.processor.graph.impl">ResponseTimePercentilesOverTimeGraphConsumer</a></code>, <code><a href="graph/impl/ResponseTimePerSampleGraphConsumer.html" title="class in org.apache.jmeter.report.processor.graph.impl">ResponseTimePerSampleGraphConsumer</a></code>, <code><a href="graph/impl/ResponseTimeVSRequestGraphConsumer.html" title="class in org.apache.jmeter.report.processor.graph.impl">ResponseTimeVSRequestGraphConsumer</a></code>, <code><a href="SampleWriterConsumer.html" title="class in org.apache.jmeter.report.processor">SampleWriterConsumer</a></code>, <code><a href="StatisticsSummaryConsumer.html" title="class in org.apache.jmeter.report.processor">StatisticsSummaryConsumer</a></code>, <code><a href="graph/impl/SyntheticResponseTimeDistributionGraphConsumer.html" title="class in org.apache.jmeter.report.processor.graph.impl">SyntheticResponseTimeDistributionGraphConsumer</a></code>, <code><a href="TaggerConsumer.html" title="class in org.apache.jmeter.report.processor">TaggerConsumer</a></code>, <code><a href="graph/impl/TimeVSThreadGraphConsumer.html" title="class in org.apache.jmeter.report.processor.graph.impl">TimeVSThreadGraphConsumer</a></code>, <code><a href="Top5ErrorsBySamplerConsumer.html" title="class in org.apache.jmeter.report.processor">Top5ErrorsBySamplerConsumer</a></code>, <code><a href="graph/impl/TotalTPSGraphConsumer.html" title="class in org.apache.jmeter.report.processor.graph.impl">TotalTPSGraphConsumer</a></code>, <code><a href="graph/impl/TransactionsPerSecondGraphConsumer.html" title="class in org.apache.jmeter.report.processor.graph.impl">TransactionsPerSecondGraphConsumer</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">SampleProducer</span><span class="extends-implements"> |
| extends <a href="SampleProcessor.html" title="interface in org.apache.jmeter.report.processor">SampleProcessor</a></span></div> |
| <div class="block">Defines a sample producer |
| <p> |
| A sample producer is able to produce sample on different channels. |
| </p> |
| <p> |
| Typically, a <a href="SampleProducer.html" title="interface in org.apache.jmeter.report.processor"><code>SampleProducer</code></a> can be connected to |
| <a href="SampleConsumer.html" title="interface in org.apache.jmeter.report.processor"><code>SampleConsumer</code></a> where it will produced sample that will be consumed by |
| the sample consumer. |
| </p> |
| <p> |
| A sample producer can produce samples of different metadata for reach |
| channel/ |
| </p> |
| <p> |
| The following production sequence must be observed: |
| </p><ul> |
| <li>Call <code>setProducedMetadata()</code> for each produced channel</li> |
| <li>Call <code>startProducing()</code></li> |
| <li>Call <code>produce()</code> for each sample to produce for every channel</li> |
| <li>Call <code>stopProducing()</code></li> |
| </ul></div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>3.0</dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#produce(org.apache.jmeter.report.core.Sample,int)" class="member-name-link">produce</a><wbr>(<a href="../core/Sample.html" title="class in org.apache.jmeter.report.core">Sample</a> s, |
| int channel)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Produce a single sample on the specified channel</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setProducedMetadata(org.apache.jmeter.report.core.SampleMetadata,int)" class="member-name-link">setProducedMetadata</a><wbr>(<a href="../core/SampleMetadata.html" title="class in org.apache.jmeter.report.core">SampleMetadata</a> metadata, |
| int channel)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Set the metadata associated with the specified channel</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#startProducing()" class="member-name-link">startProducing</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Start producing samples, must be invoked before any call to |
| <code>produce()</code></div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#stopProducing()" class="member-name-link">stopProducing</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Stop producing samples, no <code>produce()</code> call should occur after |
| this service has been called.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.jmeter.report.processor.SampleProcessor">Methods inherited from interface org.apache.jmeter.report.processor.<a href="SampleProcessor.html" title="interface in org.apache.jmeter.report.processor">SampleProcessor</a></h3> |
| <code><a href="SampleProcessor.html#getChannelAttribute(int,java.lang.String)">getChannelAttribute</a>, <a href="SampleProcessor.html#getSampleContext()">getSampleContext</a>, <a href="SampleProcessor.html#setChannelAttribute(int,java.lang.String,java.lang.Object)">setChannelAttribute</a>, <a href="SampleProcessor.html#setSampleContext(org.apache.jmeter.report.processor.SampleContext)">setSampleContext</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="setProducedMetadata(org.apache.jmeter.report.core.SampleMetadata,int)"> |
| <h3>setProducedMetadata</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">setProducedMetadata</span><wbr><span class="parameters">(<a href="../core/SampleMetadata.html" title="class in org.apache.jmeter.report.core">SampleMetadata</a> metadata, |
| int channel)</span></div> |
| <div class="block">Set the metadata associated with the specified channel</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>metadata</code> - The metadata to be associated to the specified channel</dd> |
| <dd><code>channel</code> - The channel whoses metadata are being associated with</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="startProducing()"> |
| <h3>startProducing</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">startProducing</span>()</div> |
| <div class="block">Start producing samples, must be invoked before any call to |
| <code>produce()</code></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="produce(org.apache.jmeter.report.core.Sample,int)"> |
| <h3>produce</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">produce</span><wbr><span class="parameters">(<a href="../core/Sample.html" title="class in org.apache.jmeter.report.core">Sample</a> s, |
| int channel)</span></div> |
| <div class="block">Produce a single sample on the specified channel</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>s</code> - The sample produced</dd> |
| <dd><code>channel</code> - The channel on which is produced the sample</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="stopProducing()"> |
| <h3>stopProducing</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">stopProducing</span>()</div> |
| <div class="block">Stop producing samples, no <code>produce()</code> call should occur after |
| this service has been called.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 1998-2022 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
