Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
The buffered transport is now RL only (will allow a zero-copy version)
[simgrid.git] / src / gras / Transport / transport_interface.h
index 4540a5e..249db65 100644 (file)
@@ -4,11 +4,10 @@
 
 /* module's public interface exported within GRAS, but not to end user.     */
 
-/* Authors: Martin Quinson                                                  */
-/* Copyright (C) 2004 Martin Quinson.                                       */
+/* Copyright (c) 2004 Martin Quinson. All rights reserved.                  */
 
 /* This program is free software; you can redistribute it and/or modify it
  under the terms of the license (GNU LGPL) which comes with this package. */
* under the terms of the license (GNU LGPL) which comes with this package. */
 
 #ifndef GRAS_TRP_INTERFACE_H
 #define GRAS_TRP_INTERFACE_H
 /***
  *** 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);
+void gras_trp_chunk_send(gras_socket_t sd,
+                        char *data,
+                        long int size);
+void gras_trp_chunk_recv(gras_socket_t sd,
+                        char *data,
+                        long int size);
+void 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 gras_trp_select(double timeout);
 
 
 /***
- *** Module declaration 
- ***/
-gras_error_t gras_trp_init(void);
-void         gras_trp_exit(void);
-
-/***
- *** Plugin mecanism 
+ *** Plugin mechanism 
  ***/
 
 /* A plugin type */
-typedef struct gras_trp_plugin_ gras_trp_plugin_t;
+typedef struct gras_trp_plugin_ s_gras_trp_plugin_t, *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,
-                               /* OUT */ gras_socket_t *dst);
-  gras_error_t (*socket_server)(gras_trp_plugin_t *self,
-                               unsigned short port,
-                               /* OUT */ gras_socket_t *dst);
+  /* dst pointers are created and initialized with default values
+     before call to socket_client/server. 
+     Retrive the info you need from there. */
+  void (*socket_client)(gras_trp_plugin_t self,
+                       gras_socket_t    dst);
+  void (*socket_server)(gras_trp_plugin_t self,
+                       gras_socket_t    dst);
    
-  gras_error_t (*socket_accept)(gras_socket_t  *sock,
-                               /* OUT */gras_socket_t **dst);
+  gras_socket_t (*socket_accept)(gras_socket_t  from);
    
    
    /* 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,
-                            long int size);
-  gras_error_t (*chunk_recv)(gras_socket_t *sd,
-                            char *Data,
-                            long int size);
-
-  void          *data;
+  void (*chunk_send)(gras_socket_t sd,
+                    const char *data,
+                    unsigned long int size);
+  void (*chunk_recv)(gras_socket_t sd,
+                    char *data,
+                    unsigned long int size,
+                    unsigned long int bufsize);
+
+  /* flush has to make sure that the pending communications are achieved */
+  void (*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) */
-  void         (*exit)(gras_trp_plugin_t *);
+   /* exit=NULL, data gets freed. (ie exit function needed only when data contains pointers) */
+  void (*exit)(gras_trp_plugin_t);
 };
 
-gras_error_t
-gras_trp_plugin_get_by_name(const char *name,
-                           gras_trp_plugin_t **dst);
+gras_trp_plugin_t
+gras_trp_plugin_get_by_name(const char *name);
+
+/* Data of this module specific to each process
+ * (used by sg_process.c to cleanup the SG channel cruft)
+ */
+typedef struct {
+   /* SG only elements. In RL, they are part of the OS ;) */
+   int chan;    /* Formated messages channel */
+   int measChan; /* Unformated echange channel for performance measurement*/
+   xbt_dynar_t sockets; /* all sockets known to this process */
+   
+} s_gras_trp_procdata_t,*gras_trp_procdata_t;
 
 #endif /* GRAS_TRP_INTERFACE_H */