summaryrefslogtreecommitdiff
path: root/doc/protocol.txt
blob: 20378a0e38adb8496c9182fa5cca58251e4e1fc0 (plain)
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
Next File Transfer Protocol
===========================

Introduction
------------

Next File Transfer uses a simple protocol where a 2 character code defines
a message type. 

The following are standard compents of a message:

    +------------+------------------------------------------------------+
    | <NNNNN>    | 5 ASCII digits making up a zero-padded number        |
    +------------+------------------------------------------------------+
    | <N bytes>  | A stream of N bytes                                  |
    +------------+------------------------------------------------------+


Put File
--------

The format of the message from the client is:

    +------------+------------------------------------------------------+
    | PF         | Put file command                                     |
    +------------+------------------------------------------------------+
    | <NNNNN>    | Length of filename                                   |
    +------------+------------------------------------------------------+
    | <N bytes>  | The filename                                         |
    +------------+------------------------------------------------------+
    | <NNNNN>    | Length of the data for the file                      |
    +------------+------------------------------------------------------+
    | <N bytes>  | The data                                             |
    +------------+------------------------------------------------------+

The server responds with either:

    +------------+------------------------------------------------------+
    | OK         | The command completed OK                             |
    +------------+------------------------------------------------------+

or:

    +------------+------------------------------------------------------+
    | !E         | There was an error writing the file                  |
    +------------+------------------------------------------------------+


Get File
--------

The format of the message from the client is:

    +------------+------------------------------------------------------+
    | GF         | Get file command                                     |
    +------------+------------------------------------------------------+
    | <NNNNN>    | Length of filename                                   |
    +------------+------------------------------------------------------+
    | <N bytes>  | The filename                                         |
    +------------+------------------------------------------------------+

The server responds with either:

    +------------+------------------------------------------------------+
    | OK         | The command completed OK.  The file contents will    |
    |            | follow.                                              |
    +------------+------------------------------------------------------+
    | <NNNNN>    | Length of the following data                         |
    +------------+------------------------------------------------------+
    | <N bytes>  | The data from from the file                          |
    +------------+------------------------------------------------------+

or:

    +------------+------------------------------------------------------+
    | !E         | There was an error reading the file                  |
    +------------+------------------------------------------------------+


Change Directory
----------------

The format of the message from the client is:

    +------------+------------------------------------------------------+
    | CD         | Change directory command                             |
    +------------+------------------------------------------------------+
    | <NNNNN>    | Length of pathname                                   |
    +------------+------------------------------------------------------+
    | <N bytes>  | The pathname                                         |
    +------------+------------------------------------------------------+

The server responds with either:

    +------------+------------------------------------------------------+
    | OK         | The command completed OK                             |
    +------------+------------------------------------------------------+

or:

    +------------+------------------------------------------------------+
    | !E         | There was an error changing to the directory         |
    +------------+------------------------------------------------------+


Create Directory
----------------

The format of the message from the client is:

    +------------+------------------------------------------------------+
    | MD         | Create directory command                             |
    +------------+------------------------------------------------------+
    | <NNNNN>    | Length of pathname                                   |
    +------------+------------------------------------------------------+
    | <N bytes>  | The pathname                                         |
    +------------+------------------------------------------------------+

The server responds with either:

    +------------+------------------------------------------------------+
    | OK         | The command completed OK                             |
    +------------+------------------------------------------------------+

or:

    +------------+------------------------------------------------------+
    | !E         | There was an error creating the directory            |
    +------------+------------------------------------------------------+


List Files
----------

The format of the message from the client is:

    +------------+------------------------------------------------------+
    | LS         | List files command                                   |
    +------------+------------------------------------------------------+

The server responds with either:

    +------------+------------------------------------------------------+
    | OK         | The command completed OK                             |
    +------------+------------------------------------------------------+
    | <NNNNN>    | The number of filenames                              |
    +------------+------------------------------------------------------+
    | <NNNNN>    | Length of filename 1                                 |
    +------------+------------------------------------------------------+
    | <N bytes>  | Filename 1                                           |
    +------------+------------------------------------------------------+
    ... above 2 fields repeated ...
    +------------+------------------------------------------------------+
    | <NNNNN>    | Length of filename N                                 |
    +------------+------------------------------------------------------+
    | <N bytes>  | Filename N                                           |
    +------------+------------------------------------------------------+

or:

    +------------+------------------------------------------------------+
    | !E         | There was an error reading the directory             |
    +------------+------------------------------------------------------+