UDP API Definition: Difference between revisions

UDP API Definition (view source)

Revision as of 11:20, 11 July 2006

40 bytes added , 11 July 2006

m

→‎Formats used in this Spec

Epoximator

546

edits

@@ Line 10: / Line 10: @@
 == Formats used in this Spec ==
-:* {vartype varname} - Specifies what shall be inserted at this point and its type
+* {vartype varname} - Specifies what shall be inserted at this point and its type.
-:* [...] - Everything between [ and ] is optional
+* [...] - Everything between [ and ] is optional.
 === Used types ===
-:* int2 - 2byte Integer (in string representation)
+* ''int2'' - 2 byte Integer (in string representation)
-:* int4 - 4byte Integer (in string representation)
+* ''int4'' - 4 byte Integer (in string representation)
-:* str - String (NOTE: might be as long as 5000 bytes !!!, via udp api no string is likely to extend >1400 bytes)
+* ''str'' - String (NOTE: might be as long as 5000 bytes !!!, but via udp api never extend 1400 bytes)
 === Content Encoding ===
-:* Current character encoding used by the api: '''ascii'''
+* Default character encoding: ''ASCII''
-:* Escape scheme for option values: html form encoding + newline
+* Escape scheme for option values (to server): ''html form encoding'' + ''newline''
-:: this means you have to encode at least & in your option values in html form encoding style before sending them to the api server. All other html form encodings are optional.
+** This means you have to encode at least <tt>&</tt> in your option values in html form encoding style (<tt>&amp;amp;</tt>) before sending them to the api server. All other html form encodings are optional.
-:* All newlines should be replaced by &lt;br /&gt;
+** All newlines should be replaced by &lt;br /&gt;
-:: escape scheme for returned data fields: ', | and newline
+* Escape scheme for returned data fields (from server): ', | and newline
-:: newlines are encoded as &lt;br /&gt;, | is not allowed in data fields and ' is encoded as `.
+** Newlines are encoded as &lt;br /&gt;, ' is encoded as ` and | is not allowed in data fields.
 == Basics ==