Skip to content

Commit 7238723

Browse files
committed
PCBC-536: Make it clear that timeout properties use microseconds
Change-Id: I5deec4e1aec722c4ae96bc20730fc2ad59fce165 Reviewed-on: http://review.couchbase.org/92688 Tested-by: Build Bot <[email protected]> Reviewed-by: Sergey Avseyev <[email protected]>
1 parent 104538c commit 7238723

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

api/couchbase.php

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -515,29 +515,30 @@ public function role($role, $bucket = NULL) {}
515515
* Represents connection to the Couchbase Server
516516
*
517517
* @property int $operationTimeout
518-
* The operation timeout is the maximum amount of time the library will wait
519-
* for an operation to receive a response before invoking its callback with
520-
* a failure status.
518+
* The operation timeout (in microseconds) is the maximum amount of time the
519+
* library will wait for an operation to receive a response before invoking
520+
* its callback with a failure status.
521521
*
522522
* An operation may timeout if:
523523
*
524524
* * A server is taking too long to respond
525525
* * An updated cluster configuration has not been promptly received
526526
*
527527
* @property int $viewTimeout
528-
* The I/O timeout for HTTP requests to Couchbase Views API
528+
* The I/O timeout (in microseconds) for HTTP requests to Couchbase Views API
529529
*
530530
* @property int $n1qlTimeout
531-
* The I/O timeout for N1QL queries.
531+
* The I/O timeout (in microseconds) for N1QL queries.
532532
*
533533
* @property int $httpTimeout
534-
* The I/O timeout for HTTP queries (management API).
534+
* The I/O timeout (in microseconds) for HTTP queries (management API).
535535
*
536536
* @property int $configTimeout
537-
* How long the client will wait to obtain the initial configuration.
537+
* How long (in microseconds) the client will wait to obtain the initial
538+
* configuration.
538539
*
539540
* @property int $configNodeTimeout
540-
* Per-node configuration timeout.
541+
* Per-node configuration timeout (in microseconds).
541542
*
542543
* This timeout sets the amount of time to wait for each node within
543544
* the bootstrap/configuration process. This interval is a subset of
@@ -558,7 +559,7 @@ public function role($role, $bucket = NULL) {}
558559
* timeout setting, then this value is likely optimal.
559560
*
560561
* @property int $htconfigIdleTimeout
561-
* Idling/Persistence for HTTP bootstrap
562+
* Idling/Persistence for HTTP bootstrap (in microseconds)
562563
*
563564
* By default the behavior of the library for HTTP bootstrap is to keep
564565
* the stream open at all times (opening a new stream on a different host
@@ -576,12 +577,13 @@ public function role($role, $bucket = NULL) {}
576577
* the client) then a new stream is not opened.
577578
*
578579
* @property int $durabilityInterval
579-
* The time the client will wait between repeated probes to a given server.
580+
* The time (in microseconds) the client will wait between repeated probes
581+
* to a given server.
580582
*
581583
* @property int $durabilityTimeout
582-
* The time the client will spend sending repeated probes to a given key's
583-
* vBucket masters and replicas before they are deemed not to have satisfied
584-
* the durability requirements
584+
* The time (in microseconds) the client will spend sending repeated probes
585+
* to a given key's vBucket masters and replicas before they are deemed not
586+
* to have satisfied the durability requirements
585587
*
586588
* @see https://developer.couchbase.com/documentation/server/current/sdk/php/start-using-sdk.html
587589
* Start Using SDK

0 commit comments

Comments
 (0)