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 a8f84bf..78421a5 100644 (file)
--- a/src/gras/Transport/transport_interface.h
+++ b/src/gras/Transport/transport_interface.h
@@ -13,42 +13,44 @@
 #ifndef GRAS_TRP_INTERFACE_H
 #define GRAS_TRP_INTERFACE_H
 
-#include "gras_private.h"
-
-/**
- * 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;
-
+/***
+ *** Main user functions
+ ***/
+gras_error_t gras_trp_chunk_send(gras_socket_t *sd,
+                                char *data,
+                                long int size);
+gras_error_t gras_trp_chunk_recv(gras_socket_t *sd,
+                                char *data,
+                                long int size);
+gras_error_t gras_trp_flush(gras_socket_t *sd);
 
 /* Find which socket needs to be read next */
 gras_error_t 
 gras_trp_select(double timeout,
                gras_socket_t **dst);
 
-/*
-gras_error_t gras_trp_NNN_init(gras_trp_plugin_t **dst);
-*/
+
+/***
+ *** Plugin mecanism 
+ ***/
+
+/* A plugin type */
+typedef struct gras_trp_plugin_ gras_trp_plugin_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);
    
@@ -56,17 +58,22 @@ struct gras_trp_plugin_ {
    /* socket_close() is responsible of telling the OS that the socket is over,
     but should not free the socket itself (beside the specific part) */
   void         (*socket_close)(gras_socket_t *sd);
+    
+  gras_error_t (*chunk_send)(gras_socket_t *sd,
+                            const char *data,
+                            long int size);
+  gras_error_t (*chunk_recv)(gras_socket_t *sd,
+                            char *Data,
+                            long int size);
+
+  /* flush has to make sure that the pending communications are achieved */
+  gras_error_t (*flush)(gras_socket_t *sd);
+
+  void          *data; /* plugin-specific data */
  
-   
-  gras_error_t (*bloc_send)(gras_socket_t *sd,
-                            char *data,
-                            size_t size);
-  gras_error_t (*bloc_recv)(gras_socket_t *sd,
-                            char *Data,
-                            size_t size);
- 
-  void          *specific;
-  void         (*free_specific)(void *);
+   /* 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