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."],[[["This webpage details the `GenericPollingPolicy` class, which facilitates the creation of custom polling policies by combining retry and backoff policies."],["The latest version of the `GenericPollingPolicy` is `2.37.0-rc`, and the page provides documentation for various versions spanning from `2.10.1` to `2.37.0-rc`."],["The `GenericPollingPolicy` class offers functions like `clone()`, `OnFailure(Status const &)`, and `WaitPeriod()` to manage polling behavior and error handling."],["The `GenericPollingPolicy` constructor accepts `Retry` and `Backoff` policy parameters, allowing users to define how the class will retry on failures and for how long it will wait in between."],["The `OnFailure` callback determines if a failure is transient and, therefore, if the polling loop should continue."]]],[]]
