Construct a polling policy from existing Retry and Backoff policies.
A polling policy can be built by composing a retry and backoff policy. For example, to create a polling policy that "retries N times, waiting a fixed
period between retries" you could compose the "try N times" retry policy with the "wait a fixed period between retries" backoff policy.
This class makes it easier to create such composed polling policies.
Constructors
GenericPollingPolicy(Retry, Backoff)
Parameters
Name
Description
retry_policy
Retry
backoff_policy
Backoff
Functions
virtual clone() const
Return a copy of the current policy.
This function is called at the beginning of the polling loop. Policies that are based on relative time should restart their timers when this function is called.
Returns
Type
Description
std::unique_ptr< PollingPolicy >
virtual OnFailure(Status const &)
A callback to indicate that a polling attempt failed.
This is called when a polling request fails. Note that this callback is not invoked when the polling request succeeds with "operation not done".
Parameter
Name
Description
status
Status const &
Returns
Type
Description
bool
true if the failure should be treated as transient and the polling loop should continue.
virtual WaitPeriod()
How long should the polling loop wait before trying again.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-05 UTC."],[[["The latest version of the `GenericPollingPolicy` class is 2.37.0-rc, with numerous previous versions available for reference, ranging from 2.36.0 down to 2.10.1."],["The `GenericPollingPolicy` class allows users to construct a custom polling policy by combining a retry policy and a backoff policy, enabling tailored behavior such as retrying a certain number of times with a fixed waiting period between retries."],["The class offers functions such as `clone()`, which returns a copy of the policy and is called at the beginning of the polling loop, `OnFailure(Status const &)`, which handles polling attempt failures, and `WaitPeriod()`, which specifies the duration to wait before the next attempt."],["The `GenericPollingPolicy` constructor takes a `Retry` and `Backoff` policy as parameters, allowing for flexible composition of different retry and backoff strategies."]]],[]]
