-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
http.dart
2310 lines (2130 loc) · 76 KB
/
http.dart
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright (c) 2013, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
library dart._http;
import 'dart:async';
import 'dart:collection'
show
HashMap,
HashSet,
Queue,
ListQueue,
LinkedList,
LinkedListEntry,
UnmodifiableMapView;
import 'dart:convert';
import 'dart:developer' hide log;
import 'dart:_internal'
show Since, valueOfNonNullableParamWithDefault, HttpStatus;
import 'dart:math';
import 'dart:io';
import 'dart:typed_data';
part 'crypto.dart';
part 'http_date.dart';
part 'http_headers.dart';
part 'http_impl.dart';
part 'http_parser.dart';
part 'http_session.dart';
part 'overrides.dart';
part 'websocket.dart';
part 'websocket_impl.dart';
/**
* A server that delivers content, such as web pages, using the HTTP protocol.
*
* The HttpServer is a [Stream] that provides [HttpRequest] objects. Each
* HttpRequest has an associated [HttpResponse] object.
* The server responds to a request by writing to that HttpResponse object.
* The following example shows how to bind an HttpServer to an IPv6
* [InternetAddress] on port 80 (the standard port for HTTP servers)
* and how to listen for requests.
* Port 80 is the default HTTP port. However, on most systems accessing
* this requires super-user privileges. For local testing consider
* using a non-reserved port (1024 and above).
*
* import 'dart:io';
*
* main() {
* HttpServer
* .bind(InternetAddress.anyIPv6, 80)
* .then((server) {
* server.listen((HttpRequest request) {
* request.response.write('Hello, world!');
* request.response.close();
* });
* });
* }
*
* Incomplete requests, in which all or part of the header is missing, are
* ignored, and no exceptions or HttpRequest objects are generated for them.
* Likewise, when writing to an HttpResponse, any [Socket] exceptions are
* ignored and any future writes are ignored.
*
* The HttpRequest exposes the request headers and provides the request body,
* if it exists, as a Stream of data. If the body is unread, it is drained
* when the server writes to the HttpResponse or closes it.
*
* ## Bind with a secure HTTPS connection
*
* Use [bindSecure] to create an HTTPS server.
*
* The server presents a certificate to the client. The certificate
* chain and the private key are set in the [SecurityContext]
* object that is passed to [bindSecure].
*
* import 'dart:io';
* import "dart:isolate";
*
* main() {
* SecurityContext context = new SecurityContext();
* var chain =
* Platform.script.resolve('certificates/server_chain.pem')
* .toFilePath();
* var key =
* Platform.script.resolve('certificates/server_key.pem')
* .toFilePath();
* context.useCertificateChain(chain);
* context.usePrivateKey(key, password: 'dartdart');
*
* HttpServer
* .bindSecure(InternetAddress.anyIPv6,
* 443,
* context)
* .then((server) {
* server.listen((HttpRequest request) {
* request.response.write('Hello, world!');
* request.response.close();
* });
* });
* }
*
* The certificates and keys are PEM files, which can be created and
* managed with the tools in OpenSSL.
*
* ## Connect to a server socket
*
* You can use the [listenOn] constructor to attach an HTTP server to
* a [ServerSocket].
*
* import 'dart:io';
*
* main() {
* ServerSocket.bind(InternetAddress.anyIPv6, 80)
* .then((serverSocket) {
* HttpServer httpserver = new HttpServer.listenOn(serverSocket);
* serverSocket.listen((Socket socket) {
* socket.write('Hello, client.');
* });
* });
* }
*
* ## Other resources
*
* * HttpServer is a Stream. Refer to the [Stream] class for information
* about the streaming qualities of an HttpServer.
* Pausing the subscription of the stream, pauses at the OS level.
*
* * The [shelf](https://pub.dev/packages/shelf)
* package on pub.dev contains a set of high-level classes that,
* together with this class, makes it easy to provide content through HTTP
* servers.
*/
abstract class HttpServer implements Stream<HttpRequest> {
/**
* Gets and sets the default value of the `Server` header for all responses
* generated by this [HttpServer].
*
* If [serverHeader] is `null`, no `Server` header will be added to each
* response.
*
* The default value is `null`.
*/
String? serverHeader;
/**
* Default set of headers added to all response objects.
*
* By default the following headers are in this set:
*
* Content-Type: text/plain; charset=utf-8
* X-Frame-Options: SAMEORIGIN
* X-Content-Type-Options: nosniff
* X-XSS-Protection: 1; mode=block
*
* If the `Server` header is added here and the `serverHeader` is set as
* well then the value of `serverHeader` takes precedence.
*/
HttpHeaders get defaultResponseHeaders;
/**
* Whether the [HttpServer] should compress the content, if possible.
*
* The content can only be compressed when the response is using
* chunked Transfer-Encoding and the incoming request has `gzip`
* as an accepted encoding in the Accept-Encoding header.
*
* The default value is `false` (compression disabled).
* To enable, set `autoCompress` to `true`.
*/
bool autoCompress = false;
/**
* Gets or sets the timeout used for idle keep-alive connections. If no
* further request is seen within [idleTimeout] after the previous request was
* completed, the connection is dropped.
*
* Default is 120 seconds.
*
* Note that it may take up to `2 * idleTimeout` before a idle connection is
* aborted.
*
* To disable, set [idleTimeout] to `null`.
*/
Duration? idleTimeout = const Duration(seconds: 120);
/**
* Starts listening for HTTP requests on the specified [address] and
* [port].
*
* The [address] can either be a [String] or an
* [InternetAddress]. If [address] is a [String], [bind] will
* perform a [InternetAddress.lookup] and use the first value in the
* list. To listen on the loopback adapter, which will allow only
* incoming connections from the local host, use the value
* [InternetAddress.loopbackIPv4] or
* [InternetAddress.loopbackIPv6]. To allow for incoming
* connection from the network use either one of the values
* [InternetAddress.anyIPv4] or [InternetAddress.anyIPv6] to
* bind to all interfaces or the IP address of a specific interface.
*
* If an IP version 6 (IPv6) address is used, both IP version 6
* (IPv6) and version 4 (IPv4) connections will be accepted. To
* restrict this to version 6 (IPv6) only, use [v6Only] to set
* version 6 only. However, if the address is
* [InternetAddress.loopbackIPv6], only IP version 6 (IPv6) connections
* will be accepted.
*
* If [port] has the value 0 an ephemeral port will be chosen by
* the system. The actual port used can be retrieved using the
* [port] getter.
*
* The optional argument [backlog] can be used to specify the listen
* backlog for the underlying OS listen setup. If [backlog] has the
* value of 0 (the default) a reasonable value will be chosen by
* the system.
*
* The optional argument [shared] specifies whether additional HttpServer
* objects can bind to the same combination of `address`, `port` and `v6Only`.
* If `shared` is `true` and more `HttpServer`s from this isolate or other
* isolates are bound to the port, then the incoming connections will be
* distributed among all the bound `HttpServer`s. Connections can be
* distributed over multiple isolates this way.
*/
static Future<HttpServer> bind(address, int port,
{int backlog = 0, bool v6Only = false, bool shared = false}) =>
_HttpServer.bind(address, port, backlog, v6Only, shared);
/**
* The [address] can either be a [String] or an
* [InternetAddress]. If [address] is a [String], [bind] will
* perform a [InternetAddress.lookup] and use the first value in the
* list. To listen on the loopback adapter, which will allow only
* incoming connections from the local host, use the value
* [InternetAddress.loopbackIPv4] or
* [InternetAddress.loopbackIPv6]. To allow for incoming
* connection from the network use either one of the values
* [InternetAddress.anyIPv4] or [InternetAddress.anyIPv6] to
* bind to all interfaces or the IP address of a specific interface.
*
* If an IP version 6 (IPv6) address is used, both IP version 6
* (IPv6) and version 4 (IPv4) connections will be accepted. To
* restrict this to version 6 (IPv6) only, use [v6Only] to set
* version 6 only.
*
* If [port] has the value 0 an ephemeral port will be chosen by
* the system. The actual port used can be retrieved using the
* [port] getter.
*
* The optional argument [backlog] can be used to specify the listen
* backlog for the underlying OS listen setup. If [backlog] has the
* value of 0 (the default) a reasonable value will be chosen by
* the system.
*
* If [requestClientCertificate] is true, the server will
* request clients to authenticate with a client certificate.
* The server will advertise the names of trusted issuers of client
* certificates, getting them from a [SecurityContext], where they have been
* set using [SecurityContext.setClientAuthorities].
*
* The optional argument [shared] specifies whether additional HttpServer
* objects can bind to the same combination of `address`, `port` and `v6Only`.
* If `shared` is `true` and more `HttpServer`s from this isolate or other
* isolates are bound to the port, then the incoming connections will be
* distributed among all the bound `HttpServer`s. Connections can be
* distributed over multiple isolates this way.
*/
static Future<HttpServer> bindSecure(
address, int port, SecurityContext context,
{int backlog = 0,
bool v6Only = false,
bool requestClientCertificate = false,
bool shared = false}) =>
_HttpServer.bindSecure(address, port, context, backlog, v6Only,
requestClientCertificate, shared);
/**
* Attaches the HTTP server to an existing [ServerSocket]. When the
* [HttpServer] is closed, the [HttpServer] will just detach itself,
* closing current connections but not closing [serverSocket].
*/
factory HttpServer.listenOn(ServerSocket serverSocket) =>
new _HttpServer.listenOn(serverSocket);
/**
* Permanently stops this [HttpServer] from listening for new
* connections. This closes the [Stream] of [HttpRequest]s with a
* done event. The returned future completes when the server is
* stopped. For a server started using [bind] or [bindSecure] this
* means that the port listened on no longer in use.
*
* If [force] is `true`, active connections will be closed immediately.
*/
Future close({bool force = false});
/**
* The port that the server is listening on.
*
* This is the actual port used when a port of zero is
* specified in the [bind] or [bindSecure] call.
*/
int get port;
/**
* The address that the server is listening on.
*
* This is the actual address used when the original address
* was specified as a hostname.
*/
InternetAddress get address;
/**
* Sets the timeout, in seconds, for sessions of this [HttpServer].
*
* The default timeout is 20 minutes.
*/
set sessionTimeout(int timeout);
/**
* A [HttpConnectionsInfo] object summarizing the number of
* current connections handled by the server.
*/
HttpConnectionsInfo connectionsInfo();
}
/**
* Summary statistics about an [HttpServer]s current socket connections.
*/
class HttpConnectionsInfo {
/**
* Total number of socket connections.
*/
int total = 0;
/**
* Number of active connections where actual request/response
* processing is active.
*/
int active = 0;
/**
* Number of idle connections held by clients as persistent connections.
*/
int idle = 0;
/**
* Number of connections which are preparing to close.
*
* Note: These connections are also part of the [active] count as they might
* still be sending data to the client before finally closing.
*/
int closing = 0;
}
/**
* Headers for HTTP requests and responses.
*
* In some situations, headers are immutable:
*
* * [HttpRequest] and [HttpClientResponse] always have immutable headers.
*
* * [HttpResponse] and [HttpClientRequest] have immutable headers
* from the moment the body is written to.
*
* In these situations, the mutating methods throw exceptions.
*
* For all operations on HTTP headers the header name is
* case-insensitive.
*
* To set the value of a header use the `set()` method:
*
* request.headers.set(HttpHeaders.cacheControlHeader,
* 'max-age=3600, must-revalidate');
*
* To retrieve the value of a header use the `value()` method:
*
* print(request.headers.value(HttpHeaders.userAgentHeader));
*
* An `HttpHeaders` object holds a list of values for each name
* as the standard allows. In most cases a name holds only a single value,
* The most common mode of operation is to use `set()` for setting a value,
* and `value()` for retrieving a value.
*/
abstract class HttpHeaders {
static const acceptHeader = "accept";
static const acceptCharsetHeader = "accept-charset";
static const acceptEncodingHeader = "accept-encoding";
static const acceptLanguageHeader = "accept-language";
static const acceptRangesHeader = "accept-ranges";
static const ageHeader = "age";
static const allowHeader = "allow";
static const authorizationHeader = "authorization";
static const cacheControlHeader = "cache-control";
static const connectionHeader = "connection";
static const contentEncodingHeader = "content-encoding";
static const contentLanguageHeader = "content-language";
static const contentLengthHeader = "content-length";
static const contentLocationHeader = "content-location";
static const contentMD5Header = "content-md5";
static const contentRangeHeader = "content-range";
static const contentTypeHeader = "content-type";
static const dateHeader = "date";
static const etagHeader = "etag";
static const expectHeader = "expect";
static const expiresHeader = "expires";
static const fromHeader = "from";
static const hostHeader = "host";
static const ifMatchHeader = "if-match";
static const ifModifiedSinceHeader = "if-modified-since";
static const ifNoneMatchHeader = "if-none-match";
static const ifRangeHeader = "if-range";
static const ifUnmodifiedSinceHeader = "if-unmodified-since";
static const lastModifiedHeader = "last-modified";
static const locationHeader = "location";
static const maxForwardsHeader = "max-forwards";
static const pragmaHeader = "pragma";
static const proxyAuthenticateHeader = "proxy-authenticate";
static const proxyAuthorizationHeader = "proxy-authorization";
static const rangeHeader = "range";
static const refererHeader = "referer";
static const retryAfterHeader = "retry-after";
static const serverHeader = "server";
static const teHeader = "te";
static const trailerHeader = "trailer";
static const transferEncodingHeader = "transfer-encoding";
static const upgradeHeader = "upgrade";
static const userAgentHeader = "user-agent";
static const varyHeader = "vary";
static const viaHeader = "via";
static const warningHeader = "warning";
static const wwwAuthenticateHeader = "www-authenticate";
@Deprecated("Use acceptHeader instead")
static const ACCEPT = acceptHeader;
@Deprecated("Use acceptCharsetHeader instead")
static const ACCEPT_CHARSET = acceptCharsetHeader;
@Deprecated("Use acceptEncodingHeader instead")
static const ACCEPT_ENCODING = acceptEncodingHeader;
@Deprecated("Use acceptLanguageHeader instead")
static const ACCEPT_LANGUAGE = acceptLanguageHeader;
@Deprecated("Use acceptRangesHeader instead")
static const ACCEPT_RANGES = acceptRangesHeader;
@Deprecated("Use ageHeader instead")
static const AGE = ageHeader;
@Deprecated("Use allowHeader instead")
static const ALLOW = allowHeader;
@Deprecated("Use authorizationHeader instead")
static const AUTHORIZATION = authorizationHeader;
@Deprecated("Use cacheControlHeader instead")
static const CACHE_CONTROL = cacheControlHeader;
@Deprecated("Use connectionHeader instead")
static const CONNECTION = connectionHeader;
@Deprecated("Use contentEncodingHeader instead")
static const CONTENT_ENCODING = contentEncodingHeader;
@Deprecated("Use contentLanguageHeader instead")
static const CONTENT_LANGUAGE = contentLanguageHeader;
@Deprecated("Use contentLengthHeader instead")
static const CONTENT_LENGTH = contentLengthHeader;
@Deprecated("Use contentLocationHeader instead")
static const CONTENT_LOCATION = contentLocationHeader;
@Deprecated("Use contentMD5Header instead")
static const CONTENT_MD5 = contentMD5Header;
@Deprecated("Use contentRangeHeader instead")
static const CONTENT_RANGE = contentRangeHeader;
@Deprecated("Use contentTypeHeader instead")
static const CONTENT_TYPE = contentTypeHeader;
@Deprecated("Use dateHeader instead")
static const DATE = dateHeader;
@Deprecated("Use etagHeader instead")
static const ETAG = etagHeader;
@Deprecated("Use expectHeader instead")
static const EXPECT = expectHeader;
@Deprecated("Use expiresHeader instead")
static const EXPIRES = expiresHeader;
@Deprecated("Use fromHeader instead")
static const FROM = fromHeader;
@Deprecated("Use hostHeader instead")
static const HOST = hostHeader;
@Deprecated("Use ifMatchHeader instead")
static const IF_MATCH = ifMatchHeader;
@Deprecated("Use ifModifiedSinceHeader instead")
static const IF_MODIFIED_SINCE = ifModifiedSinceHeader;
@Deprecated("Use ifNoneMatchHeader instead")
static const IF_NONE_MATCH = ifNoneMatchHeader;
@Deprecated("Use ifRangeHeader instead")
static const IF_RANGE = ifRangeHeader;
@Deprecated("Use ifUnmodifiedSinceHeader instead")
static const IF_UNMODIFIED_SINCE = ifUnmodifiedSinceHeader;
@Deprecated("Use lastModifiedHeader instead")
static const LAST_MODIFIED = lastModifiedHeader;
@Deprecated("Use locationHeader instead")
static const LOCATION = locationHeader;
@Deprecated("Use maxForwardsHeader instead")
static const MAX_FORWARDS = maxForwardsHeader;
@Deprecated("Use pragmaHeader instead")
static const PRAGMA = pragmaHeader;
@Deprecated("Use proxyAuthenticateHeader instead")
static const PROXY_AUTHENTICATE = proxyAuthenticateHeader;
@Deprecated("Use proxyAuthorizationHeader instead")
static const PROXY_AUTHORIZATION = proxyAuthorizationHeader;
@Deprecated("Use rangeHeader instead")
static const RANGE = rangeHeader;
@Deprecated("Use refererHeader instead")
static const REFERER = refererHeader;
@Deprecated("Use retryAfterHeader instead")
static const RETRY_AFTER = retryAfterHeader;
@Deprecated("Use serverHeader instead")
static const SERVER = serverHeader;
@Deprecated("Use teHeader instead")
static const TE = teHeader;
@Deprecated("Use trailerHeader instead")
static const TRAILER = trailerHeader;
@Deprecated("Use transferEncodingHeader instead")
static const TRANSFER_ENCODING = transferEncodingHeader;
@Deprecated("Use upgradeHeader instead")
static const UPGRADE = upgradeHeader;
@Deprecated("Use userAgentHeader instead")
static const USER_AGENT = userAgentHeader;
@Deprecated("Use varyHeader instead")
static const VARY = varyHeader;
@Deprecated("Use viaHeader instead")
static const VIA = viaHeader;
@Deprecated("Use warningHeader instead")
static const WARNING = warningHeader;
@Deprecated("Use wwwAuthenticateHeader instead")
static const WWW_AUTHENTICATE = wwwAuthenticateHeader;
// Cookie headers from RFC 6265.
static const cookieHeader = "cookie";
static const setCookieHeader = "set-cookie";
@Deprecated("Use cookieHeader instead")
static const COOKIE = cookieHeader;
@Deprecated("Use setCookieHeader instead")
static const SET_COOKIE = setCookieHeader;
// TODO(39783): Document this.
static const generalHeaders = const [
cacheControlHeader,
connectionHeader,
dateHeader,
pragmaHeader,
trailerHeader,
transferEncodingHeader,
upgradeHeader,
viaHeader,
warningHeader
];
@Deprecated("Use generalHeaders instead")
static const GENERAL_HEADERS = generalHeaders;
static const entityHeaders = const [
allowHeader,
contentEncodingHeader,
contentLanguageHeader,
contentLengthHeader,
contentLocationHeader,
contentMD5Header,
contentRangeHeader,
contentTypeHeader,
expiresHeader,
lastModifiedHeader
];
@Deprecated("Use entityHeaders instead")
static const ENTITY_HEADERS = entityHeaders;
static const responseHeaders = const [
acceptRangesHeader,
ageHeader,
etagHeader,
locationHeader,
proxyAuthenticateHeader,
retryAfterHeader,
serverHeader,
varyHeader,
wwwAuthenticateHeader
];
@Deprecated("Use responseHeaders instead")
static const RESPONSE_HEADERS = responseHeaders;
static const requestHeaders = const [
acceptHeader,
acceptCharsetHeader,
acceptEncodingHeader,
acceptLanguageHeader,
authorizationHeader,
expectHeader,
fromHeader,
hostHeader,
ifMatchHeader,
ifModifiedSinceHeader,
ifNoneMatchHeader,
ifRangeHeader,
ifUnmodifiedSinceHeader,
maxForwardsHeader,
proxyAuthorizationHeader,
rangeHeader,
refererHeader,
teHeader,
userAgentHeader
];
@Deprecated("Use requestHeaders instead")
static const REQUEST_HEADERS = requestHeaders;
/**
* The date specified by the [dateHeader] header, if any.
*/
DateTime? date;
/**
* The date and time specified by the [expiresHeader] header, if any.
*/
DateTime? expires;
/**
* The date and time specified by the [ifModifiedSinceHeader] header, if any.
*/
DateTime? ifModifiedSince;
/**
* The value of the [hostHeader] header, if any.
*/
String? host;
/**
* The value of the port part of the [hostHeader] header, if any.
*/
int? port;
/**
* The [ContentType] of the [contentTypeHeader] header, if any.
*/
ContentType? contentType;
/**
* The value of the [contentLengthHeader] header, if any.
*
* The value is negative if there is no content length set.
*/
int contentLength = -1;
/**
* Whether the connection is persistent (keep-alive).
*/
late bool persistentConnection;
/**
* Whether the connection uses chunked transfer encoding.
*
* Reflects and modifies the value of the [transferEncodingHeader] header.
*/
late bool chunkedTransferEncoding;
/**
* The values for the header named [name].
*
* Returns null if there is no header with the provided name,
* otherwise returns a new list containing the current values.
* Not that modifying the list does not change the header.
*/
List<String>? operator [](String name);
/**
* Convenience method for the value for a single valued header.
*
* The value must not have more than one value.
*
* Returns `null` if there is no header with the provided name.
*/
String? value(String name);
/**
* Adds a header value.
*
* The header named [name] will have a string value derived from [value]
* added to its list of values.
*
* Some headers are single valued, and for these, adding a value will
* replace a previous value. If the [value] is a [DateTime], an
* HTTP date format will be applied. If the value is an [Iterable],
* each element will be added separately. For all other
* types the default [Object.toString] method will be used.
*
* Header names are converted to lower-case unless
* [preserveHeaderCase] is set to true. If two header names are
* the same when converted to lower-case, they are considered to be
* the same header, with one set of values.
*
* The current case of the a header name is that of the name used by
* the last [set] or [add] call for that header.
*/
void add(String name, Object value,
{@Since("2.8") bool preserveHeaderCase = false});
/**
* Sets the header [name] to [value].
*
* Removes all existing values for the header named [name] and
* then [add]s [value] to it.
*/
void set(String name, Object value,
{@Since("2.8") bool preserveHeaderCase = false});
/**
* Removes a specific value for a header name.
*
* Some headers have system supplied values which cannot be removed.
* For all other headers and values, the [value] is converted to a string
* in the same way as for [add], then that string value is removed from the
* current values of [name].
* If there are no remaining values for [name], the header is no longer
* considered present.
*/
void remove(String name, Object value);
/**
* Removes all values for the specified header name.
*
* Some headers have system supplied values which cannot be removed.
* All other values for [name] are removed.
* If there are no remaining values for [name], the header is no longer
* considered present.
*/
void removeAll(String name);
/**
* Performs the [action] on each header.
*
* The [action] function is called with each header's name and a list
* of the header's values. The casing of the name string is determined by
* the last [add] or [set] operation for that particular header,
* which defaults to lower-casing the header name unless explicitly
* set to preserve the case.
*/
void forEach(void action(String name, List<String> values));
/**
* Disables folding for the header named [name] when sending the HTTP header.
*
* By default, multiple header values are folded into a
* single header line by separating the values with commas.
*
* The 'set-cookie' header has folding disabled by default.
*/
void noFolding(String name);
/**
* Removes all headers.
*
* Some headers have system supplied values which cannot be removed.
* All other header values are removed, and header names with not
* remaining values are no longer considered present.
*/
void clear();
}
/**
* Representation of a header value in the form:
* ```dart
* value; parameter1=value1; parameter2=value2
* ```
*
* [HeaderValue] can be used to conveniently build and parse header
* values on this form.
*
* Parameter values can be omitted, in which case the value is parsed as `null`.
* Values can be doubled quoted to allow characters outside of the RFC 7230
* token characters and backslash sequences can be used to represent the double
* quote and backslash characters themselves.
*
* To build an "accepts" header with the value
*
* text/plain; q=0.3, text/html
*
* use code like this:
*
* HttpClientRequest request = ...;
* var v = new HeaderValue("text/plain", {"q": "0.3"});
* request.headers.add(HttpHeaders.acceptHeader, v);
* request.headers.add(HttpHeaders.acceptHeader, "text/html");
*
* To parse the header values use the [parse] static method.
*
* HttpRequest request = ...;
* List<String> values = request.headers[HttpHeaders.acceptHeader];
* values.forEach((value) {
* HeaderValue v = HeaderValue.parse(value);
* // Use v.value and v.parameters
* });
*
* An instance of [HeaderValue] is immutable.
*/
abstract class HeaderValue {
/**
* Creates a new header value object setting the value and parameters.
*/
factory HeaderValue(
[String value = "", Map<String, String?> parameters = const {}]) {
return new _HeaderValue(value, parameters);
}
/**
* Creates a new header value object from parsing a header value
* string with both value and optional parameters.
*/
static HeaderValue parse(String value,
{String parameterSeparator = ";",
String? valueSeparator,
bool preserveBackslash = false}) {
return _HeaderValue.parse(value,
parameterSeparator: parameterSeparator,
valueSeparator: valueSeparator,
preserveBackslash: preserveBackslash);
}
/**
* The value of the header.
*/
String get value;
/**
* A map of parameters.
*
* This map cannot be modified.
*/
Map<String, String?> get parameters;
/**
* Returns the formatted string representation in the form:
* ```
* value; parameter1=value1; parameter2=value2
* ```
*/
String toString();
}
abstract class HttpSession implements Map {
/**
* The id of the current session.
*/
String get id;
/**
* Destroys the session.
*
* This terminates the session and any further
* connections with this id will be given a new id and session.
*/
void destroy();
/**
* Sets a callback that will be called when the session is timed out.
*
* Calling this again will overwrite the previous value.
*/
void set onTimeout(void callback());
/**
* Whether the session has not yet been sent to the client.
*/
bool get isNew;
}
/**
* A MIME/IANA media type used as the value of the
* [HttpHeaders.contentTypeHeader] header.
*
* A [ContentType] is immutable.
*/
abstract class ContentType implements HeaderValue {
/**
* Content type for plain text using UTF-8 encoding.
*
* text/plain; charset=utf-8
*/
static final text = new ContentType("text", "plain", charset: "utf-8");
@Deprecated("Use text instead")
static final TEXT = text;
/**
* Content type for HTML using UTF-8 encoding.
*
* text/html; charset=utf-8
*/
static final html = new ContentType("text", "html", charset: "utf-8");
@Deprecated("Use html instead")
static final HTML = html;
/**
* Content type for JSON using UTF-8 encoding.
*
* application/json; charset=utf-8
*/
static final json = new ContentType("application", "json", charset: "utf-8");
@Deprecated("Use json instead")
static final JSON = json;
/**
* Content type for binary data.
*
* application/octet-stream
*/
static final binary = new ContentType("application", "octet-stream");
@Deprecated("Use binary instead")
static final BINARY = binary;
/**
* Creates a new content type object setting the primary type and
* sub type. The charset and additional parameters can also be set
* using [charset] and [parameters]. If charset is passed and
* [parameters] contains charset as well the passed [charset] will
* override the value in parameters. Keys passed in parameters will be
* converted to lower case. The `charset` entry, whether passed as `charset`
* or in `parameters`, will have its value converted to lower-case.
*/
factory ContentType(String primaryType, String subType,
{String? charset, Map<String, String?> parameters = const {}}) {
return new _ContentType(primaryType, subType, charset, parameters);
}
/**
* Creates a new content type object from parsing a Content-Type
* header value. As primary type, sub type and parameter names and
* values are not case sensitive all these values will be converted
* to lower case. Parsing this string
*
* text/html; charset=utf-8
*
* will create a content type object with primary type "text",
* subtype "html" and parameter "charset" with value "utf-8".
* There may be more parameters supplied, but they are not recognized
* by this class.
*/
static ContentType parse(String value) {
return _ContentType.parse(value);
}
/**
* Gets the MIME type and subtype, without any parameters.
*
* For the full content type `text/html;charset=utf-8`,
* the [mimeType] value is the string `text/html`.
*/
String get mimeType;
/**
* Gets the primary type.
*
* For the full content type `text/html;charset=utf-8`,
* the [primaryType] value is the string `text`.
*/
String get primaryType;
/**
* Gets the subtype.
*
* For the full content type `text/html;charset=utf-8`,
* the [subType] value is the string `html`.
* May be the empty string.
*/
String get subType;
/**
* Gets the character set, if any.
*
* For the full content type `text/html;charset=utf-8`,
* the [charset] value is the string `utf-8`.
*/
String? get charset;
}
/**
* Representation of a cookie. For cookies received by the server as Cookie
* header values only [name] and [value] properties will be set. When building a
* cookie for the 'set-cookie' header in the server and when receiving cookies
* in the client as 'set-cookie' headers all fields can be used.
*/
abstract class Cookie {
/**
* The name of the cookie.
*
* Must be a `token` as specified in RFC 6265.
*
* The allowed characters in a `token` are the visible ASCII characters,
* U+0021 (`!`) through U+007E (`~`), except the separator characters:
* `(`, `)`, `<`, `>`, `@`, `,`, `;`, `:`, `\`, `"`, `/`, `[`, `]`, `?`, `=`,
* `{`, and `}`.
*/
late String name;
/**
* The value of the cookie.
*
* Must be a `cookie-value` as specified in RFC 6265.