diff options
| author | jwijenbergh <jeroenwijenbergh@protonmail.com> | 2023-03-21 13:41:09 +0100 |
|---|---|---|
| committer | Jeroen Wijenbergh <46386452+jwijenbergh@users.noreply.github.com> | 2023-09-25 09:43:37 +0200 |
| commit | feba8394f9e44c75659e34f7f78124508155264f (patch) | |
| tree | 99c0c387c49cce4bec7a84a00cb2e9809d0097e1 /docs/src | |
| parent | 8dc01bd1b8e70a72d43439bf1391daa9009c6829 (diff) | |
Doc: Update for expiry times and errors
Diffstat (limited to 'docs/src')
| -rw-r--r-- | docs/src/api/overview/README.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/src/api/overview/README.md b/docs/src/api/overview/README.md index ec91df8..338ffd7 100644 --- a/docs/src/api/overview/README.md +++ b/docs/src/api/overview/README.md @@ -13,6 +13,7 @@ This chapter defines the API that is used to build an eduVPN/Let's Connect! clie - [List of servers](#list-of-servers) - [Current server](#current-server) - [Get VPN config](#get-vpn-config) + - [Expiry Times](#expiry-times) - [Set Profile ID](#set-profile-id) - [Set Secure Location](#set-profile-id) - [Discovery Servers](#discovery-servers) @@ -54,6 +55,8 @@ If we for example have an enumeration, e.g. `types.protocol.Protocol`, this is c You can also see this when reading the source code. In Go this was denoted with the `iota` keyword, meaning start at 0 and increment on following const declarations. +### Errors +Errors are encoded as error messages (`*C.char`) in the CGO API. For regular Go, this is just `error`. Errors are *hard-fail* unless otherwise defined. ### States @@ -199,6 +202,16 @@ Return type: - The VPN configuration with associated data (`types.server.Configuration`). Note that this also contains Tokens that can be saved by the client. - An error +### Expiry Times +To get the different times regarding expiry, the function `expiry times` is used. + +Arguments: +- None + +Return type: +- The expiry times (`types.server.Expiry`) +- An error + ### Set Profile ID Set the profile ID for the current server. To be used as a reply to `Ask_Location` or just to change the current profile before getting a configuration |