Cured some bugs/typos/spacing in docs

[wxWidgets.git] / src / unix / gsockunx.h

diff --git a/src/unix/gsockunx.h b/src/unix/gsockunx.h
index 5294e6f84b0d91446401e70047839f8450095692..75a70ceee94cb624876b32ab37817540929dd740 100644 (file)
--- a/src/unix/gsockunx.h
+++ b/src/unix/gsockunx.h
@@ -1,3 +1,10 @@
+/* -------------------------------------------------------------------------
+ * Project: GSocket (Generic Socket) for WX
+ * Name:    gsockunx.h
+ * Purpose: GSocket Unix header
+ * CVSID:   $Id$
+ * -------------------------------------------------------------------------
+ */
 #ifndef __GSOCK_UNX_H
 #define __GSOCK_UNX_H
 
@@ -10,9 +17,10 @@ struct _GSocket {
   GSocketError m_error;
 
   bool m_blocking, m_server, m_stream, m_oriented;
+  unsigned long m_timeout;
 
-  /* Fallbacks */
-  GSocketFallback m_fbacks[GSOCK_MAX_EVENT];
+  /* Callbacks */
+  GSocketCallback m_fbacks[GSOCK_MAX_EVENT];
   char *m_data[GSOCK_MAX_EVENT];
 
   /* IO calls associated */
@@ -38,20 +46,24 @@ int _GSocket_Recv_Stream(GSocket *socket, char *buffer, int size);
 int _GSocket_Recv_Dgram(GSocket *socket, char *buffer, int size);
 int _GSocket_Send_Stream(GSocket *socket, const char *buffer, int size);
 int _GSocket_Send_Dgram(GSocket *socket, const char *buffer, int size);
-void _GSocket_Install_Fallback(GSocket *socket, GSocketEvent count);
-void _GSocket_Uninstall_Fallback(GSocket *socket, GSocketEvent count);
+void _GSocket_Install_Callback(GSocket *socket, GSocketEvent count);
+void _GSocket_Uninstall_Callback(GSocket *socket, GSocketEvent count);
 void _GSocket_Detected_Read(GSocket *socket);
 void _GSocket_Detected_Write(GSocket *socket);
 void _GSocket_GUI_Init(GSocket *socket);
 void _GSocket_GUI_Destroy(GSocket *socket);
-void _GAddress_translate_from(GAddress *address,
-                              struct sockaddr *addr, int len);
-void _GAddress_translate_to(GAddress *address,
-                            struct sockaddr **addr, int *len);
+
+/* Translaters returns false when memory is exhausted */
+GSocketError _GAddress_translate_from(GAddress *address,
+                                      struct sockaddr *addr, int len);
+GSocketError _GAddress_translate_to(GAddress *address,
+                                    struct sockaddr **addr, int *len);
+
+/* Initialisers returns FALSE when an error happened in the initialisation */
 
 /* Internet address family */
-void _GAddress_Init_INET(GAddress *address);
+GSocketError _GAddress_Init_INET(GAddress *address);
 /* Local address family */
-void _GAddress_Init_UNIX(GAddress *address);
+GSocketError _GAddress_Init_UNIX(GAddress *address);
 
 #endif