ed_ipc

Package: Editra.src.ed_ipc

Classes and utilities for handling IPC between running instances of Editra. The IPC is done through sockets using the TCP protocol. Message packets have a specified format and authentication method that is described in EdIpcServer.

Remote Control Protocol:

This server and its relationship with the main application object allows for some limited remote control of Editra. The server’s basic message protocol requirements are as follows.

SESSION_KEY;xml;MSGEND

Where the SESSION_KEY is the unique authentication key created by the app that started the server. This key is stored in the user profile and only valid for the current running session of Editra. The MSGEND indicator is the MSGEND string defined in this file (EDEND). If both of these parts of the message are found and correct the server will forward the messages that are packed in between to the app.

Message Format:

<edipc>

<filelist>

<file name=”absolute_filepath”/>

</filelist> <arglist>

<arg name=”g” value=”2”/>

</arglist>

</edipc>

Inheritance Diagram

Inheritance diagram for module ed_ipc

Functions Summary

SendCommands

Send commands to the running instance of Editra

Classes Summary

EdIpcServer	Create an instance of IPC server for Editra. IPC is handled through
IPCArg	Xml object for holding the list of args
IPCCommand	IPC XML Command
IPCFile	Xml object for holding the list of files
IpcServerEvent	Event to signal the server has recieved some commands

Functions

---

SendCommands(xmlobj, key)

Send commands to the running instance of Editra

Parameters:

• xmlobj – EditraXml Object
• key – Server session authentication key

Returns:

bool