Set new header option in retry callback

[Steve Barbera]

Is there a way to set a new header option with each retry callback? For example if I receive a 429 rate limiting error and wanted to use a different JWT access token. Can I modify the request object to send a different request?

Example:

        $listener = function($attemptNumber, $delay, &$request, &$options, $response) {
            $request->setHeader('x-token', $this->access_tokens[$attemptNumber]);
        };

Thank you for the assistance.

[Casey McLaughlin]

There certainly is! However, the Request object is immutable, so you have to overwrite the reference inside of your callback function. The following syntax should do what you need:

        $listener = function($attemptNumber, $delay, &$request, &$options, $response) {
            $request = $request->withHeader('x-token', $this->access_tokens[$attemptNumber]);
        };

To see example code of this in action, refer to the testRetryCallbackReferenceModification in the test file.

[Steve Barbera]

Thank you for the helpful reply! It is much appreciated!