Skip to content

Commit 0bd55ec

Browse files
authored
Rename method to OutputAsStream (#340)
1 parent 863b167 commit 0bd55ec

File tree

13 files changed

+194
-181
lines changed

13 files changed

+194
-181
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ private static void ServerCommandReceived(object source, WebServerEventArgs e)
5050
{
5151
if (e.Context.Request.RawUrl.ToLower() == "/hello")
5252
{
53-
WebServer.OutPutStream(e.Context.Response, "Hello from nanoFramework!");
53+
WebServer.OutputAsStream(e.Context.Response, "Hello from nanoFramework!");
5454
}
5555
else
5656
{
@@ -76,15 +76,15 @@ public class MyController
7676
[Method("GET")]
7777
public void Hello(WebServerEventArgs e)
7878
{
79-
WebServer.OutPutStream(e.Context.Response, "Hello from Controller!");
79+
WebServer.OutputAsStream(e.Context.Response, "Hello from Controller!");
8080
}
8181

8282
[Route("api/led/{id}")]
8383
[Method("GET")]
8484
public void LedState(WebServerEventArgs e)
8585
{
8686
string ledId = e.GetRouteParameter("id");
87-
WebServer.OutPutStream(e.Context.Response, $"You selected Led {ledId}!");
87+
WebServer.OutputAsStream(e.Context.Response, $"You selected Led {ledId}!");
8888
}
8989
}
9090
```

doc/authentication.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ public class SecureController
2323
[Route("secure/data")]
2424
public void GetSecureData(WebServerEventArgs e)
2525
{
26-
WebServer.OutPutStream(e.Context.Response, "Secure data");
26+
WebServer.OutputAsStream(e.Context.Response, "Secure data");
2727
}
2828
}
2929

@@ -45,14 +45,14 @@ public class UserController
4545
[Authentication("Basic:admin secretpassword")]
4646
public void AdminPanel(WebServerEventArgs e)
4747
{
48-
WebServer.OutPutStream(e.Context.Response, "Admin panel");
48+
WebServer.OutputAsStream(e.Context.Response, "Admin panel");
4949
}
5050

5151
[Route("user")]
5252
[Authentication("Basic:user userpass")]
5353
public void UserPanel(WebServerEventArgs e)
5454
{
55-
WebServer.OutPutStream(e.Context.Response, "User panel");
55+
WebServer.OutputAsStream(e.Context.Response, "User panel");
5656
}
5757
}
5858
```
@@ -70,7 +70,7 @@ public class ApiController
7070
[Route("api/data")]
7171
public void GetData(WebServerEventArgs e)
7272
{
73-
WebServer.OutPutStream(e.Context.Response, "API data");
73+
WebServer.OutputAsStream(e.Context.Response, "API data");
7474
}
7575
}
7676

@@ -92,14 +92,14 @@ public class ServiceController
9292
[Authentication("ApiKey:premium-key-789")]
9393
public void PremiumService(WebServerEventArgs e)
9494
{
95-
WebServer.OutPutStream(e.Context.Response, "Premium service");
95+
WebServer.OutputAsStream(e.Context.Response, "Premium service");
9696
}
9797

9898
[Route("service/basic")]
9999
[Authentication("ApiKey:basic-key-456")]
100100
public void BasicService(WebServerEventArgs e)
101101
{
102-
WebServer.OutPutStream(e.Context.Response, "Basic service");
102+
WebServer.OutputAsStream(e.Context.Response, "Basic service");
103103
}
104104
}
105105
```
@@ -125,7 +125,7 @@ public class PublicController
125125
[Route("public/info")]
126126
public void GetPublicInfo(WebServerEventArgs e)
127127
{
128-
WebServer.OutPutStream(e.Context.Response, "Public information");
128+
WebServer.OutputAsStream(e.Context.Response, "Public information");
129129
}
130130
}
131131
```
@@ -140,28 +140,28 @@ public class MixedController
140140
public void BasicAuth(WebServerEventArgs e)
141141
{
142142
// Uses class-level Basic authentication
143-
WebServer.OutPutStream(e.Context.Response, "Basic auth data");
143+
WebServer.OutputAsStream(e.Context.Response, "Basic auth data");
144144
}
145145

146146
[Route("secure/api")]
147147
[Authentication("ApiKey:special-key-123")] // Override with API key
148148
public void ApiKeyAuth(WebServerEventArgs e)
149149
{
150-
WebServer.OutPutStream(e.Context.Response, "API key data");
150+
WebServer.OutputAsStream(e.Context.Response, "API key data");
151151
}
152152

153153
[Route("secure/custom")]
154154
[Authentication("Basic:customuser custompass")] // Override with custom basic auth
155155
public void CustomAuth(WebServerEventArgs e)
156156
{
157-
WebServer.OutPutStream(e.Context.Response, "Custom auth data");
157+
WebServer.OutputAsStream(e.Context.Response, "Custom auth data");
158158
}
159159

160160
[Route("public")]
161161
[Authentication("None")] // Override to allow public access
162162
public void PublicAccess(WebServerEventArgs e)
163163
{
164-
WebServer.OutPutStream(e.Context.Response, "Public data");
164+
WebServer.OutputAsStream(e.Context.Response, "Public data");
165165
}
166166
}
167167
```
@@ -177,27 +177,27 @@ public class MultiAuthController
177177
[Authentication("Basic")]
178178
public void DataBasicAuth(WebServerEventArgs e)
179179
{
180-
WebServer.OutPutStream(e.Context.Response, "Data via Basic auth");
180+
WebServer.OutputAsStream(e.Context.Response, "Data via Basic auth");
181181
}
182182

183183
[Route("data")]
184184
[Authentication("ApiKey:key1")]
185185
public void DataApiKey1(WebServerEventArgs e)
186186
{
187-
WebServer.OutPutStream(e.Context.Response, "Data via API key 1");
187+
WebServer.OutputAsStream(e.Context.Response, "Data via API key 1");
188188
}
189189

190190
[Route("data")]
191191
[Authentication("ApiKey:key2")]
192192
public void DataApiKey2(WebServerEventArgs e)
193193
{
194-
WebServer.OutPutStream(e.Context.Response, "Data via API key 2");
194+
WebServer.OutputAsStream(e.Context.Response, "Data via API key 2");
195195
}
196196

197197
[Route("data")]
198198
public void DataPublic(WebServerEventArgs e)
199199
{
200-
WebServer.OutPutStream(e.Context.Response, "Public data");
200+
WebServer.OutputAsStream(e.Context.Response, "Public data");
201201
}
202202
}
203203
```

