mirror of
https://github.com/alexhopeoconnor/DFTE.git
synced 2026-10-03 22:21:59 +10:00
docs: clarify DFTE response ownership guidance
This commit is contained in:
@@ -1,5 +1,12 @@
|
||||
# Changelog
|
||||
|
||||
## 1.2.1
|
||||
|
||||
- Clarify the safe shared-response and fixed-slot borrowed-response helpers so
|
||||
embedded web clients can choose the ownership model that matches their
|
||||
response lifetime.
|
||||
- Refresh the package documentation and canonical PlatformIO installation tag.
|
||||
|
||||
## 1.2.0
|
||||
|
||||
- Add a borrowed async-response helper for fixed, caller-owned response slots. It avoids a per-request `shared_ptr` control allocation while releasing the slot safely on completion or disconnect.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# Device Framework Template Engine
|
||||
# DeviceFramework Template Engine (DFTE)
|
||||
|
||||
DFTE streams HTML and text from ESP8266 and ESP32 firmware without constructing a complete response in RAM. Store layouts in PROGMEM, resolve changing values through getters, and render fixed-size chunks directly to serial or an asynchronous HTTP response.
|
||||
|
||||
@@ -49,7 +49,7 @@ Build [Hello Placeholder](examples/HelloPlaceholder/) to see the rendered result
|
||||
|
||||
```ini
|
||||
lib_deps =
|
||||
DeviceFrameworkTemplateEngine=https://github.com/alexhopeoconnor/DFTE.git#v1.2.0
|
||||
DeviceFrameworkTemplateEngine=https://github.com/alexhopeoconnor/DFTE.git#v1.2.1
|
||||
```
|
||||
|
||||
PlatformIO checks out the Git ref after `#`; GitHub Release assets are unrelated. DFTE supports ESP8266 and ESP32 Arduino projects.
|
||||
|
||||
@@ -2,6 +2,11 @@
|
||||
|
||||
Build a `PlaceholderRegistry` once during setup, but allocate a fresh `TemplateContext` for each request. A shared context would mix rendering state when clients overlap.
|
||||
|
||||
| Need | Use |
|
||||
| --- | --- |
|
||||
| A request-owned dynamic render context | `beginSafeTemplateResponse()` |
|
||||
| A fixed response-slot pool owned by the application | `beginBorrowedChunkedResponse()` |
|
||||
|
||||
```cpp
|
||||
#include <TemplateEngine.h>
|
||||
#include <TemplateEngineAsyncWeb.h>
|
||||
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
# DFTE documentation
|
||||
# DeviceFramework Template Engine (DFTE) documentation
|
||||
|
||||
| I want to… | Read |
|
||||
| --- | --- |
|
||||
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "DeviceFrameworkTemplateEngine",
|
||||
"version": "1.2.0",
|
||||
"version": "1.2.1",
|
||||
"description": "Memory-efficient streaming template engine for ESP8266/ESP32 with chunked rendering support. Designed for embedded web interfaces with PROGMEM template support.",
|
||||
"keywords": [
|
||||
"template",
|
||||
|
||||
Reference in New Issue
Block a user