git.m6w6.name Git - mdref/mdref-http/blob - http/Client/getProgressInfo.md

   1 # object http\Client::getProgressInfo(http\Client\Request $request)
   2
   3 Retrieve the progress information for $request.
   4
   5 ## Params:
   6
   7 * http\Client\Request $request
   8   The request to retrieve the current progress information for.
   9
  10 ## Returns:
  11
  12 * object, stdClass instance holding progress information.
  13 * NULL, if $request is not enqueued.
  14
  15 ## Throws:
  16
  17 * http\Exception\InvalidArgumentException
  18 * http\Exception\UnexpectedValueException
  19
  20 ## Example:
  21
  22 The progress info may look like follows:
  23
  24     object(stdClass)#6 (7) {
  25       ["started"]=>
  26       bool(true)
  27       ["finished"]=>
  28       bool(true)
  29       ["info"]=>
  30       string(8) "finished"
  31       ["dltotal"]=>
  32       float(0)
  33       ["dlnow"]=>
  34       float(33561)
  35       ["ultotal"]=>
  36       float(0)
  37       ["ulnow"]=>
  38       float(0)
  39     }