doc/controllers-routing.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ public class TestController
3131
[Method("GET")]
3232
public void GetTest(WebServerEventArgs e)
3333
{
34-
WebServer.OutPutStream(e.Context.Response, "Test endpoint");
34+
WebServer.OutputAsStream(e.Context.Response, "Test endpoint");
3535
}
3636
}
3737
```
@@ -47,7 +47,7 @@ public class TestController
4747
public void MultipleRoutes(WebServerEventArgs e)
4848
{
4949
string route = e.Context.Request.RawUrl.TrimStart('/').Split('/')[0];
50-
WebServer.OutPutStream(e.Context.Response, $"Route: {route}");
50+
WebServer.OutputAsStream(e.Context.Response, $"Route: {route}");
5151
}
5252
}
5353
```
@@ -123,7 +123,7 @@ public class TestController
123123
{
124124
// Will handle GET, POST, PUT, DELETE, etc.
125125
string method = e.Context.Request.HttpMethod;
126-
WebServer.OutPutStream(e.Context.Response, $"Method: {method}");
126+
WebServer.OutputAsStream(e.Context.Response, $"Method: {method}");
127127
}
128128
}
129129
```
@@ -162,7 +162,7 @@ public void GetUser(WebServerEventArgs e)
162162
if (segments.Length > 2)
163163
{
164164
string userId = segments[2]; // /api/users/123
165-
WebServer.OutPutStream(e.Context.Response, $"User ID: {userId}");
165+
WebServer.OutputAsStream(e.Context.Response, $"User ID: {userId}");
166166
}
167167
}
168168
```
@@ -176,7 +176,7 @@ nanoFramework WebServer supports parameterized routes with named placeholders us
176176
public void GetUserById(WebServerEventArgs e)
177177
{
178178
string userId = e.GetRouteParameter("id");
179-
WebServer.OutPutStream(e.Context.Response, $"User ID: {userId}");
179+
WebServer.OutputAsStream(e.Context.Response, $"User ID: {userId}");
180180
}
181181

182182
[Route("api/users/{userId}/sensors/{sensorId}")]
@@ -185,7 +185,7 @@ public void GetUserSensor(WebServerEventArgs e)
185185
string userId = e.GetRouteParameter("userId");
186186
string sensorId = e.GetRouteParameter("sensorId");
187187

188-
WebServer.OutPutStream(e.Context.Response,
188+
WebServer.OutputAsStream(e.Context.Response,
189189
$"User: {userId}, Sensor: {sensorId}");
190190
}
191191

@@ -196,7 +196,7 @@ public void GetDeviceMeasurement(WebServerEventArgs e)
196196
string measurementType = e.GetRouteParameter("type");
197197

198198
// Example: /api/devices/esp32-001/measurements/temperature
199-
WebServer.OutPutStream(e.Context.Response,
199+
WebServer.OutputAsStream(e.Context.Response,
200200
$"Device {deviceId} - {measurementType} data");
201201
}
202202
```
@@ -223,7 +223,7 @@ public class PersonController
223223
{
224224
string json = JsonConvert.SerializeObject(persons);
225225
e.Context.Response.ContentType = "application/json";
226-
WebServer.OutPutStream(e.Context.Response, json);
226+
WebServer.OutputAsStream(e.Context.Response, json);
227227
}
228228

229229
[Route("api/persons/{id}")]
@@ -238,7 +238,7 @@ public class PersonController
238238
{
239239
string json = JsonConvert.SerializeObject(person);
240240
e.Context.Response.ContentType = "application/json";
241-
WebServer.OutPutStream(e.Context.Response, json);
241+
WebServer.OutputAsStream(e.Context.Response, json);
242242
}
243243
else
244244
{
@@ -421,7 +421,7 @@ public void GetData(WebServerEventArgs e)
421421
string json = JsonConvert.SerializeObject(data);
422422

423423
e.Context.Response.ContentType = "application/json";
424-
WebServer.OutPutStream(e.Context.Response, json);
424+
WebServer.OutputAsStream(e.Context.Response, json);
425425
}
426426
```
427427

@@ -433,7 +433,7 @@ public void GetPage(WebServerEventArgs e)
433433
{
434434
string html = "<html><body><h1>Hello nanoFramework!</h1></body></html>";
435435
e.Context.Response.ContentType = "text/html";
436-
WebServer.OutPutStream(e.Context.Response, html);
436+
WebServer.OutputAsStream(e.Context.Response, html);
437437
}
438438
```
439439

@@ -446,6 +446,6 @@ Bonus point if you read up to here, you can also create your custom status code!
446446
public void CustomStatus(WebServerEventArgs e)
447447
{
448448
e.Context.Response.StatusCode = 418; // I'm a teapot
449-
WebServer.OutPutStream(e.Context.Response, "I'm a teapot!");
449+
WebServer.OutputAsStream(e.Context.Response, "I'm a teapot!");
450450
}
451451
```

0 commit comments

Comments
 (0)