Overview

Namespaces

  • Guzzle
    • Batch
      • Exception
    • Cache
    • Common
      • Exception
    • Http
      • Curl
      • Exception
      • Message
        • Header
      • 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
    • Tests
      • Batch
      • Cache
      • Common
        • Cache
        • Exception
      • Http
        • Curl
        • Exception
        • Message
          • Header
      • Inflection
      • Iterator
      • Log
      • Message
      • Mock
      • Parser
        • Cookie
        • Message
      • Parsers
        • UriTemplate
      • Plugin
        • Async
        • Backoff
        • Cache
        • Cookie
          • CookieJar
        • CurlAuth
        • ErrorResponse
        • History
        • Log
        • Md5
        • Mock
        • Oauth
        • Redirect
      • Service
        • Builder
        • Command
          • LocationVisitor
            • Request
            • Response
        • Description
        • Exception
        • Mock
          • Command
            • Sub
          • Model
        • Resource
      • Stream
  • None
  • Omnipay
    • Common
      • Exception
      • Message
    • Dummy
      • Message
    • Fatzebra
      • Message
  • PHP

Classes

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

Interfaces

  • BackoffStrategyInterface
  • Overview
  • Namespace
  • Class
  • Tree

Class BackoffPlugin

Plugin to automatically retry failed HTTP requests using a backoff strategy

Guzzle\Common\AbstractHasDispatcher implements Guzzle\Common\HasDispatcherInterface
Extended by Guzzle\Plugin\Backoff\BackoffPlugin implements Symfony\Component\EventDispatcher\EventSubscriberInterface
Namespace: Guzzle\Plugin\Backoff
Located at src/Guzzle/Plugin/Backoff/BackoffPlugin.php
Methods summary
public
# __construct( Guzzle\Plugin\Backoff\BackoffStrategyInterface $strategy = null )

Parameters

$strategy

The backoff strategy used to determine whether or not to retry and the amount of delay between retries.

public static Guzzle\Plugin\Backoff\BackoffPlugin
# getExponentialBackoff( integer $maxRetries = 3, array $httpCodes = null, array $curlCodes = null )

Retrieve a basic truncated exponential backoff plugin that will retry HTTP errors and cURL errors

Retrieve a basic truncated exponential backoff plugin that will retry HTTP errors and cURL errors

Parameters

$maxRetries
Maximum number of retries
$httpCodes
HTTP response codes to retry
$curlCodes
cURL error codes to retry

Returns

Guzzle\Plugin\Backoff\BackoffPlugin
public static array
# getAllEvents( )

Get a list of all of the events emitted from the class

Get a list of all of the events emitted from the class

Returns

array

Overrides

Guzzle\Common\AbstractHasDispatcher::getAllEvents()
public static
# getSubscribedEvents( )
public
# onRequestSent( Guzzle\Common\Event $event )

Called when a request has been sent and isn't finished processing

Called when a request has been sent and isn't finished processing

Parameters

$event
public
# onRequestPoll( Guzzle\Common\Event $event )

Called when a request is polling in the curl multi object

Called when a request is polling in the curl multi object

Parameters

$event
Methods inherited from Guzzle\Common\AbstractHasDispatcher
addSubscriber(), dispatch(), getEventDispatcher(), setEventDispatcher()
Constants summary
string DELAY_PARAM
# Guzzle\Plugin\Backoff\CurlMultiInterface::BLOCKING
string RETRY_PARAM
# 'plugins.backoff.retry_count'
string RETRY_EVENT
# 'plugins.backoff.retry'
Properties summary
protected Guzzle\Plugin\Backoff\BackoffStrategyInterface $strategy

Backoff strategy

Backoff strategy

#
Properties inherited from Guzzle\Common\AbstractHasDispatcher
$eventDispatcher
Omnipay Fat Zebra / Paystream Gateway Module API Documentation API documentation generated by ApiGen