Enlightenment CVS committal
Author : ncn
Project : e17
Module : libs/ecore
Dir : e17/libs/ecore/src/lib/ecore_ipc
Modified Files:
ecore_ipc.c
Log Message:
Spelling fix in ecore.c.in, more docs for src/lib/ecore/ecore_list.c, fix in
src/lib/ecore_con/ecore_con.c and new docs for src/lib/ecore_ipc/ecore_ipc.c.
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore_ipc/ecore_ipc.c,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -3 -r1.11 -r1.12
--- ecore_ipc.c 27 May 2004 05:33:32 -0000 1.11
+++ ecore_ipc.c 22 Jul 2004 13:07:25 -0000 1.12
@@ -191,9 +191,9 @@
static int init_count = 0;
static Ecore_Ipc_Server *servers = NULL;
/**
- * To be documented.
- *
- * FIXME: To be fixed.
+ * Initialises the Ecore IPC library.
+ * @return Number of times the library has been initialised without
+ * being shut down.
*/
int
ecore_ipc_init(void)
@@ -220,9 +220,9 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
+ * Shuts down the Ecore IPC library.
+ * @return Number of times the library has been initialised without being
+ * shut down.
*/
int
ecore_ipc_shutdown(void)
@@ -238,9 +238,17 @@
}
/**
- * To be documented.
+ * Creates an IPC server that listens for connections.
*
- * FIXME: To be fixed.
+ * For more details about the @p compl_type, @p name and @p port
+ * parameters, see the @ref ecore_con_server_add documentation.
+ *
+ * @param compl_type The connection type.
+ * @param name Name to associate with the socket used for connection.
+ * @param port Number to identify with socket used for connection.
+ * @param data Data to associate with the IPC server.
+ * @return New IPC server. If there is an error, @c NULL is returned.
+ * @todo Need to add protocol type parameter to this function.
*/
Ecore_Ipc_Server *
ecore_ipc_server_add(Ecore_Ipc_Type compl_type, char *name, int port, const void
*data)
@@ -283,9 +291,20 @@
}
/**
- * To be documented.
+ * Creates an IPC server object to represent the IPC server listening
+ * on the given port.
+ *
+ * For more details about the @p compl_type, @p name and @p port
+ * parameters, see the @ref ecore_con_server_connect documentation.
*
- * FIXME: To be fixed.
+ * @param compl_type The IPC connection type.
+ * @param name Name used to determine which socket to use for the
+ * IPC connection.
+ * @param port Number used to identify the socket to use for the
+ * IPC connection.
+ * @param data Data to associate with the server.
+ * @return A new IPC server. @c NULL is returned on error.
+ * @todo Need to add protocol type parameter.
*/
Ecore_Ipc_Server *
ecore_ipc_server_connect(Ecore_Ipc_Type compl_type, char *name, int port, const void
*data)
@@ -328,9 +347,9 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
+ * Closes the connection and frees the given IPC server.
+ * @param svr The given IPC server.
+ * @return The data associated with the server when it was created.
*/
void *
ecore_ipc_server_del(Ecore_Ipc_Server *svr)
@@ -354,9 +373,9 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
+ * Retrieves the data associated with the given IPC server.
+ * @param svr The given IPC server.
+ * @return The associated data.
*/
void *
ecore_ipc_server_data_get(Ecore_Ipc_Server *svr)
@@ -371,9 +390,9 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
+ * Retrieves whether the given IPC server is currently connected.
+ * @param svr The given IPC server.
+ * @return @c 1 if the server is connected. @c 0 otherwise.
*/
int
ecore_ipc_server_connected_get(Ecore_Ipc_Server *svr)
@@ -420,9 +439,17 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
+ * Sends a message to the given IPC server.
+ * @param svr The given IPC server.
+ * @param major Major opcode of the message.
+ * @param minor Minor opcode of the message.
+ * @param ref Message reference number.
+ * @param ref_to
+ * @param response
+ * @param data The data to send as part of the message.
+ * @param size Length of the data, in bytes, to send.
+ * @return Number of bytes sent. @c 0 is returned if there is an error.
+ * @todo This function needs to become an IPC message.
*/
int
ecore_ipc_server_send(Ecore_Ipc_Server *svr, int major, int minor, int ref, int
ref_to, int response, void *data, int size)
@@ -499,9 +526,18 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
+ * Sends a message to the given IPC client.
+ * @param cl The given IPC client.
+ * @param major Major opcode of the message.
+ * @param minor Minor opcode of the message.
+ * @param ref Reference number of the message.
+ * @param ref_to
+ * @param response
+ * @param data The data to send as part of the message.
+ * @param size Length of the data, in bytes, to send.
+ * @return The number of bytes sent. @c 0 will be returned if there is
+ * an error.
+ * @todo This function needs to become an IPC message.
*/
int
ecore_ipc_client_send(Ecore_Ipc_Client *cl, int major, int minor, int ref, int
ref_to, int response, void *data, int size)
@@ -546,9 +582,9 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
+ * Retrieves the IPC server that the given IPC client is connected to.
+ * @param cl The given IPC client.
+ * @return The IPC server the IPC client is connected to.
*/
Ecore_Ipc_Server *
ecore_ipc_client_server_get(Ecore_Ipc_Client *cl)
@@ -563,9 +599,10 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
+ * Closes the connection and frees memory allocated to the given IPC
+ * client.
+ * @param cl The given client.
+ * @return Data associated with the client.
*/
void *
ecore_ipc_client_del(Ecore_Ipc_Client *cl)
@@ -590,9 +627,9 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
+ * Sets the IPC data associated with the given IPC client to @p data.
+ * @param cl The given IPC client.
+ * @param data The data to associate with the IPC client.
*/
void
ecore_ipc_client_data_set(Ecore_Ipc_Client *cl, const void *data)
@@ -607,9 +644,9 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
+ * Retrieves the data that has been associated with the given IPC client.
+ * @param cl The given client.
+ * @return The data associated with the IPC client.
*/
void *
ecore_ipc_client_data_get(Ecore_Ipc_Client *cl)
-------------------------------------------------------
This SF.Net email is sponsored by BEA Weblogic Workshop
FREE Java Enterprise J2EE developer tools!
Get your free copy of BEA WebLogic Workshop 8.1 today.
http://ads.osdn.com/?ad_id=4721&alloc_id=10040&op=click
_______________________________________________
enlightenment-cvs mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
