-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: support backend property hostcalls (#1002)
- Loading branch information
1 parent
4c2b95f
commit 1d9f91a
Showing
24 changed files
with
1,169 additions
and
60 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
18 changes: 18 additions & 0 deletions
18
documentation/docs/backend/Backend/prototype/betweenBytesTimeout.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
hide_title: false | ||
hide_table_of_contents: false | ||
pagination_next: null | ||
pagination_prev: null | ||
--- | ||
|
||
# Backend.betweenBytesTimeout | ||
|
||
The read-only **`betweenBytesTimeout`** property of a `Backend` instance is an integer number | ||
providing the between bytes timeout for this backend in milliseconds. | ||
|
||
When not set or in environments that do not support this property (such as Viceroy), `null` | ||
may be returned. | ||
|
||
## Value | ||
|
||
A `number` or `null`. |
18 changes: 18 additions & 0 deletions
18
documentation/docs/backend/Backend/prototype/connectTimeout.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
hide_title: false | ||
hide_table_of_contents: false | ||
pagination_next: null | ||
pagination_prev: null | ||
--- | ||
|
||
# Backend.connectTimeout | ||
|
||
The read-only **`connectTimeout`** property of a `Backend` instance is an integer number | ||
providing the connect timeout for this backend in milliseconds. | ||
|
||
When not set or in environments that do not support this property (such as Viceroy), `null` | ||
may be returned. | ||
|
||
## Value | ||
|
||
A `number` or `null`. |
18 changes: 18 additions & 0 deletions
18
documentation/docs/backend/Backend/prototype/firstByteTimeout.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
hide_title: false | ||
hide_table_of_contents: false | ||
pagination_next: null | ||
pagination_prev: null | ||
--- | ||
|
||
# Backend.firstByteTimeout | ||
|
||
The read-only **`firstByteTimeout`** property of a `Backend` instance is an integer number | ||
providing the first byte timeout for this backend in milliseconds. | ||
|
||
When not set or in environments that do not support this property (such as Viceroy), `null` | ||
may be returned. | ||
|
||
## Value | ||
|
||
A `number` or `null`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
hide_title: false | ||
hide_table_of_contents: false | ||
pagination_next: null | ||
pagination_prev: null | ||
--- | ||
|
||
# Backend.prototype.health() | ||
|
||
The **`Backend.prototype.health()`** method returns a string representing the health of the given Backend instance. | ||
|
||
## Syntax | ||
|
||
```js | ||
health() | ||
``` | ||
|
||
### Return value | ||
|
||
A string representing the health of the specified Backend value. | ||
|
||
Possible values are: | ||
- `"healthy"` - The backend's health check has succeeded, indicating the backend is working as expected and should receive requests. | ||
- `"unhealthy"` - The backend's health check has failed, indicating the backend is not working as expected and should not receive requests. | ||
- `"unknown"` - The backend does not have a health check configured. |
15 changes: 15 additions & 0 deletions
15
documentation/docs/backend/Backend/prototype/hostOverride.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
--- | ||
hide_title: false | ||
hide_table_of_contents: false | ||
pagination_next: null | ||
pagination_prev: null | ||
--- | ||
|
||
# Backend.hostOverride | ||
|
||
The read-only **`hostOverride`** property of a `Backend` instance is the host header | ||
override string used when sending requests to this backend. | ||
|
||
## Value | ||
|
||
A `string`. |
15 changes: 15 additions & 0 deletions
15
documentation/docs/backend/Backend/prototype/httpKeepaliveTime.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
--- | ||
hide_title: false | ||
hide_table_of_contents: false | ||
pagination_next: null | ||
pagination_prev: null | ||
--- | ||
|
||
# Backend.httpKeepaliveTime | ||
|
||
The read-only **`httpKeepaliveTime`** property of a `Backend` instance is the HTTP keepalive | ||
time for this backend in milliseconds, or 0 if no keepalive is set. | ||
|
||
## Value | ||
|
||
A `number`. |
15 changes: 15 additions & 0 deletions
15
documentation/docs/backend/Backend/prototype/isDynamic.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
--- | ||
hide_title: false | ||
hide_table_of_contents: false | ||
pagination_next: null | ||
pagination_prev: null | ||
--- | ||
|
||
# Backend.isDynamic | ||
|
||
The read-only **`isDynamic`** property of a `Backend` instance is a boolean | ||
indicating if the backend was dynamically created for this service. | ||
|
||
## Value | ||
|
||
A `boolean`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
--- | ||
hide_title: false | ||
hide_table_of_contents: false | ||
pagination_next: null | ||
pagination_prev: null | ||
--- | ||
|
||
# Backend.isSSL | ||
|
||
The read-only **`isSSL`** property of a `Backend` instance is a boolean | ||
indicating if the backend is using an SSL connection. | ||
|
||
## Value | ||
|
||
A `boolean`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
--- | ||
hide_title: false | ||
hide_table_of_contents: false | ||
pagination_next: null | ||
pagination_prev: null | ||
--- | ||
|
||
# Backend.port | ||
|
||
The read-only **`port`** property of a `Backend` instance is the port number | ||
of this backend. | ||
|
||
## Value | ||
|
||
A `number`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
--- | ||
hide_title: false | ||
hide_table_of_contents: false | ||
pagination_next: null | ||
pagination_prev: null | ||
--- | ||
|
||
# Backend.target | ||
|
||
The read-only **`target`** property of a `Backend` instance is the host string | ||
this backend is configured to use. | ||
|
||
## Value | ||
|
||
A `string`. |
23 changes: 23 additions & 0 deletions
23
documentation/docs/backend/Backend/prototype/tcpKeepalive.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
hide_title: false | ||
hide_table_of_contents: false | ||
pagination_next: null | ||
pagination_prev: null | ||
--- | ||
|
||
# Backend.tcpKeepalive | ||
|
||
The read-only **`tcpKeepalive`** property of a `Backend` instance returns an object providing | ||
the TCP keepalive configuration, if any, otherwise returning `null` if TCP keepalive is not enabled. | ||
|
||
This object has the following properties: | ||
- `timeSecs` _: number or null. | ||
- Configure how long to wait after the last sent data over the TCP connection before starting to send TCP keepalive probes. | ||
- `intervalSecs` _: number or null. | ||
- Configure how long to wait between each TCP keepalive probe sent to the backend to determine if it is still active. | ||
- `probes` _: number or null. | ||
- Number of probes to send to the backend before it is considered dead. | ||
|
||
## Value | ||
|
||
A `Object` or `null`. |
18 changes: 18 additions & 0 deletions
18
documentation/docs/backend/Backend/prototype/tlsMaxVersion.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
hide_title: false | ||
hide_table_of_contents: false | ||
pagination_next: null | ||
pagination_prev: null | ||
--- | ||
|
||
# Backend.tlsMaxVersion | ||
|
||
The read-only **`tlsMaxVersion`** property of a `Backend` instance is the max TLS version | ||
it is configured to use, as a number, either `1.0`, `1.1`, `1.2`, or `1.3`. | ||
|
||
When not used, or for environments that do not support this feature, such as Viceroy, `null` | ||
may be returned. | ||
|
||
## Value | ||
|
||
A `number` or `null`. |
18 changes: 18 additions & 0 deletions
18
documentation/docs/backend/Backend/prototype/tlsMinVersion.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
hide_title: false | ||
hide_table_of_contents: false | ||
pagination_next: null | ||
pagination_prev: null | ||
--- | ||
|
||
# Backend.tlsMinVersion | ||
|
||
The read-only **`tlsMinVersion`** property of a `Backend` instance is the max TLS version | ||
it is configured to use, as a number, either `1.0`, `1.1`, `1.2`, or `1.3`. | ||
|
||
When not used, or for environments that do not support this feature, such as Viceroy, `null` | ||
may be returned. | ||
|
||
## Value | ||
|
||
A `number` or `null`. |
Oops, something went wrong.