pkg/analysis_server/doc/api.html - Issue 865383002: add optional request field to record time at which client made request

Side by Side Diff: pkg/analysis_server/doc/api.html

Issue 865383002: add optional request field to record time at which client made request (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart

Patch Set: merge Created 5 years, 11 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View unified diff | Download patch | Annotate | Revision Log

« no previous file with comments | « editor/tools/plugins/com.google.dart.server_test/src/com/google/dart/server/internal/remote/RemoteAnalysisServerImplTest.java ('k') | pkg/analysis_server/lib/src/protocol.dart » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

OLD	NEW
1 <html><head>	1 <html><head>

2 <meta charset="UTF-8">	2 <meta charset="UTF-8">

3 <title>Analysis Server API Specification</title>	3 <title>Analysis Server API Specification</title>

4 <style>body {	4 <style>body {

5 font-family: sans-serif, serif;	5 font-family: sans-serif, serif;

6 padding-left: 5%;	6 padding-left: 5%;

7 padding-right: 5%;	7 padding-right: 5%;

8 }	8 }

9 h1 {	9 h1 {

10 text-align: center;	10 text-align: center;

(...skipping 78 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
89 <p>	89 <p>

90 There is no guarantee concerning the order in which responses	90 There is no guarantee concerning the order in which responses

91 will be returned, but there is a guarantee that the server will	91 will be returned, but there is a guarantee that the server will

92 process requests in the order in which they are sent as long as	92 process requests in the order in which they are sent as long as

93 the transport mechanism also makes this guarantee. Responses can	93 the transport mechanism also makes this guarantee. Responses can

94 be returned in an order that is different from the order in	94 be returned in an order that is different from the order in

95 which the requests were received because some requests take	95 which the requests were received because some requests take

96 longer to process than others.	96 longer to process than others.

97 </p>	97 </p>

98 <p>	98 <p>

99 Every request is required to have two fields and may have an	99 Every request is required to have two fields and may have two

100 optional third field. The first required field is the ‘id’	100 additional optional fields. The first required field is the ‘id’

101 field, which is only used by the server to associate a response	101 field, which is only used by the server to associate a response

102 with the request that generated the response. The second	102 with the request that generated the response. The second

103 required field is the ‘method’ field, which is used to determine	103 required field is the ‘method’ field, which is used to determine

104 what the server is being requested to do. The optional field is	104 what the server is being requested to do. One optional field is

105 the ‘params’ field, whose structure is dependent on the method	105 the ‘params’ field, whose structure is dependent on the method

106 being requested. The structure of this field is described with	106 being requested. The structure of this field is described with

107 each request for which it is required.	107 each request for which it is required. The other optional field

	108 is the 'clientRequestTime' field, which is a number indicating

	109 the time at which the client made the request (milliseconds

	110 since epoch). Providing clientRequestTime helps us track

	111 how responsive analysis server is to client requests

	112 and better address any issues that occur.

108 </p>	113 </p>

109 <p>	114 <p>

110 Every response has up to three fields. The first field is the	115 Every response has up to three fields. The first field is the

111 ‘id’ field, which is always present and whose value is the	116 ‘id’ field, which is always present and whose value is the

112 identifier that was passed to the request that generated the	117 identifier that was passed to the request that generated the

113 response. The second field is the ‘error’ field, which is only	118 response. The second field is the ‘error’ field, which is only

114 present if an error was encountered while processing the	119 present if an error was encountered while processing the

115 request. The third field is the ‘result’ field, whose structure	120 request. The third field is the ‘result’ field, whose structure

116 is dependent on the method being responded to, and is described	121 is dependent on the method being responded to, and is described

117 with each request that will produce it.	122 with each request that will produce it.

(...skipping 3532 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
3650 <p>	3655 <p>

3651 This section contains a list of all of the errors that are	3656 This section contains a list of all of the errors that are

3652 produced by the server and the data that is returned with each.	3657 produced by the server and the data that is returned with each.

3653 </p>	3658 </p>

3654 <p>	3659 <p>

3655 TBD	3660 TBD

3656 </p>	3661 </p>

3657	3662

3658	3663

3659 </body></html>	3664 </body></html>

OLD	NEW