Skip to content

Add usage documentation about maximum lag and retries #134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
waldyrious merged 1 commit into from
Aug 29, 2021
Merged

Add usage documentation about maximum lag and retries #134

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ and [Keep a Changelog](http://keepachangelog.com/).

### Upcoming version

#### Added

* Usage documentation about maximum lag and retries ([#134])

#### Changed

* Added additional context to README.md ([#127])
Expand Down Expand Up @@ -186,3 +190,4 @@ and may require changes in applications that invoke these methods:_
[#131]: https://github.com/hamstar/Wikimate/pull/131
[#132]: https://github.com/hamstar/Wikimate/pull/132
[#133]: https://github.com/hamstar/Wikimate/pull/133
[#134]: https://github.com/hamstar/Wikimate/pull/134
13 changes: 13 additions & 0 deletions USAGE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
- [Other stuff](#other-stuff)
* [Running custom queries](#running-custom-queries)
* [Customizing the user agent](#customizing-the-user-agent)
* [Maximum lag and retries](#maximum-lag-and-retries)
* [Handling errors](#handling-errors)

### Introduction
Expand Down Expand Up @@ -354,6 +355,18 @@ $wiki->setUserAgent('Custom Prefix - ' . $useragent);
In order to use a custom user agent for all requests in the session,
call this method before invoking `Wikimate::login()`.

#### Maximum lag and retries

API requests include the [maxlag parameter](https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Maxlag_parameter)
so they time out when the server's time to respond exceeds the specified lag.
The default lag is 5 seconds, which can be obtained via `$wiki->getMaxlag()`
and changed via `$wiki->setMaxlag()`.
Upon a lag error response,
the request is [paused](https://www.php.net/manual/en/function.sleep)
for the number of seconds recommended by the server, and then retried.
Retries continue indefinitely, unless limited via `$wiki->setMaxretries()`.
If a limited number of retries runs out, `WikimateException` is thrown.

#### Handling errors

Did something go wrong? Check the error array:
Expand Down