src/include/gnunet_connection_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 2, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file include/gnunet_connection_lib.h
  23  * @brief basic, low-level TCP networking interface
  24  * @author Christian Grothoff
  25  */
  26 #ifndef GNUNET_CONNECTION_LIB_H
  27 #define GNUNET_CONNECTION_LIB_H
  28
  29 #ifdef __cplusplus
  30 extern "C"
  31 {
  32 #if 0                           /* keep Emacsens' auto-indent happy */
  33 }
  34 #endif
  35 #endif
  36
  37 #include "gnunet_network_lib.h"
  38 #include "gnunet_scheduler_lib.h"
  39 #include "gnunet_time_lib.h"
  40
  41 /**
  42  * Timeout we use on TCP connect before trying another
  43  * result from the DNS resolver.  Actual value used
  44  * is this value divided by the number of address families.
  45  * Default is 5s.
  46  */
  47 #define GNUNET_CONNECTION_CONNECT_RETRY_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
  48
  49 /**
  50  * @brief handle for a network connection
  51  */
  52 struct GNUNET_CONNECTION_Handle;
  53
  54
  55 /**
  56  * Credentials for UNIX domain sockets.
  57  */
  58 struct GNUNET_CONNECTION_Credentials
  59 {
  60   /**
  61    * UID of the other end of the connection.
  62    */
  63   uid_t uid;
  64
  65   /**
  66    * GID of the other end of the connection.
  67    */
  68   gid_t gid;
  69 };
  70
  71
  72 /**
  73  * Function to call for access control checks.
  74  *
  75  * @param cls closure
  76  * @param ucred credentials, if available, otherwise NULL
  77  * @param addr address
  78  * @param addrlen length of address
  79  * @return GNUNET_YES to allow, GNUNET_NO to deny, GNUNET_SYSERR
  80  *   for unknown address family (will be denied).
  81  */
  82 typedef int (*GNUNET_CONNECTION_AccessCheck) (void *cls,
  83                                               const struct GNUNET_CONNECTION_Credentials *ucred,
  84                                            const struct sockaddr * addr,
  85                                            socklen_t addrlen);
  86
  87
  88 /**
  89  * Callback function for data received from the network.  Note that
  90  * both "available" and "err" would be 0 if the read simply timed out.
  91  *
  92  * @param cls closure
  93  * @param buf pointer to received data
  94  * @param available number of bytes availabe in "buf",
  95  *        possibly 0 (on errors)
  96  * @param addr address of the sender
  97  * @param addrlen size of addr
  98  * @param errCode value of errno (on errors receiving)
  99  */
 100 typedef void (*GNUNET_CONNECTION_Receiver) (void *cls,
 101                                          const void *buf,
 102                                          size_t available,
 103                                          const struct sockaddr * addr,
 104                                          socklen_t addrlen, int errCode);
 105
 106 /**
 107  * Set the persist option on this connection handle.  Indicates
 108  * that the underlying socket or fd should never really be closed.
 109  * Used for indicating process death.
 110  *
 111  * @param sock the connection to set persistent
 112  */
 113 void
 114 GNUNET_CONNECTION_persist_(struct GNUNET_CONNECTION_Handle *sock);
 115
 116 /**
 117  * Create a socket handle by boxing an existing OS socket.  The OS
 118  * socket should henceforth be no longer used directly.
 119  * GNUNET_socket_destroy will close it.
 120  *
 121  * @param osSocket existing socket to box
 122  * @return the boxed socket handle
 123  */
 124 struct GNUNET_CONNECTION_Handle
 125   *GNUNET_CONNECTION_create_from_existing (struct
 126                                                    GNUNET_NETWORK_Handle
 127                                                    *osSocket);
 128
 129
 130 /**
 131  * Create a socket handle by accepting on a listen socket.  This
 132  * function may block if the listen socket has no connection ready.
 133  *
 134  * @param access function to use to check if access is allowed
 135  * @param access_cls closure for access
 136  * @param lsock listen socket
 137  * @return the socket handle, NULL on error (for example, access refused)
 138  */
 139 struct GNUNET_CONNECTION_Handle
 140   *GNUNET_CONNECTION_create_from_accept (GNUNET_CONNECTION_AccessCheck
 141                                                  access, void *access_cls,
 142                                                  struct
 143                                                  GNUNET_NETWORK_Handle
 144                                                  *lsock);
 145
 146
 147 /**
 148  * Create a socket handle by (asynchronously) connecting to a host.
 149  * This function returns immediately, even if the connection has not
 150  * yet been established.  This function only creates TCP connections.
 151  *
 152  * @param cfg configuration to use
 153  * @param hostname name of the host to connect to
 154  * @param port port to connect to
 155  * @return the socket handle
 156  */
 157 struct GNUNET_CONNECTION_Handle
 158   *GNUNET_CONNECTION_create_from_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
 159                                           const char *hostname,
 160                                           uint16_t port);
 161
 162
 163 /**
 164  * Create a socket handle by connecting to a UNIX domain service.
 165  * This function returns immediately, even if the connection has not
 166  * yet been established.  This function only creates UNIX connections.
 167  *
 168  * @param cfg configuration to use
 169  * @param unixpath path to connect to)
 170  * @return the socket handle, NULL on systems without UNIX support
 171  */
 172 struct GNUNET_CONNECTION_Handle *
 173 GNUNET_CONNECTION_create_from_connect_to_unixpath (const struct
 174                                                    GNUNET_CONFIGURATION_Handle *cfg,
 175                                                    const char *unixpath);
 176
 177
 178
 179
 180 /**
 181  * Create a socket handle by (asynchronously) connecting to a host.
 182  * This function returns immediately, even if the connection has not
 183  * yet been established.  This function only creates TCP connections.
 184  *
 185  * @param af_family address family to use
 186  * @param serv_addr server address
 187  * @param addrlen length of server address
 188  * @return the socket handle
 189  */
 190 struct GNUNET_CONNECTION_Handle
 191   *GNUNET_CONNECTION_create_from_sockaddr (int af_family,
 192                                                    const struct sockaddr
 193                                                    *serv_addr,
 194                                                    socklen_t addrlen);
 195
 196 /**
 197  * Check if socket is valid (no fatal errors have happened so far).
 198  * Note that a socket that is still trying to connect is considered
 199  * valid.
 200  *
 201  * @param sock socket to check
 202  * @return GNUNET_YES if valid, GNUNET_NO otherwise
 203  */
 204 int GNUNET_CONNECTION_check (struct GNUNET_CONNECTION_Handle
 205                                      *sock);
 206
 207
 208 /**
 209  * Obtain the network address of the other party.
 210  *
 211  * @param sock the client to get the address for
 212  * @param addr where to store the address
 213  * @param addrlen where to store the length of the address
 214  * @return GNUNET_OK on success
 215  */
 216 int GNUNET_CONNECTION_get_address (struct
 217                                            GNUNET_CONNECTION_Handle
 218                                            *sock, void **addr,
 219                                            size_t * addrlen);
 220
 221
 222 /**
 223  * Close the socket and free associated resources. Pending
 224  * transmissions may be completed or dropped depending on the
 225  * arguments.   If a receive call is pending and should
 226  * NOT be completed, 'GNUNET_CONNECTION_receive_cancel'
 227  * should be called explicitly first.
 228  *
 229  * @param sock socket to destroy
 230  * @param finish_pending_write should pending writes be completed or aborted?
 231  *        (this applies to transmissions where the data has already been
 232  *        read from the application; all other transmissions should be
 233  *        aborted using 'GNUNET_CONNECTION_notify_transmit_ready_cancel').
 234  */
 235 void
 236 GNUNET_CONNECTION_destroy (struct GNUNET_CONNECTION_Handle *sock,
 237                            int finish_pending_write);
 238
 239
 240 /**
 241  * Receive data from the given socket.  Note that this function will
 242  * call "receiver" asynchronously using the scheduler.  It will
 243  * "immediately" return.  Note that there MUST only be one active
 244  * receive call per socket at any given point in time (so do not
 245  * call receive again until the receiver callback has been invoked).
 246  *
 247  * @param sock socket handle
 248  * @param max maximum number of bytes to read
 249  * @param timeout maximum amount of time to wait
 250  * @param receiver function to call with received data
 251  * @param receiver_cls closure for receiver
 252  */
 253 void
 254 GNUNET_CONNECTION_receive (struct GNUNET_CONNECTION_Handle
 255                                    *sock, size_t max,
 256                                    struct GNUNET_TIME_Relative timeout,
 257                                    GNUNET_CONNECTION_Receiver receiver,
 258                                    void *receiver_cls);
 259
 260
 261 /**
 262  * Cancel receive job on the given socket.  Note that the
 263  * receiver callback must not have been called yet in order
 264  * for the cancellation to be valid.
 265  *
 266  * @param sock socket handle
 267  * @return closure of the original receiver callback closure
 268  */
 269 void *GNUNET_CONNECTION_receive_cancel (struct
 270                                         GNUNET_CONNECTION_Handle
 271                                         *sock);
 272
 273
 274 /**
 275  * Function called to notify a client about the socket
 276  * begin ready to queue more data.  "buf" will be
 277  * NULL and "size" zero if the socket was closed for
 278  * writing in the meantime.
 279  *
 280  * @param cls closure
 281  * @param size number of bytes available in buf
 282  * @param buf where the callee should write the message
 283  * @return number of bytes written to buf
 284  */
 285 typedef size_t (*GNUNET_CONNECTION_TransmitReadyNotify) (void *cls,
 286                                                          size_t size, void *buf);
 287
 288
 289 /**
 290  * Opaque handle that can be used to cancel
 291  * a transmit-ready notification.
 292  */
 293 struct GNUNET_CONNECTION_TransmitHandle;
 294
 295 /**
 296  * Ask the socket to call us once the specified number of bytes
 297  * are free in the transmission buffer.  May call the notify
 298  * method immediately if enough space is available.  Note that
 299  * this function will abort if "size" is greater than
 300  * GNUNET_SERVER_MAX_MESSAGE_SIZE.
 301  *
 302  * Note that "notify" will be called either when enough
 303  * buffer space is available OR when the socket is destroyed.
 304  * The size parameter given to notify is guaranteed to be
 305  * larger or equal to size if the buffer is ready, or zero
 306  * if the socket was destroyed (or at least closed for
 307  * writing).  Finally, any time before 'notify' is called, a
 308  * client may call "notify_transmit_ready_cancel" to cancel
 309  * the transmission request.
 310  *
 311  * Only one transmission request can be scheduled at the same
 312  * time.  Notify will be run with the same scheduler priority
 313  * as that of the caller.
 314  *
 315  * @param sock socket
 316  * @param size number of bytes to send
 317  * @param timeout after how long should we give up (and call
 318  *        notify with buf NULL and size 0)?
 319  * @param notify function to call when buffer space is available
 320  * @param notify_cls closure for notify
 321  * @return non-NULL if the notify callback was queued,
 322  *         NULL if we are already going to notify someone else (busy)
 323  */
 324 struct GNUNET_CONNECTION_TransmitHandle
 325   *GNUNET_CONNECTION_notify_transmit_ready (struct
 326                                             GNUNET_CONNECTION_Handle
 327                                             *sock, size_t size,
 328                                             struct
 329                                             GNUNET_TIME_Relative
 330                                             timeout,
 331                                             GNUNET_CONNECTION_TransmitReadyNotify
 332                                             notify, void *notify_cls);
 333
 334
 335 /**
 336  * Cancel the specified transmission-ready
 337  * notification.
 338  *
 339  * @param h handle for notification to cancel
 340  */
 341 void
 342 GNUNET_CONNECTION_notify_transmit_ready_cancel (struct
 343                                                         GNUNET_CONNECTION_TransmitHandle
 344                                                         *h);
 345
 346
 347 /**
 348  * Configure this connection to ignore shutdown signals.
 349  *
 350  * @param sock socket handle
 351  * @param do_ignore GNUNET_YES to ignore, GNUNET_NO to restore default
 352  */
 353 void
 354 GNUNET_CONNECTION_ignore_shutdown (struct GNUNET_CONNECTION_Handle *sock,
 355                                    int do_ignore);
 356
 357
 358 #if 0                           /* keep Emacsens' auto-indent happy */
 359 {
 360 #endif
 361 #ifdef __cplusplus
 362 }
 363 #endif
 364
 365
 366 /* ifndef GNUNET_CONNECTION_LIB_H */
 367 #endif
 368 /* end of gnunet_connection_lib.h */