Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]

The exponential-backoff Reference Manual

This is the exponential-backoff Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Nov 06 13:16:50 2023 GMT+0.

Next: Systems, Previous: The exponential-backoff Reference Manual, Up: The exponential-backoff Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The exponential-backoff Reference Manual [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.

exponential-backoff

Previous: Systems, Up: Systems [Contents][Index]

2.1 `exponential-backoff`

An implementation of the exponential backoff algorithm

Author: death
License: MIT
Source: exponential-backoff.asd.
Child Component: exponential-backoff.lisp (file).

Next: Packages, Previous: Systems, Up: The exponential-backoff Reference Manual [Contents][Index]

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

Lisp

Previous: Files, Up: Files [Contents][Index]

3.1 Lisp

exponential-backoff/exponential-backoff.asd
exponential-backoff/exponential-backoff.lisp

Next: exponential-backoff/exponential-backoff.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `exponential-backoff/exponential-backoff.asd`

Source: exponential-backoff.asd.
Parent Component: exponential-backoff (system).
ASDF Systems: exponential-backoff.

Previous: exponential-backoff/exponential-backoff.asd, Up: Lisp [Contents][Index]

3.1.2 `exponential-backoff/exponential-backoff.lisp`

Source

exponential-backoff.asd.

Parent Component

exponential-backoff (system).

Packages

exponential-backoff.

Public Interface

exponential-backoff (function).
inform (function).
reset (function).
time-until-release (function).
with-exponential-backoff (macro).

Internals

call-with-exponential-backoff (function).
now (function).
release-time (function).

Next: Definitions, Previous: Files, Up: The exponential-backoff Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

exponential-backoff

Previous: Packages, Up: Packages [Contents][Index]

4.1 `exponential-backoff`

Source

exponential-backoff.lisp.

Use List

common-lisp.

Public Interface

exponential-backoff (function).
inform (function).
reset (function).
time-until-release (function).
with-exponential-backoff (macro).

Internals

call-with-exponential-backoff (function).
now (function).
release-time (function).

Next: Indexes, Previous: Packages, Up: The exponential-backoff Reference Manual [Contents][Index]

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

Public Interface
Internals

Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]

Next: Ordinary functions, Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Macros

Macro: with-exponential-backoff ((backoff &rest options &key sleep-function max-retries reset) &body forms) ¶

Package: exponential-backoff.
Source: exponential-backoff.lisp.

Previous: Macros, Up: Public Interface [Contents][Index]

5.1.2 Ordinary functions

Function: exponential-backoff (&key num-failures-to-ignore initial-delay-ms multiply-factor jitter-factor max-backoff-ms always-use-initial-delay) ¶

Package: exponential-backoff.
Source: exponential-backoff.lisp.

Function: inform (backoff succeeded) ¶

Package: exponential-backoff.
Source: exponential-backoff.lisp.

Function: reset (backoff) ¶

Package: exponential-backoff.
Source: exponential-backoff.lisp.

Function: time-until-release (backoff) ¶

Package: exponential-backoff.
Source: exponential-backoff.lisp.

Previous: Public Interface, Up: Definitions [Contents][Index]

5.2 Internals

Ordinary functions

Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Ordinary functions

Function: call-with-exponential-backoff (fn backoff &key sleep-function max-retries reset) ¶

Package: exponential-backoff.
Source: exponential-backoff.lisp.

Function: now () ¶

Package: exponential-backoff.
Source: exponential-backoff.lisp.

Function: release-time (backoff) ¶

Package: exponential-backoff.
Source: exponential-backoff.lisp.

Previous: Definitions, Up: The exponential-backoff Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

Next: Functions, Previous: Indexes, Up: Indexes [Contents][Index]

A.1 Concepts

Next: Variables, Previous: Concepts, Up: Indexes [Contents][Index]

A.2 Functions

Jump to:	C E F I M N R T W

	Index Entry	Section

C
	`call-with-exponential-backoff`:	Private ordinary functions

E
	`exponential-backoff`:	Public ordinary functions

F
	`Function, call-with-exponential-backoff`:	Private ordinary functions
	`Function, exponential-backoff`:	Public ordinary functions
	`Function, inform`:	Public ordinary functions
	`Function, now`:	Private ordinary functions
	`Function, release-time`:	Private ordinary functions
	`Function, reset`:	Public ordinary functions
	`Function, time-until-release`:	Public ordinary functions

I
	`inform`:	Public ordinary functions

M
	`Macro, with-exponential-backoff`:	Public macros

N
	`now`:	Private ordinary functions

R
	`release-time`:	Private ordinary functions
	`reset`:	Public ordinary functions

T
	`time-until-release`:	Public ordinary functions

W
	`with-exponential-backoff`:	Public macros

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Previous: Variables, Up: Indexes [Contents][Index]

A.4 Data types

Jump to:	E F P S

	Index Entry	Section

E
	`exponential-backoff`:	The exponential-backoff system
	`exponential-backoff`:	The exponential-backoff package
	`exponential-backoff.asd`:	The exponential-backoff/exponential-backoff․asd file
	`exponential-backoff.lisp`:	The exponential-backoff/exponential-backoff․lisp file

F
	`File, exponential-backoff.asd`:	The exponential-backoff/exponential-backoff․asd file
	`File, exponential-backoff.lisp`:	The exponential-backoff/exponential-backoff․lisp file

P
	`Package, exponential-backoff`:	The exponential-backoff package

S
	`System, exponential-backoff`:	The exponential-backoff system