<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Notification method for a started command</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongodb-driver-monitoring-commandsubscriber.commandfailed.html">MongoDB\Driver\Monitoring\CommandSubscriber::commandFailed</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb-driver-monitoring-commandsubscriber.commandsucceeded.html">MongoDB\Driver\Monitoring\CommandSubscriber::commandSucceeded</a></div>
<div class="up"><a href="class.mongodb-driver-monitoring-commandsubscriber.html">MongoDB\Driver\Monitoring\CommandSubscriber</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="mongodb-driver-monitoring-commandsubscriber.commandstarted" class="refentry">
<div class="refnamediv">
<h1 class="refname">MongoDB\Driver\Monitoring\CommandSubscriber::commandStarted</h1>
<p class="verinfo">(mongodb >=1.3.0)</p><p class="refpurpose"><span class="refname">MongoDB\Driver\Monitoring\CommandSubscriber::commandStarted</span> — <span class="dc-title">Notification method for a started command</span></p>
</div>
<div class="refsect1 description" id="refsect1-mongodb-driver-monitoring-commandsubscriber.commandstarted-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type"><span class="type void">void</span></span> <span class="methodname"><strong>MongoDB\Driver\Monitoring\CommandSubscriber::commandStarted</strong></span>
( <span class="methodparam"><span class="type"><span class="type MongoDB\Driver\Monitoring\CommandStartedEvent">MongoDB\Driver\Monitoring\CommandStartedEvent</span></span> <code class="parameter">$event</code></span>
)</div>
<p class="para rdfs-comment">
If the subscriber has been registered with
<span class="function"><a href="function.mongodb.driver.monitoring.addsubscriber.html" class="function">MongoDB\Driver\Monitoring\addSubscriber()</a></span>, the driver will
call this method when a command has started.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-mongodb-driver-monitoring-commandsubscriber.commandstarted-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">event</code> (<span class="type"><span class="type MongoDB\Driver\Monitoring\CommandStartedEvent">MongoDB\Driver\Monitoring\CommandStartedEvent</span></span>)</dt>
<dd>
<p class="para">
An event object encapsulating information about the started command.
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-mongodb-driver-monitoring-commandsubscriber.commandstarted-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
No value is returned.
</p>
</div>
<div class="refsect1 errors" id="refsect1-mongodb-driver-monitoring-commandsubscriber.commandstarted-errors">
<h3 class="title">Errors/Exceptions</h3>
<ul class="simplelist">
<li class="member">Throws <a href="class.mongodb-driver-exception-invalidargumentexception.html" class="classname">MongoDB\Driver\Exception\InvalidArgumentException</a> on argument parsing errors.</li>
</ul>
</div>
<div class="refsect1 seealso" id="refsect1-mongodb-driver-monitoring-commandsubscriber.commandstarted-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member"><a href="class.mongodb-driver-monitoring-commandstartedevent.html" class="classname">MongoDB\Driver\Monitoring\CommandStartedEvent</a></li>
<li class="member"><span class="function"><a href="function.mongodb.driver.monitoring.addsubscriber.html" class="function" rel="rdfs-seeAlso">MongoDB\Driver\Monitoring\addSubscriber()</a> - Registers a new monitoring event subscriber</span></li>
<li class="member"><a href="mongodb.tutorial.apm.html" class="xref">Application Performance Monitoring (APM)</a></li>
</ul>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongodb-driver-monitoring-commandsubscriber.commandfailed.html">MongoDB\Driver\Monitoring\CommandSubscriber::commandFailed</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb-driver-monitoring-commandsubscriber.commandsucceeded.html">MongoDB\Driver\Monitoring\CommandSubscriber::commandSucceeded</a></div>
<div class="up"><a href="class.mongodb-driver-monitoring-commandsubscriber.html">MongoDB\Driver\Monitoring\CommandSubscriber</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
