src/gras/Transport/transport_interface.h

   1 /* $Id$ */
   2
   3 /* transport - low level communication (send/receive bunches of bytes)      */
   4
   5 /* module's public interface exported within GRAS, but not to end user.     */
   6
   7 /* Authors: Martin Quinson                                                  */
   8 /* Copyright (C) 2004 Martin Quinson.                                       */
   9
  10 /* This program is free software; you can redistribute it and/or modify it
  11    under the terms of the license (GNU LGPL) which comes with this package. */
  12
  13 #ifndef GRAS_TRP_INTERFACE_H
  14 #define GRAS_TRP_INTERFACE_H
  15
  16 /***
  17  *** Main user functions
  18  ***/
  19 gras_error_t gras_trp_chunk_send(gras_socket_t *sd,
  20                                  char *data,
  21                                  long int size);
  22 gras_error_t gras_trp_chunk_recv(gras_socket_t *sd,
  23                                  char *data,
  24                                  long int size);
  25
  26 /* Find which socket needs to be read next */
  27 gras_error_t
  28 gras_trp_select(double timeout,
  29                 gras_socket_t **dst);
  30
  31
  32 /***
  33  *** Module declaration
  34  ***/
  35 gras_error_t gras_trp_init(void);
  36 void         gras_trp_exit(void);
  37
  38 /***
  39  *** Plugin mecanism
  40  ***/
  41
  42 /* A plugin type */
  43 typedef struct gras_trp_plugin_ gras_trp_plugin_t;
  44
  45 /* A plugin type */
  46 struct gras_trp_plugin_ {
  47   char          *name;
  48
  49   /* dst pointers are created and initialized with default values
  50      before call to socket_client/server*/
  51   gras_error_t (*socket_client)(gras_trp_plugin_t *self,
  52                                 const char *host,
  53                                 unsigned short port,
  54                                 /* OUT */ gras_socket_t *dst);
  55   gras_error_t (*socket_server)(gras_trp_plugin_t *self,
  56                                 unsigned short port,
  57                                 /* OUT */ gras_socket_t *dst);
  58
  59   gras_error_t (*socket_accept)(gras_socket_t  *sock,
  60                                 /* OUT */gras_socket_t **dst);
  61
  62
  63    /* socket_close() is responsible of telling the OS that the socket is over,
  64     but should not free the socket itself (beside the specific part) */
  65   void         (*socket_close)(gras_socket_t *sd);
  66
  67   gras_error_t (*chunk_send)(gras_socket_t *sd,
  68                              char *data,
  69                              long int size);
  70   gras_error_t (*chunk_recv)(gras_socket_t *sd,
  71                              char *Data,
  72                              long int size);
  73
  74   void          *data;
  75
  76    /* exit is responsible for freeing data and telling the OS this plugin goes */
  77    /* if it's NULL, data gets freed. (ie exit needed only when data contains pointers) */
  78   void         (*exit)(gras_trp_plugin_t *);
  79 };
  80
  81 gras_error_t
  82 gras_trp_plugin_get_by_name(const char *name,
  83                             gras_trp_plugin_t **dst);
  84
  85 #endif /* GRAS_TRP_INTERFACE_H */