<!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>Create a new WriteConcern</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongodb-driver-writeconcern.bsonserialize.html">MongoDB\Driver\WriteConcern::bsonSerialize</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb-driver-writeconcern.getjournal.html">MongoDB\Driver\WriteConcern::getJournal</a></div>
<div class="up"><a href="class.mongodb-driver-writeconcern.html">MongoDB\Driver\WriteConcern</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="mongodb-driver-writeconcern.construct" class="refentry">
<div class="refnamediv">
<h1 class="refname">MongoDB\Driver\WriteConcern::__construct</h1>
<p class="verinfo">(mongodb >=1.0.0)</p><p class="refpurpose"><span class="refname">MongoDB\Driver\WriteConcern::__construct</span> — <span class="dc-title">Create a new WriteConcern</span></p>
</div>
<div class="refsect1 description" id="refsect1-mongodb-driver-writeconcern.construct-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="methodname"><strong>MongoDB\Driver\WriteConcern::__construct</strong></span>
( <span class="methodparam"><span class="type"><span class="type string|integer">string|integer</span></span> <code class="parameter">$w</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$wtimeout</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$journal</code></span>
]] )</div>
<p class="para rdfs-comment">
Constructs a new <a href="class.mongodb-driver-writeconcern.html" class="classname">MongoDB\Driver\WriteConcern</a>, which is
an immutable value object.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-mongodb-driver-writeconcern.construct-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">w</code></dt>
<dd>
<p class="para">
<table class="doctable table">
<caption><strong>Write concern</strong></caption>
<thead>
<tr>
<th>Value</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>1</td>
<td>
Requests acknowledgement that the write operation has propagated to
the standalone <em>mongod</em> or the primary in a replica
set. This is the default write concern for MongoDB.
</td>
</tr>
<tr>
<td>0</td>
<td>
Requests no acknowledgment of the write operation. However, this may
return information about socket exceptions and networking errors to
the application.
</td>
</tr>
<tr>
<td><integer greater than 1></td>
<td>
Numbers greater than 1 are valid only for replica sets to request
acknowledgement from specified number of members, including the
primary.
</td>
</tr>
<tr>
<td><strong><code>MongoDB\Driver\WriteConcern::MAJORITY</code></strong></td>
<td>
<p class="para">
Requests acknowledgment that write operations have propagated to the
majority of voting nodes, including the primary, and have been
written to the on-disk journal for these nodes.
</p>
<p class="para">
Prior to MongoDB 3.0, this refers to the majority of replica set
members (not just voting nodes).
</p>
</td>
</tr>
<tr>
<td>string</td>
<td>
A string value is interpereted as a tag set. Requests acknowledgement
that the write operations have propagated to a replica set member
with the specified tag.
</td>
</tr>
</tbody>
</table>
</p>
</dd>
<dt>
<code class="parameter">wtimeout</code></dt>
<dd>
<p class="para">
How long to wait (in milliseconds) for secondaries before failing.
</p>
<p class="para">
<em>wtimeout</em> causes write operations to return with an
error (<strong class="classname">WriteConcernError</strong>) after the specified
limit, even if the required write concern will eventually succeed. When
these write operations return, MongoDB does not undo successful data
modifications performed before the write concern exceeded the
<em>wtimeout</em> time limit.
</p>
<p class="para">
If specified, <em>wtimeout</em> must be a signed 32-bit integer
greater than or equal to zero.
</p>
<p class="para">
<table class="doctable table">
<caption><strong>Write concern timeout</strong></caption>
<thead>
<tr>
<th>Value</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>0</td>
<td>Block indefinitely. This is the default.</td>
</tr>
<tr>
<td><integer greater than 0></td>
<td>
Milliseconds to wait until returning.
</td>
</tr>
</tbody>
</table>
</p>
</dd>
<dt>
<code class="parameter">journal</code></dt>
<dd>
<p class="para">
Wait until mongod has applied the write to the journal.
</p>
</dd>
</dl>
</div>
<div class="refsect1 errors" id="refsect1-mongodb-driver-writeconcern.construct-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>
<li class="member">Throws <a href="class.mongodb-driver-exception-invalidargumentexception.html" class="classname">MongoDB\Driver\Exception\InvalidArgumentException</a> if <code class="parameter">w</code> is invalid or <code class="parameter">wtimeout</code> is either negative or greater than the bounds of a signed 32-bit integer.</li>
</ul>
</div>
<div class="refsect1 examples" id="refsect1-mongodb-driver-writeconcern.construct-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-1705">
<p><strong>Example #1 <span class="function"><strong>MongoDB\Driver\WriteConcern::__construct()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #FF8000">/* Request write acknowledgement from the majority of the replica set nodes */<br /></span><span style="color: #0000BB">$wc </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">Driver</span><span style="color: #007700">\</span><span style="color: #0000BB">WriteConcern</span><span style="color: #007700">(</span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">Driver</span><span style="color: #007700">\</span><span style="color: #0000BB">WriteConcern</span><span style="color: #007700">::</span><span style="color: #0000BB">MAJORITY</span><span style="color: #007700">, </span><span style="color: #0000BB">500</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* Request write acknowledgement from a node configured with the "MultipleDC" tag */<br /></span><span style="color: #0000BB">$wc </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">Driver</span><span style="color: #007700">\</span><span style="color: #0000BB">WriteConcern</span><span style="color: #007700">(</span><span style="color: #DD0000">"MultipleDC"</span><span style="color: #007700">, </span><span style="color: #0000BB">500</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-mongodb-driver-writeconcern.construct-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member"><a href="https://docs.mongodb.com/manual/reference/write-concern/" class="link external">» Write Concern reference</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-writeconcern.bsonserialize.html">MongoDB\Driver\WriteConcern::bsonSerialize</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb-driver-writeconcern.getjournal.html">MongoDB\Driver\WriteConcern::getJournal</a></div>
<div class="up"><a href="class.mongodb-driver-writeconcern.html">MongoDB\Driver\WriteConcern</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
