Mercurial > 510ConnectbotMonitor
annotate xml/510connectbotmonitor.in @ 23:2586a4f5c8c3
add mechanism to allow getfield from other threads
author | Carl Byington <carl@five-ten-sg.com> |
---|---|
date | Fri, 01 May 2015 11:52:31 -0700 |
parents | a94ca5a89fe8 |
children | 3975d341e3dd |
rev | line source |
---|---|
1 | 1 <reference> |
2 <title>@PACKAGE@ - Version @VERSION@</title> | |
3 <partintro> | |
4 <title>Packages</title> | |
5 | |
6 <para>The various source and binary packages are available at <ulink | |
7 url="http://www.five-ten-sg.com/@PACKAGE@/packages/">http://www.five-ten-sg.com/@PACKAGE@/packages/</ulink>. | |
8 The most recent documentation is available at <ulink | |
9 url="http://www.five-ten-sg.com/@PACKAGE@/">http://www.five-ten-sg.com/@PACKAGE@/</ulink>. | |
10 </para> | |
11 | |
12 <para>A <ulink | |
13 url="http://www.selenic.com/mercurial/wiki/">Mercurial</ulink> source | |
14 code repository for this project is available at <ulink | |
15 url="http://hg.five-ten-sg.com/@PACKAGE@/">http://hg.five-ten-sg.com/@PACKAGE@/</ulink>. | |
16 </para> | |
17 | |
18 </partintro> | |
19 | |
20 <refentry id="x@PACKAGE@.1"> | |
21 <refentryinfo> | |
16
a481d8fb5571
add switch session command to the TE
Carl Byington <carl@five-ten-sg.com>
parents:
13
diff
changeset
|
22 <date>2014-07-01</date> |
1 | 23 <author> |
24 <firstname>Carl</firstname> | |
25 <surname>Byington</surname> | |
26 <affiliation><orgname>510 Software Group</orgname></affiliation> | |
27 </author> | |
28 </refentryinfo> | |
29 | |
30 <refmeta> | |
31 <refentrytitle>@PACKAGE@</refentrytitle> | |
32 <manvolnum>1</manvolnum> | |
33 <refmiscinfo>@PACKAGE@ @VERSION@</refmiscinfo> | |
34 </refmeta> | |
35 | |
36 <refnamediv id='name.1'> | |
37 <refname>@PACKAGE@</refname> | |
38 <refpurpose>a monitoring package for the android terminal emulator</refpurpose> | |
39 </refnamediv> | |
40 | |
41 <refsect1 id='build.1'> | |
42 <title>Build method</title> | |
43 <para> | |
44 This is an android project with no native code, so | |
45 "android update project -p . -t android-16; ant debug" | |
46 should build cleanly. | |
47 </para> | |
48 </refsect1> | |
49 | |
50 <refsect1 id='introduction.1'> | |
51 <title>Introduction</title> | |
52 <para> | |
53 This is a stub monitoring application for the related | |
54 510 Connectbot android terminal emulator package. | |
55 </para> | |
56 </refsect1> | |
57 | |
58 <refsect1 id='monitor.1'> | |
59 <title>Terminal Monitor</title> | |
60 <para> | |
2 | 61 For every terminal session (local, telnet, ssh or tn5250), the |
1 | 62 terminal emulator also makes a connection to a terminal monitor |
2 | 63 process, which can see cursor movement and screen contents, and can |
1 | 64 inject characters to send to the host. |
65 </para> | |
66 | |
67 <para> | |
68 The terminal monitor is invoked by calling an android Intent | |
69 named "com.five_ten_sg.connectbot.monitor.MonitorService". That | |
70 ensures that the monitor process is running, and should then | |
71 be listening on TCP port 6000 for incoming connections. The terminal | |
72 emulator then connects to the terminal monitor on port 6000. | |
73 The native android Intent and Service communication mechanisms | |
74 are not used. | |
75 </para> | |
76 | |
77 <para> | |
78 The messages exchanged between the terminal emulator and the | |
79 terminal monitor are arrays of uint16 values in network byte | |
80 order. Each message starts with a uint16 message byte length, | |
81 followed by that many bytes of data. Note that the message length | |
82 will always be even. The next uint16 contains the message | |
83 command value, and the remaining uint16 values are the arguments | |
84 if any for that command. | |
85 </para> | |
86 | |
87 <para> | |
88 Any arguments that are keystrokes or characters are represented | |
89 as 16 bit unicode. Note that the first 256 such characters are | |
90 identical to the ISO-8859-1 latin character set. | |
91 </para> | |
92 | |
93 <para> | |
94 INIT = 0 (TE -> Monitor). The argument is a string of uint16 | |
95 characters. The meaning of these characters is defined by the | |
96 monitor. It might be a fully qualified path name, or some other | |
97 data used by the monitor to drive the monitoring of this | |
98 connection. | |
99 </para> | |
100 | |
101 <para> | |
102 ACTIVATE = 1 (TE -> Monitor). The first argument is the | |
103 number of lines. The second argument is the number of columns. | |
104 That is followed by lines*columns uint16 character codes. | |
105 This connection is now the active connection. It is the | |
106 topmost (or only) window visible to the user - typed keystrokes | |
107 will be sent to the host on the other end of this connection. | |
108 </para> | |
109 | |
110 <para> | |
2 | 111 KEYSTATE = 2 (TE -> Monitor). The argument is a single uint16 |
112 value, 1 for key down, 0 for key up. The TE tracks a single special | |
113 key for the monitor, and reports key up/down state when it changes. | |
114 The actual key is configurable. | |
1 | 115 </para> |
116 | |
117 <para> | |
118 CURSORMOVE = 3 (TE -> Monitor). | |
23
2586a4f5c8c3
add mechanism to allow getfield from other threads
Carl Byington <carl@five-ten-sg.com>
parents:
18
diff
changeset
|
119 The first argument is the line number (0..23), |
2586a4f5c8c3
add mechanism to allow getfield from other threads
Carl Byington <carl@five-ten-sg.com>
parents:
18
diff
changeset
|
120 the second argument is the column number (0..79), and the third |
2586a4f5c8c3
add mechanism to allow getfield from other threads
Carl Byington <carl@five-ten-sg.com>
parents:
18
diff
changeset
|
121 argument is the reason for sending this cursor update. REASON=0 is |
2586a4f5c8c3
add mechanism to allow getfield from other threads
Carl Byington <carl@five-ten-sg.com>
parents:
18
diff
changeset
|
122 from a previous CURSORREQUEST command. REASON=1 is a cursor update |
2586a4f5c8c3
add mechanism to allow getfield from other threads
Carl Byington <carl@five-ten-sg.com>
parents:
18
diff
changeset
|
123 related to the previous SCREENCHANGE buffer update. REASON=2 is |
2586a4f5c8c3
add mechanism to allow getfield from other threads
Carl Byington <carl@five-ten-sg.com>
parents:
18
diff
changeset
|
124 a cursor update caused by user keystrokes. |
1 | 125 </para> |
126 | |
127 <para> | |
128 SCREENCHANGE = 4 (TE -> Monitor). The first argument is the | |
129 number of lines. The second argument is the number of columns. | |
130 That is followed by lines*columns uint16 character codes. | |
131 </para> | |
132 | |
133 <para> | |
134 FIELDVALUE = 5 (TE -> Monitor). | |
135 SETFIELD = 5 (Monitor -> TE). | |
136 The first argument is the line number (0..23) | |
137 and the second argument is the column number (0..79). | |
138 That is followed by the field value, a sequence of uint16 | |
139 character codes from the screen buffer. The field | |
140 covers N columns, where N = (message length - 4) / 2. | |
141 When sent from the monitor to the emulator, this causes | |
18
a94ca5a89fe8
add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents:
16
diff
changeset
|
142 the emulator to send the field codes to the host (for async |
a94ca5a89fe8
add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents:
16
diff
changeset
|
143 modes) or to set the specified field contents (for block modes). |
a94ca5a89fe8
add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents:
16
diff
changeset
|
144 This is also used as the reply message from the emulator to the |
1 | 145 monitor for a previous GETFIELD from the monitor. |
146 </para> | |
147 | |
148 <para> | |
149 GETFIELD = 6 (Monitor -> TE). | |
150 The first argument is the line number (0..23) | |
151 and the second argument is the starting column number (0..79), | |
152 and the third argument is the field length in columns. | |
153 This command causes the emulator to send a FIELDVALUE message | |
154 back to the monitor. | |
155 </para> | |
156 | |
157 <para> | |
158 SCREENWATCH = 7 (Monitor -> TE). | |
159 The first argument is the line number (0..23) | |
160 and the second argument is the starting column number (0..79), | |
161 and the third argument is the field length in columns. | |
162 This command causes the emulator to watch the specified | |
163 part of the screen for changes. When that part of the screen | |
164 changes, the emulator will send a SCREENCHANGE message back | |
165 to the monitor. | |
166 </para> | |
2 | 167 |
168 <para> | |
13 | 169 DEPRESS = 8 (Monitor -> TE). The argument is a single uint16 |
170 value containing the vk_key value. This command causes the emulator | |
171 to simulate a keypress for that key. The codes are defined | |
172 <ulink url="http://msdn.microsoft.com/en-us/library/windows/desktop/dd375731">here</ulink>. | |
173 </para> | |
174 | |
175 <para> | |
176 SHOWURL = 9 (Monitor -> TE). The single argument is a sequence | |
177 of uint16 character codes forming a URL to be displayed. | |
2 | 178 </para> |
16
a481d8fb5571
add switch session command to the TE
Carl Byington <carl@five-ten-sg.com>
parents:
13
diff
changeset
|
179 |
a481d8fb5571
add switch session command to the TE
Carl Byington <carl@five-ten-sg.com>
parents:
13
diff
changeset
|
180 <para> |
a481d8fb5571
add switch session command to the TE
Carl Byington <carl@five-ten-sg.com>
parents:
13
diff
changeset
|
181 SWITCHSESSION = 10 (Monitor -> TE). There are no arguments. The TE |
a481d8fb5571
add switch session command to the TE
Carl Byington <carl@five-ten-sg.com>
parents:
13
diff
changeset
|
182 should display this session. |
a481d8fb5571
add switch session command to the TE
Carl Byington <carl@five-ten-sg.com>
parents:
13
diff
changeset
|
183 </para> |
18
a94ca5a89fe8
add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents:
16
diff
changeset
|
184 |
a94ca5a89fe8
add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents:
16
diff
changeset
|
185 <para> |
a94ca5a89fe8
add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents:
16
diff
changeset
|
186 CURSORREQUEST = 11 (Monitor -> TE). There are no arguments. The TE |
a94ca5a89fe8
add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents:
16
diff
changeset
|
187 should send a CURSORMOVE update to the monitor. Cursor movement caused |
a94ca5a89fe8
add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents:
16
diff
changeset
|
188 by SETFIELD or DEPRESS commands does not trigger CURSORMOVE updates |
a94ca5a89fe8
add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents:
16
diff
changeset
|
189 in block mode (tn5250) sessions. Those commands do trigger CURSORMOVE |
a94ca5a89fe8
add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents:
16
diff
changeset
|
190 updates in async mode (telnet, ssh) sessions. |
a94ca5a89fe8
add cursor request command to the TE
Carl Byington <carl@five-ten-sg.com>
parents:
16
diff
changeset
|
191 </para> |
1 | 192 </refsect1> |
193 | |
194 <refsect1 id='todo.1'> | |
195 <title>TODO</title> | |
196 <para> | |
197 Nothing. | |
198 </para> | |
199 </refsect1> | |
200 | |
201 <refsect1 id='copyright.1'> | |
202 <title>Copyright</title> | |
203 <para> | |
204 Copyright (C) 2014 by 510 Software Group <carl@five-ten-sg.com> | |
205 </para> | |
206 <para> | |
207 This program is free software; you can redistribute it and/or modify it | |
208 under the terms of the GNU General Public License as published by the | |
209 Free Software Foundation; either version 3, or (at your option) any | |
210 later version. | |
211 </para> | |
212 <para> | |
213 You should have received a copy of the GNU General Public License along | |
214 with this program; see the file COPYING. If not, please write to the | |
215 Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. | |
216 </para> | |
217 </refsect1> | |
218 | |
219 <refsect1 id='version.1'> | |
220 <title>Version</title> | |
221 <para> | |
222 @VERSION@ | |
223 </para> | |
224 </refsect1> | |
225 </refentry> | |
226 | |
227 </reference> |