clarify a comment

[simgrid.git] / src / gras / Transport / transport_interface.h

diff --git a/src/gras/Transport/transport_interface.h b/src/gras/Transport/transport_interface.h
index 44f8dc3..78421a5 100644 (file)
--- a/src/gras/Transport/transport_interface.h
+++ b/src/gras/Transport/transport_interface.h
@@ -13,17 +13,16 @@
 #ifndef GRAS_TRP_INTERFACE_H
 #define GRAS_TRP_INTERFACE_H
 
-#include "gras_private.h"
-
 /***
  *** Main user functions
  ***/
 gras_error_t gras_trp_chunk_send(gras_socket_t *sd,
                                 char *data,
-                                size_t size);
+                                long int size);
 gras_error_t gras_trp_chunk_recv(gras_socket_t *sd,
                                 char *data,
-                                size_t size);
+                                long int size);
+gras_error_t gras_trp_flush(gras_socket_t *sd);
 
 /* Find which socket needs to be read next */
 gras_error_t 
@@ -31,12 +30,6 @@ gras_trp_select(double timeout,
                gras_socket_t **dst);
 
 
-/***
- *** Module declaration 
- ***/
-gras_error_t gras_trp_init(void);
-void         gras_trp_exit(void);
-
 /***
  *** Plugin mecanism 
  ***/
@@ -44,31 +37,20 @@ void         gras_trp_exit(void);
 /* A plugin type */
 typedef struct gras_trp_plugin_ gras_trp_plugin_t;
 
-
-/**
- * e_gras_trp_plugin:
- * 
- * Caracterize each possible transport plugin
- */
-typedef enum e_gras_trp_plugin {
-   e_gras_trp_plugin_undefined = 0,
-     
-     e_gras_trp_plugin_tcp
-} gras_trp_plugin_type_t;
-
 /* A plugin type */
 struct gras_trp_plugin_ {
   char          *name;
  
+  /* dst pointers are created and initialized with default values 
+     before call to socket_client/server*/
   gras_error_t (*socket_client)(gras_trp_plugin_t *self,
                                const char *host,
                                unsigned short port,
-                               unsigned int bufSize,
-                               /* OUT */ gras_socket_t **dst);
+                               /* OUT */ gras_socket_t *dst);
   gras_error_t (*socket_server)(gras_trp_plugin_t *self,
                                unsigned short port,
-                               unsigned int bufSize,
-                               /* OUT */ gras_socket_t **dst);
+                               /* OUT */ gras_socket_t *dst);
+   
   gras_error_t (*socket_accept)(gras_socket_t  *sock,
                                /* OUT */gras_socket_t **dst);
    
@@ -78,14 +60,20 @@ struct gras_trp_plugin_ {
   void         (*socket_close)(gras_socket_t *sd);
     
   gras_error_t (*chunk_send)(gras_socket_t *sd,
-                            char *data,
-                            size_t size);
+                            const char *data,
+                            long int size);
   gras_error_t (*chunk_recv)(gras_socket_t *sd,
                             char *Data,
-                            size_t size);
+                            long int size);
 
-  void          *specific;
-  void         (*free_specific)(void *);
+  /* flush has to make sure that the pending communications are achieved */
+  gras_error_t (*flush)(gras_socket_t *sd);
+
+  void          *data; /* plugin-specific data */
+ 
+   /* exit is responsible for freeing data and telling the OS this plugin goes */
+   /* exit=NULL, data gets freed. (ie exit function needed only when data contains pointers) */
+  void         (*exit)(gras_trp_plugin_t *);
 };
 
 gras_error_t