File: protocol_format.html

package info (click to toggle)
webissues-server 0.8.3-2-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 392 kB
  • ctags: 610
  • sloc: php: 2,206; sql: 458; sh: 44; makefile: 9
file content (69 lines) | stat: -rw-r--r-- 3,634 bytes parent folder | download
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
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <title>Line Format</title>
    <link rel="stylesheet" href="common/style.css" type="text/css" />
    <meta name="generator" content="DocBook XSL Stylesheets V1.73.0" />
    <meta name="keywords" content="webissues, issue tracking, bug tracking, team collaboration, server" />
    <link rel="start" href="index.html" title="The WebIssues Server Manual" />
    <link rel="up" href="protocol.html" title="Appendix A. WebIssues Protocol Reference" />
    <link rel="prev" href="protocol_headers.html" title="Headers" />
    <link rel="next" href="protocol_syntax.html" title="Commands Syntax" />
  </head>
  <body>
    <div id="header">
      <div id="header-bar">
        <img id="header-logo" src="common/webissues.png" alt="WebIssues" />
        <div id="header-title">The <span class="application">WebIssues Server</span> Manual</div>
        <div id="header-abstract">Issue tracking and team collaboration system</div>
      </div>
      <div id="header-links"><a accesskey="h" href="index.html">Home</a> &raquo; <a accesskey="u" href="protocol.html"><span class="application">WebIssues</span> Protocol Reference</a></div>
    </div>
    <div class="navlinks">
      <div class="navleft">&laquo; <a accesskey="p" href="protocol_headers.html">Headers</a></div>
      <div class="navright"><a accesskey="n" href="protocol_syntax.html">Commands Syntax</a> &raquo;</div>
    </div>
    <div class="sect1" lang="en" xml:lang="en">
      <div class="titlepage">
        <div>
          <div>
            <h2 class="title" style="clear: both"><a id="protocol_format"></a>Line Format</h2>
          </div>
        </div>
      </div>
      <p>The command in a single line consisting of one or two keywords and zero or more arguments separated by single spaces.</p>
      <p>The reply of the server consists of one or more lines separated by <code class="literal">CR LF</code> bytes. Each line of the reply consists of one keyword and zero or more arguments separated by single spaces.</p>
      <p>A keyword consists of uppercase ASCII letters.</p>
      <p>An argument may be one of the following type:</p>
      <div class="variablelist">
        <dl>
          <dt>
            <span class="term">integer</span>
          </dt>
          <dd>
            <p>optional minus sign followed by one or more decimal digits</p>
          </dd>
          <dt>
            <span class="term">string</span>
          </dt>
          <dd>
            <p>a sequence of characters enclosed in single qoutes, with single quote, backslash and new line characters escaped as <code class="literal">\'</code>, <code class="literal">\\</code> and <code class="literal">\n</code> respectively</p>
          </dd>
        </dl>
      </div>
      <p>Reply indicating an empty list is a single line containing the following keyword:</p>
      <p>NULL</p>
      <p>Reply indicating an error is a single line with the following format:</p>
      <p>ERROR code 'message'</p>
    </div>
    <div class="navlinks">
      <div class="navleft">&laquo; <a accesskey="p" href="protocol_headers.html">Headers</a></div>
      <div class="navright"><a accesskey="n" href="protocol_syntax.html">Commands Syntax</a> &raquo;</div>
    </div>
    <div id="copyright">
      <p class="copyright">Copyright © 2007-2008 WebIssues Team</p>
    </div>
  </body>
</html>