Adobe 65011817 - Fireworks CS4 - Mac Extended User Manual page 286

Last updated 12/8/2009
Fireworks RPC transactions pass XML between an RPC client and the Fireworks RPC server built in to Fireworks. The
RPC client is any supported program that connects to Fireworks through a TCP stream on port 12124. The Fireworks
RPC server is the internal code that listens on TCP port 12124 and then handles client requests. During the RPC
transaction, information flows from client to server:
Client
1
Estabrish TCP connection
on port 12124
3
Send XML request
6
Process XML reply
7
Disconnect TCP
connection
Note: The RPC client is not required to disconnect after each XML request. The RPC client can keep the connection open
and send additional XML requests (the TCP resubmission timeout is 30 seconds). However, only one XML request can
be outstanding at a time. In other words, the RPC client cannot send a second request until it receives a reply to the first
request, because there is no queueing mechanism to hold pending requests.
RPC client XML requests
The XML request contains the following four pieces of information for Fireworks:
• The type of operation to perform
• The name of the operation to perform
• The object on which the operation is performed
• Any parameters the operation needs
Note: XML requests are specially formatted XML document fragments, not full XML documents. XML requests are
sent to the server in UTF-8 encoding and terminated with the null (0) character.
Logically, requests contain two parts: the envelope and the parameters. The envelope specifies the requested
operation (for instance,
integers, arrays, and so on) specify how the operation happens. The envelope tag contains the parameter tag, as
follows:
<envelope><parameter /></envelope>
The RPC client sends the following four types of requests, specified in the XML tag name of the envelope:
• The
operation retrieves the current object properties. The
get
attributes and no subelements. In the following example, the client requests the value of the
object whose ID is 1:
<get obj="1" name="appDir" />
Server
2
Accept TCP connection
4
Process XML request
5
Send XML reply
8
Accept TCP
disconnect
or ) and the object that the operation is performed on. The parameters (strings,
get set
operation can contain only the
get
282
EXTENDING FIREWORKS
Cross-Product Extensions
and
obj name
property of the
appDir