/* 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
+#include "portable.h" /* sometimes needed for fd_set */
+
+/***
+ *** Options
+ ***/
+extern int gras_opt_trp_nomoredata_on_close;
+
/***
*** Main user functions
***/
-gras_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,
- char *data,
- size_t size);
+/* stable if we know the storage will keep as is until the next trp_flush */
+void gras_trp_send(gras_socket_t sd, char *data, long int size, int stable);
+void gras_trp_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);
+/* Set the peer process name (used by messaging layer) */
+void gras_socket_peer_proc_set(gras_socket_t sock,char*peer_proc);
/***
- *** 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;
-
-
-/**
- * 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;
+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,
- size_t size);
- gras_error_t (*chunk_recv)(gras_socket_t *sd,
- char *Data,
- size_t size);
-
- void *specific;
- void (*free_specific)(void *);
+ /* send/recv may be buffered */
+ void (*send)(gras_socket_t sd,
+ const char *data,
+ unsigned long int size,
+ int stable /* storage will survive until flush*/);
+ int (*recv)(gras_socket_t sd,
+ char *data,
+ unsigned long int size);
+ /* raw_send/raw_recv is never buffered (use it for measurement stuff) */
+ void (*raw_send)(gras_socket_t sd,
+ const char *data,
+ unsigned long int size);
+ int (*raw_recv)(gras_socket_t sd,
+ char *data,
+ unsigned long int size);
+
+ /* 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 */
+ /* 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 {
+ /* set headers */
+ unsigned int ID;
+ char *name;
+ unsigned int name_len;
+
+ xbt_dynar_t sockets; /* all sockets known to this process */
+ int myport; /* Port on which I listen myself */
+ fd_set *fdset;
+
+ /* SG only elements. In RL, they are part of the OS ;) */
+ int chan; /* Formated messages channel */
+ int measChan; /* Unformated echange channel for performance measurement*/
+
+} s_gras_trp_procdata_t,*gras_trp_procdata_t;
+
+/* Display the content of our socket set (debugging purpose) */
+void gras_trp_socketset_dump(const char *name);
#endif /* GRAS_TRP_INTERFACE_H */
