MongoDB\Driver\WriteConcern::getWtimeout

(mongodb >=1.0.0)

MongoDB\Driver\WriteConcern::getWtimeout — Returns the WriteConcern's "wtimeout" option

Description

final public MongoDB\Driver\WriteConcern::getWtimeout(): int|MongoDB\BSON\Int64

Parameters

This function has no parameters.

Return Values

Returns the WriteConcern's "wtimeout" option.

Errors/Exceptions

Throws MongoDB\Driver\Exception\InvalidArgumentException on argument parsing errors.

Changelog

Version	Description
PECL mongodb 1.7.0	On 32-bit systems, this method will return a MongoDB\BSON\Int64 instance if the WriteConcern object was created with a `wTimeout` that exceeds the 32-bit range. On 64-bit systems, this method will always return an integer value.

Examples

Example #1 MongoDB\Driver\WriteConcern::getWtimeout() example


<?php

$wc = new MongoDB\Driver\WriteConcern(1);
var_dump($wc->getWtimeout());

$wc = new MongoDB\Driver\WriteConcern(MongoDB\Driver\WriteConcern::MAJORITY, 3000);
var_dump($wc->getWtimeout());

?>

The above example will output:

int(0)
int(3000)