Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
sizes are unsigned long int
[simgrid.git] / src / gras / Transport / transport_interface.h
index d23f05e..595deab 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,
+xbt_error_t gras_trp_chunk_send(gras_socket_t sd,
                                 char *data,
-                                size_t size);
-gras_error_t gras_trp_chunk_recv(gras_socket_t *sd,
+                                long int size);
+xbt_error_t gras_trp_chunk_recv(gras_socket_t sd,
                                 char *data,
-                                size_t size);
+                                long int size);
+xbt_error_t gras_trp_flush(gras_socket_t sd);
 
 /* Find which socket needs to be read next */
-gras_error_t 
+xbt_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 
+ *** Plugin mechanism 
  ***/
 
 /* A plugin type */
@@ -46,39 +40,52 @@ 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*/
-  gras_error_t (*socket_client)(gras_trp_plugin_t *self,
-                               const char *host,
-                               unsigned short port,
-                               int raw,
-                               /* OUT */ gras_socket_t *dst);
-  gras_error_t (*socket_server)(gras_trp_plugin_t *self,
-                               unsigned short port,
-                               int raw,
-                               /* 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. */
+  xbt_error_t (*socket_client)(gras_trp_plugin_t *self,
+                               gras_socket_t      dst);
+  xbt_error_t (*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);
+  xbt_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,
-                            size_t size);
-  gras_error_t (*chunk_recv)(gras_socket_t *sd,
-                            char *Data,
-                            size_t size);
-
-  void          *specific;
-  void         (*free_specific)(void *);
+  xbt_error_t (*chunk_send)(gras_socket_t sd,
+                            const char *data,
+                           unsigned long int size);
+  xbt_error_t (*chunk_recv)(gras_socket_t sd,
+                           char *data,
+                           unsigned long int size);
+
+  /* flush has to make sure that the pending communications are achieved */
+  xbt_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
+xbt_error_t
 gras_trp_plugin_get_by_name(const char *name,
                            gras_trp_plugin_t **dst);
 
+/* 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 */