documents/embedding/embremote.tex

34 This chapter describes the remote Tcl interface, which allows a separate
53 \item More than one Tcl (or other remote) process can be attached to a
54 single {\eclipse} via the remote interface.
55 \item For the programmer, the embedding and remote interfaces are largely
56 similar, and once the connection is established in the remote interface,
60 The remote interface thus offers more flexibility than an embedding
72 {\eclipse} side via the remote predicate call ({\bf ec_rpc}) mechanism,
80 application to be usable through both the Tcl remote and embedding
83 application (the attach and detach operations in the case of the remote
91 an embedded {\eclipse}, or the {\eclipse} process and other attached remote
100 An {\eclipse} process can have several attached remote processes. Each
101 remote process is identified by a {\bf control} name, which is the
171 \item[\index{ec_remote_init (Tcl remote interface)}{\bf ec_remote_init} {\it host port ?init_command? ?pass? ?format?}]\ \\
172 	Initialise the remote Tcl interface on the Tcl side. A
178 	{\eclipse} side (see section~\ref{remote-control} for more
205 \item[\index{ec_control_name (Tcl remote interface)}{\bf ec_control_name}]\ \\ returns the {\eclipse} name of the control
212 one side is outdated, e.g.\ if the remote Tcl interface used and the {\eclipse}
235 It is also possible to limit the remote connection to the same machine as the
249 between the remote side and the {\eclipse} side is encrypted. If the
264 remote {\eclipse} predicate call (ec_rpc) facility. This should be the
265 main method of interacting and communicating with {\eclipse} in the remote
272 \item[\index{ec_rpc (Tcl remote interface)}{\bf ec_rpc} {\it goal ?format?}]\ \\
312 compatibility with the embedding interface, many of the Tcl remote
410 \item[\index{ec_queue_create (Tcl remote interface)}ec_queue_create {\it
434 \item[\index{ec_queue_close (Tcl remote interface)}ec_queue_close {\it
485 \item[\index{ec_stream_to_window_sync (Tcl remote interface)}ec_stream_to_window_sync {\it tag text_widget stream_nr length}]\ \\
493 \item[\index{ec_stream_output_popup (Tcl remote interface)}ec_stream_output_popup {\it label_text stream_nr length}]\ \\
551 Currently, the Tcl remote interface does not support {\eclipse} handlers
571 data to the queue, and call the Tcl remote interface command {\bf ec_flush}
591 The Tcl remote interface command {\bf ec_flush}, instead of the standard
599 \item[\index{ec_flush (Tcl remote interface)}{\bf ec_flush} {\it
652 \item[\index{ec_stream_input_popup (Tcl remote interface)}{\bf ec_stream_input_popup} {\it label_text stream_nr}]\ \\
722 via the Tcl remote interface command {\bf ec_streamnum_to_channel} (see
723 section~\ref{translate-remote-qnames}). {\bf ec_flush} is called with two
808 \item[\index{ec_async_queue_create (Tcl remote interface)}ec_aysnc_queue_create {\it eclipse_stream_name ?mode?
825 \item[\index{ec_queue_close (Tcl remote interface)}ec_queue_close {\it
862 \item[\index{ec_stream_to_window (Tcl remote interface)}ec_stream_to_window {\it tag text_widget stream_nr length}]\ \\
908 remote flush, where Queue is the {\eclipse} stream number,
1016 If the Tcl remote interface command {\bf
1087 programmer intend the remote Tcl code to be usable with other {\eclipse} code.
1099 remote connection to give a unique queue name. On the {\eclipse} side,
1123 \label{translate-remote-qnames}
1125 The remote queues connecting {\eclipse} and Tcl are given different names
1126 on the two sides. The remote Tcl interface
1137 \item[\index{ec_streamname_to_channel (Tcl remote interface)}ec_streamname_to_channel {\it eclipse_name}]\ \\
1138 	Returns the Tcl channel name for the remote queue with the
1140 \item[\index{ec_streamnum_to_channel (Tcl remote
1142 	Returns the Tcl channel name for the remote queue with the
1144 \item[\index{ec_channel_to_streamnum (Tcl remote interface)}
1146 	Returns the {\eclipse} stream number for the remote queue with the
1148 \item[\index{ec_streamname_to_streamnum (Tcl remote interface)}ec_streamname_to_streamnum {\it eclipse_name}]\ \\
1149 	Returns the {\eclipse} stream number for the remote queue with the
1151 \item[\index{ec_stream_nr (Tcl remote interface)}ec_stream_nr {\it eclipse_name}]\ \\
1158 \label{remote-control}
1160 The remote interface provides additional support for controlling the
1183 has finished using the GUI provided by the particular attached remote process.
1186 all the remote queues connecting the two sides, the disconnection would
1224 \item[\index{ec_running (Tcl remote interface)}ec_running]\ \\
1229 \item[\index{ec_connected (Tcl remote interface)}ec_connected]\ \\
1233 \item[\index{ec_resume (Tcl remote interface)}ec_resume]\ \\
1240 \item[\index{ec_running_set_commands (Tcl remote interface)}ec_running_set_commands {\it ?start? ?end? ?yield? ?disconnect?}]\ \\
1249 	performing I/O on a synchronous remote queue). An explicit yield
1255 \item[\index{ec_disconnect (Tcl remote interface)}ec_disconnect {\it ?side?}]\ \\
1265 	close its connections to this remote connection, as well as
1267 	remote connection. If the disconnect was initiated from
1277 	Explicitly yields control from {\eclipse} to the remote side with
1283 	Initiates disconnection from the remote side specified by {\it
1285 	the remote side, on both sides. It will also cause an event {\it
1290 will try to disconnect from every remote side it may be connected to.
1322 \label{remote-eclipse}
1348 # the initialisation procedure, called when the remote side is attached.
1371 \label{remote-tcl}
1374 Figures~\ref{remote-eclipse} and \ref{remote-tcl} shows a simple example of
1398 The remote Tcl interface is designed to be largely compatible with the
1403 Some remote specific code would need to be written. This includes code to
1417 channels in the remote interface. This leads to the following differences:
1456 In summary, to write code that will work for both the remote and embedded
1464 GUI), then with the remote interface, the two sides might not have access
1466 interface is remote or embedded allows the user to provide code to handle
1472 \item[\index{ec_interface_type (Tcl remote interface)}ec_interface_type]\ \\
1473 	returns remote for the remote interface, and embedded for the