Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
The change Arnaud wanted so much: Big Star Eradication (plus some more, check the...
[simgrid.git] / src / gras / Transport / transport_interface.h
index 4540a5e..d2dade3 100644 (file)
 /***
  *** Main user functions
  ***/
-gras_error_t gras_trp_chunk_send(gras_socket_t *sd,
+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,
+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_socket_t *dst);
 
 
-/***
- *** Module declaration 
- ***/
-gras_error_t gras_trp_init(void);
-void         gras_trp_exit(void);
-
 /***
  *** Plugin mecanism 
  ***/
@@ -46,35 +41,36 @@ typedef struct gras_trp_plugin_ gras_trp_plugin_t;
 struct gras_trp_plugin_ {
   char          *name;
  
-  /* dst pointers are created and initialized with default values 
-     before call to socket_client/server*/
+  /* dst pointers are created and initialized with default values
+     before call to socket_client/server. 
+     Retrive the info you need from there. */
   gras_error_t (*socket_client)(gras_trp_plugin_t *self,
-                               const char *host,
-                               unsigned short port,
-                               /* OUT */ gras_socket_t *dst);
+                               gras_socket_t      dst);
   gras_error_t (*socket_server)(gras_trp_plugin_t *self,
-                               unsigned short port,
-                               /* OUT */ gras_socket_t *dst);
+                               gras_socket_t      dst);
    
-  gras_error_t (*socket_accept)(gras_socket_t  *sock,
-                               /* OUT */gras_socket_t **dst);
+  gras_error_t (*socket_accept)(gras_socket_t  sock,
+                               gras_socket_t *dst);
    
    
    /* 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);
+  void         (*socket_close)(gras_socket_t sd);
     
-  gras_error_t (*chunk_send)(gras_socket_t *sd,
-                            char *data,
+  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,
+  gras_error_t (*chunk_recv)(gras_socket_t sd,
+                            char *data,
                             long int size);
 
-  void          *data;
+  /* 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 */
-   /* if it's NULL, data gets freed. (ie exit needed only when data contains pointers) */
+   /* exit=NULL, data gets freed. (ie exit function needed only when data contains pointers) */
   void         (*exit)(gras_trp_plugin_t *);
 };