3 /* transport - low level communication (send/receive bunches of bytes) */
5 /* module's public interface exported within GRAS, but not to end user. */
7 /* Copyright (c) 2004 Martin Quinson. All rights reserved. */
9 /* This program is free software; you can redistribute it and/or modify it
10 * under the terms of the license (GNU LGPL) which comes with this package. */
12 #ifndef GRAS_TRP_INTERFACE_H
13 #define GRAS_TRP_INTERFACE_H
16 *** Main user functions
18 xbt_error_t gras_trp_chunk_send(gras_socket_t sd,
21 xbt_error_t gras_trp_chunk_recv(gras_socket_t sd,
24 xbt_error_t gras_trp_flush(gras_socket_t sd);
26 /* Find which socket needs to be read next */
28 gras_trp_select(double timeout,
37 typedef struct gras_trp_plugin_ gras_trp_plugin_t;
40 struct gras_trp_plugin_ {
43 /* dst pointers are created and initialized with default values
44 before call to socket_client/server.
45 Retrive the info you need from there. */
46 xbt_error_t (*socket_client)(gras_trp_plugin_t *self,
48 xbt_error_t (*socket_server)(gras_trp_plugin_t *self,
51 xbt_error_t (*socket_accept)(gras_socket_t sock,
55 /* socket_close() is responsible of telling the OS that the socket is over,
56 but should not free the socket itself (beside the specific part) */
57 void (*socket_close)(gras_socket_t sd);
59 xbt_error_t (*chunk_send)(gras_socket_t sd,
62 xbt_error_t (*chunk_recv)(gras_socket_t sd,
66 /* flush has to make sure that the pending communications are achieved */
67 xbt_error_t (*flush)(gras_socket_t sd);
69 void *data; /* plugin-specific data */
71 /* exit is responsible for freeing data and telling the OS this plugin goes */
72 /* exit=NULL, data gets freed. (ie exit function needed only when data contains pointers) */
73 void (*exit)(gras_trp_plugin_t *);
77 gras_trp_plugin_get_by_name(const char *name,
78 gras_trp_plugin_t **dst);
80 #endif /* GRAS_TRP_INTERFACE_H */