Overview

Namespaces

  • Contrib
    • Bundle
      • CoverallsBundle
        • Console
        • Entity
      • CoverallsV1Bundle
        • Api
        • Collector
        • Command
        • Config
        • Entity
          • Git
    • Component
      • File
      • Log
      • System
        • Git
  • Guzzle
    • Batch
      • Exception
    • Cache
    • Common
      • Exception
    • Http
      • Curl
      • Exception
      • Message
      • QueryAggregator
    • Inflection
    • Iterator
    • Log
    • Parser
      • Cookie
      • Message
      • UriTemplate
      • Url
    • Plugin
      • Async
      • Backoff
      • Cache
      • Cookie
        • CookieJar
        • Exception
      • CurlAuth
      • ErrorResponse
        • Exception
      • History
      • Log
      • Md5
      • Mock
      • Oauth
    • Service
      • Builder
      • Command
        • Factory
        • LocationVisitor
          • Request
          • Response
      • Description
      • Exception
      • Resource
    • Stream
  • PHP
  • Psr
    • Log
  • Symfony
    • Component
      • Config
        • Definition
          • Builder
          • Exception
        • Exception
        • Loader
        • Resource
        • Util
      • Console
        • Command
        • Formatter
        • Helper
        • Input
        • Output
        • Tester
      • EventDispatcher
        • Debug
      • Finder
        • Adapter
        • Comparator
        • Exception
        • Expression
        • Iterator
        • Shell
      • Stopwatch
      • Yaml
        • Exception

Classes

  • AbstractBackoffStrategy
  • AbstractErrorCodeBackoffStrategy
  • BackoffLogger
  • BackoffPlugin
  • CallbackBackoffStrategy
  • ConstantBackoffStrategy
  • CurlBackoffStrategy
  • ExponentialBackoffStrategy
  • HttpBackoffStrategy
  • LinearBackoffStrategy
  • ReasonPhraseBackoffStrategy
  • TruncatedBackoffStrategy

Interfaces

  • BackoffStrategyInterface
  • Overview
  • Namespace
  • Class
  • Tree
  • Todo

Class AbstractBackoffStrategy

Abstract backoff strategy that allows for a chain of responsibility

Guzzle\Plugin\Backoff\AbstractBackoffStrategy implements Guzzle\Plugin\Backoff\BackoffStrategyInterface

Direct known subclasses

Guzzle\Plugin\Backoff\AbstractErrorCodeBackoffStrategy, Guzzle\Plugin\Backoff\CallbackBackoffStrategy, Guzzle\Plugin\Backoff\ConstantBackoffStrategy, Guzzle\Plugin\Backoff\ExponentialBackoffStrategy, Guzzle\Plugin\Backoff\LinearBackoffStrategy, Guzzle\Plugin\Backoff\TruncatedBackoffStrategy

Indirect known subclasses

Guzzle\Plugin\Backoff\CurlBackoffStrategy, Guzzle\Plugin\Backoff\HttpBackoffStrategy, Guzzle\Plugin\Backoff\ReasonPhraseBackoffStrategy
Abstract
Namespace: Guzzle\Plugin\Backoff
Located at Guzzle/Plugin/Backoff/AbstractBackoffStrategy.php
Methods summary
public
# setNext( Guzzle\Plugin\Backoff\AbstractBackoffStrategy $next )

Parameters

$next
Guzzle\Plugin\Backoff\AbstractBackoffStrategy
$next Next strategy in the chain
public Guzzle\Plugin\Backoff\AbstractBackoffStrategy|null
# getNext( )

Get the next backoff strategy in the chain

Get the next backoff strategy in the chain

Returns

Guzzle\Plugin\Backoff\AbstractBackoffStrategy|null
public boolean|integer
# getBackoffPeriod( integer $retries, Guzzle\Http\Message\RequestInterface $request, Guzzle\Http\Message\Response $response = null, Guzzle\Http\Exception\HttpException $e = null )

Get the amount of time to delay in seconds before retrying a request

Get the amount of time to delay in seconds before retrying a request

Parameters

$retries
integer
$retries Number of retries of the request
$request
Guzzle\Http\Message\RequestInterface
$request Request that was sent
$response
Guzzle\Http\Message\Response
$response Response that was received. Note that there may not be a response
$e
Guzzle\Http\Exception\HttpException
$e Exception that was encountered if any

Returns

boolean|integer
Returns false to not retry or the number of seconds to delay between retries

Implementation of

Guzzle\Plugin\Backoff\BackoffStrategyInterface::getBackoffPeriod()
abstract public boolean
# makesDecision( )

Check if the strategy does filtering and makes decisions on whether or not to retry.

Check if the strategy does filtering and makes decisions on whether or not to retry.

Strategies that return false will never retry if all of the previous strategies in a chain defer on a backoff decision.

Returns

boolean
abstract protected boolean|integer|null
# getDelay( integer $retries, Guzzle\Http\Message\RequestInterface $request, Guzzle\Http\Message\Response $response = null, Guzzle\Http\Exception\HttpException $e = null )

Implement the concrete strategy

Implement the concrete strategy

Parameters

$retries
integer
$retries Number of retries of the request
$request
Guzzle\Http\Message\RequestInterface
$request Request that was sent
$response
Guzzle\Http\Message\Response
$response Response that was received. Note that there may not be a response
$e
Guzzle\Http\Exception\HttpException
$e Exception that was encountered if any

Returns

boolean|integer|null
Returns false to not retry or the number of seconds to delay between retries. Return true or null to defer to the next strategy if available, and if not, return 0.
Properties summary
protected Guzzle\Plugin\Backoff\AbstractBackoffStrategy $next
#

Next strategy in the chain

Next strategy in the chain

php-coveralls API documentation generated by ApiGen 2.8.0