Enlightenment CVS committal
Author : dj2
Project : e17
Module : docs
Dir : e17/docs/cookbook/xml/ecore
Modified Files:
ecore_config_intro.xml ecore_ipc_intro.xml
Log Message:
- minor xml cleanups
- wrap functions in the <function></function> tag
===================================================================
RCS file: /cvsroot/enlightenment/e17/docs/cookbook/xml/ecore/ecore_config_intro.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- ecore_config_intro.xml 2 Jul 2004 22:17:45 -0000 1.1
+++ ecore_config_intro.xml 4 Jul 2004 19:34:31 -0000 1.2
@@ -61,8 +61,9 @@
</example>
<para>
As you can see from this example the basic usage of Ecore_Config is simple. The
system is initialized with
-a call to ecore_config_init(PROGRAM_NAME). The program name setting control where
Ecore_Config will look for
-your configuration database. The directory and file name are:
~/.e/apps/PROGRAM_NAME/config.db.
+a call to <function>ecore_config_init</function>. The program name setting control
where
+Ecore_Config will look for your configuration database. The directory and file name
+are: ~/.e/apps/PROGRAM_NAME/config.db.
</para>
<para>
@@ -73,14 +74,15 @@
</para>
<para>
-The ecore_config_load call will read the values from the config.db file into
Ecore_Config. After which we can
+The <function>ecore_config_load</function> call will read the values from the
config.db file into Ecore_Config.
+After which we can
access the files with the ecore_config_*_get methods (again * is the type of data
desired). These routines
take the key name for this item and return the value associated with that key. Each
function returns a type
that corresponds to the function call name.
</para>
<para>
-ecore_config_shutdown is then called to shutdown the Ecore_Config system before the
program exits.
+<function>ecore_config_shutdown</function> is then called to shutdown the
Ecore_Config system before the program exits.
</para>
<example>
===================================================================
RCS file: /cvsroot/enlightenment/e17/docs/cookbook/xml/ecore/ecore_ipc_intro.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- ecore_ipc_intro.xml 2 Jul 2004 22:17:45 -0000 1.1
+++ ecore_ipc_intro.xml 4 Jul 2004 19:34:31 -0000 1.2
@@ -66,8 +66,9 @@
</example>
<para>
As mentioned earlier, even though we are writing a client app, we still use an
Ecore_Ipc_Server
-object. Using Ecore_Ipc requires the setup of Ecore itself. This is done with a
simple call to ecore_init().
-Ecore_Ipc is then setup with a call to ecore_ipc_init(). If either of these return 0,
the appropriate
+object. Using Ecore_Ipc requires the setup of Ecore itself. This is done with a
simple call to
+<function>ecore_init</function>.
+Ecore_Ipc is then setup with a call to <function>ecore_ipc_init</function>. If either
of these return 0, the appropriate
action is taken to undo any initialization take to this point. The
ECORE_EVENT_SIGNAL_EXIT callback
is hooked up so we can exit gracefully if required.
</para>
@@ -87,14 +88,15 @@
</example>
<para>
In this example we are creating a remote connection to the server named "localhost"
on the port 9999. This
-is done with the ecore_ipc_server_connect() method. The first parameter is the type
of connection being made,
+is done with the <function>ecore_ipc_server_connect</function> method.
+The first parameter is the type of connection being made,
which can be one of: ECORE_IPC_REMOTE_SYSTEM, ECORE_IPC_LOCAL_SYSTEM, or
ECORE_IPC_LOCAL_USER. If
OpenSSL was available when Ecore_Ipc was compiled, ECORE_IPC_USE_SSL can be or'd with
the connection type
to create an SSL connection.
</para>
<para>
-The three calls to ecore_event_handler_add() setup the callbacks for the different
types of events
+The three calls to <function>ecore_event_handler_add</function> setup the callbacks
for the different types of events
we will be receiving from the server. A server was added, a server was deleted, or
the server
sent us data.
</para>
@@ -115,8 +117,8 @@
</example>
<para>
For the purposes of this example, the client is sending a message on startup to the
server, which
-the server will respond to. The client message is sent with the
ecore_ipc_server_send() command.
-ecore_ipc_server_send() takes the server to send to, the message major, message
minor, a reference,
+the server will respond to. The client message is sent with the
<function>ecore_ipc_server_send</function> command.
+<function>ecore_ipc_server_send</function> takes the server to send to, the message
major, message minor, a reference,
a reference to, a response, the data and a size. These parameters, except for the
server are up the
the client and can refer to anything required. This hopefully gives the maximum
flexibility
in creating client/server IPC apps.
@@ -125,7 +127,7 @@
<para>
After the server message is sent we enter into the main ecore loop and wait for
events. If
the main loop is exited we delete the server object, shutdown Ecore_Ipc with a call
to
-ecore_ipc_shutdown(), and shutdown ecore through ecore_shutdown().
+<function>ecore_ipc_shutdown</function>, and shutdown ecore through
<function>ecore_shutdown</function>.
</para>
<example>
@@ -138,7 +140,7 @@
</programlisting>
</example>
<para>
-The sig_exit_cb() just tells ecore to quit the main loop.
+The <function>sig_exit_cb</function> just tells ecore to quit the main loop.
</para>
<example>
@@ -165,7 +167,8 @@
</programlisting>
</example>
<para>
-These three callbacks, handler_server_add(), handler_server_del(), and
handler_server_data()
+These three callbacks, <function>handler_server_add</function>,
+<function>handler_server_del</function>, and <function>handler_server_data</function>
are body of the client handling all events related to the server we are connected to.
Each
of the callbacks has an associated event structure, Ecore_Ipc_Event_Server_Add,
Ecore_Ipc_Event_Server_Del and Ecore_Ipc_Event_Server_Data containing information on
the
@@ -173,17 +176,17 @@
</para>
<para>
-When we first connect to the server the handler_server_add() callback will be executed
+When we first connect to the server the <function>handler_server_add</function>
callback will be executed
allowing any setup to be accomplished.
</para>
<para>
-If the server breaks the connection the handler_server_del() callback will be executed
+If the server breaks the connection the <function>handler_server_del</function>
callback will be executed
allowing any required cleanup.
</para>
<para>
-When the server sends data to the client the handler_server_data callback will the
executed.
+When the server sends data to the client the <function>handler_server_data</function>
callback will the executed.
Which in this example just prints some information about the message itself and the
message body.
</para>
@@ -208,7 +211,7 @@
<para>
As with the client, the Ecore.h header is included to get access the to the exit
signal.
The Ecore_Ipc.h header is required for apps making use of the Ecore_Ipc library. Each
-sign handler will be explained with its code.
+sig handler will be explained with its code.
</para>
<example>
@@ -246,7 +249,7 @@
</example>
<para>
Unlike the client, for the server we add a listener to port 9999 on the machine
"localhost" through
-the call ecore_ipc_server_add(). This will create and return the server object to us.
+the call <function>ecore_ipc_server_add</function>. This will create and return the
server object to us.
We then hook in the required signal handlers, the difference to the client being we
want
CLIENT events this time instead of SERVER events.
</para>
@@ -273,7 +276,7 @@
</programlisting>
</example>
<para>
-The sig_exit_cb() is again identical to that seen in the client.
+The <function>sig_exit_cb</function> is again identical to that seen in the client.
</para>
<example>
@@ -313,7 +316,8 @@
</para>
<para>
-At the end of the handler_client_data callback we do a call to
ecore_ipc_client_send().
+At the end of the <function>handler_client_data</function> callback we do a call to
+<function>ecore_ipc_client_send</function>.
This sends data to the client. As with sending data to the server, the parameters are:
the client to send to, major number, minor number, reference, reference to, response,
data and the data size.
-------------------------------------------------------
This SF.Net email sponsored by Black Hat Briefings & Training.
Attend Black Hat Briefings & Training, Las Vegas July 24-29 -
digital self defense, top technical experts, no vendor pitches,
unmatched networking opportunities. Visit www.blackhat.com
_______________________________________________
enlightenment-cvs mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
