Class ProjectsLimitedTimeRetryPolicy (2.30.0)

Version 2.30.0

• 2.34.0-rc (latest)
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1

A retry policy for ProjectsConnection based on elapsed time.

This policy stops retrying if:

• An RPC returns a non-transient error.
• The elapsed time in the retry loop exceeds a prescribed duration.

In this class the following status codes are treated as transient errors:

• kUnavailable

Constructors

ProjectsLimitedTimeRetryPolicy(std::chrono::duration< DurationRep, DurationPeriod >)

Constructor given a std::chrono::duration<> object.

See Also

https://en.cppreference.com/w/cpp/chrono/duration for more information about std::chrono::duration.

Parameters
Name	Description
maximum_duration	std::chrono::duration< DurationRep, DurationPeriod > the maximum time allowed before the policy expires. While the application can express this time in any units they desire, the class truncates to milliseconds.
typename DurationRep	a placeholder to match the Rep tparam for duration's type. The semantics of this template parameter are documented in std::chrono::duration<>. In brief, the underlying arithmetic type used to store the number of ticks. For our purposes it is simply a formal parameter.
typename DurationPeriod	a placeholder to match the Period tparam for duration's type. The semantics of this template parameter are documented in std::chrono::duration<>. In brief, the length of the tick in seconds, expressed as a std::ratio<>. For our purposes it is simply a formal parameter.

ProjectsLimitedTimeRetryPolicy(ProjectsLimitedTimeRetryPolicy &&)

Parameter
Name	Description
rhs	ProjectsLimitedTimeRetryPolicy &&

ProjectsLimitedTimeRetryPolicy(ProjectsLimitedTimeRetryPolicy const &)

Parameter
Name	Description
rhs	ProjectsLimitedTimeRetryPolicy const &

Functions

maximum_duration() const

Returns
Type	Description
std::chrono::milliseconds

virtual OnFailure(Status const &)

Parameter
Name	Description
status	Status const &

Returns
Type	Description
bool

virtual IsExhausted() const

Returns
Type	Description
bool

virtual IsPermanentFailure(Status const &) const

Parameter
Name	Description
status	Status const &

Returns
Type	Description
bool

virtual clone() const

Creates a new instance of the policy, reset to the initial state.

Returns
Type	Description
std::unique_ptr< ProjectsRetryPolicy >

Type Aliases

BaseType

Alias Of: ProjectsRetryPolicy