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
  84                                               GNUNET_CONNECTION_Credentials *
  85                                               ucred,
  86                                               const struct sockaddr * addr,
  87                                               socklen_t addrlen);
  88
  89
  90 /**
  91  * Callback function for data received from the network.  Note that
  92  * both "available" and "err" would be 0 if the read simply timed out.
  93  *
  94  * @param cls closure
  95  * @param buf pointer to received data
  96  * @param available number of bytes availabe in "buf",
  97  *        possibly 0 (on errors)
  98  * @param addr address of the sender
  99  * @param addrlen size of addr
 100  * @param errCode value of errno (on errors receiving)
 101  */
 102 typedef void (*GNUNET_CONNECTION_Receiver) (void *cls, const void *buf,
 103                                             size_t available,
 104                                             const struct sockaddr * addr,
 105                                             socklen_t addrlen, int errCode);
 106
 107 /**
 108  * Set the persist option on this connection handle.  Indicates
 109  * that the underlying socket or fd should never really be closed.
 110  * Used for indicating process death.
 111  *
 112  * @param sock the connection to set persistent
 113  */
 114 void
 115 GNUNET_CONNECTION_persist_ (struct GNUNET_CONNECTION_Handle *sock);
 116
 117 /**
 118  * Disable the "CORK" feature for communication with the given socket,
 119  * forcing the OS to immediately flush the buffer on transmission
 120  * instead of potentially buffering multiple messages.  Essentially
 121  * reduces the OS send buffers to zero.
 122  * Used to make sure that the last messages sent through the connection
 123  * reach the other side before the process is terminated.
 124  *
 125  * @param sock the connection to make flushing and blocking
 126  * @return GNUNET_OK on success
 127  */
 128 int
 129 GNUNET_CONNECTION_disable_corking (struct GNUNET_CONNECTION_Handle *sock);
 130
 131
 132 /**
 133  * Create a socket handle by boxing an existing OS socket.  The OS
 134  * socket should henceforth be no longer used directly.
 135  * GNUNET_socket_destroy will close it.
 136  *
 137  * @param osSocket existing socket to box
 138  * @return the boxed socket handle
 139  */
 140 struct GNUNET_CONNECTION_Handle *
 141 GNUNET_CONNECTION_create_from_existing (struct GNUNET_NETWORK_Handle *osSocket);
 142
 143
 144 /**
 145  * Create a socket handle by accepting on a listen socket.  This
 146  * function may block if the listen socket has no connection ready.
 147  *
 148  * @param access function to use to check if access is allowed
 149  * @param access_cls closure for access
 150  * @param lsock listen socket
 151  * @return the socket handle, NULL on error (for example, access refused)
 152  */
 153 struct GNUNET_CONNECTION_Handle *
 154 GNUNET_CONNECTION_create_from_accept (GNUNET_CONNECTION_AccessCheck access,
 155                                       void *access_cls,
 156                                       struct GNUNET_NETWORK_Handle *lsock);
 157
 158
 159 /**
 160  * Create a socket handle by (asynchronously) connecting to a host.
 161  * This function returns immediately, even if the connection has not
 162  * yet been established.  This function only creates TCP connections.
 163  *
 164  * @param cfg configuration to use
 165  * @param hostname name of the host to connect to
 166  * @param port port to connect to
 167  * @return the socket handle
 168  */
 169 struct GNUNET_CONNECTION_Handle *
 170 GNUNET_CONNECTION_create_from_connect (const struct GNUNET_CONFIGURATION_Handle
 171                                        *cfg, const char *hostname,
 172                                        uint16_t port);
 173
 174
 175 /**
 176  * Create a socket handle by connecting to a UNIX domain service.
 177  * This function returns immediately, even if the connection has not
 178  * yet been established.  This function only creates UNIX connections.
 179  *
 180  * @param cfg configuration to use
 181  * @param unixpath path to connect to)
 182  * @return the socket handle, NULL on systems without UNIX support
 183  */
 184 struct GNUNET_CONNECTION_Handle *
 185 GNUNET_CONNECTION_create_from_connect_to_unixpath (const struct
 186                                                    GNUNET_CONFIGURATION_Handle
 187                                                    *cfg, const char *unixpath);
 188
 189
 190
 191
 192 /**
 193  * Create a socket handle by (asynchronously) connecting to a host.
 194  * This function returns immediately, even if the connection has not
 195  * yet been established.  This function only creates TCP connections.
 196  *
 197  * @param af_family address family to use
 198  * @param serv_addr server address
 199  * @param addrlen length of server address
 200  * @return the socket handle
 201  */
 202 struct GNUNET_CONNECTION_Handle *
 203 GNUNET_CONNECTION_create_from_sockaddr (int af_family,
 204                                         const struct sockaddr *serv_addr,
 205                                         socklen_t addrlen);
 206
 207 /**
 208  * Check if socket is valid (no fatal errors have happened so far).
 209  * Note that a socket that is still trying to connect is considered
 210  * valid.
 211  *
 212  * @param sock socket to check
 213  * @return GNUNET_YES if valid, GNUNET_NO otherwise
 214  */
 215 int
 216 GNUNET_CONNECTION_check (struct GNUNET_CONNECTION_Handle *sock);
 217
 218
 219 /**
 220  * Obtain the network address of the other party.
 221  *
 222  * @param sock the client to get the address for
 223  * @param addr where to store the address
 224  * @param addrlen where to store the length of the address
 225  * @return GNUNET_OK on success
 226  */
 227 int
 228 GNUNET_CONNECTION_get_address (struct GNUNET_CONNECTION_Handle *sock,
 229                                void **addr, size_t * addrlen);
 230
 231
 232 /**
 233  * Close the socket and free associated resources. Pending
 234  * transmissions may be completed or dropped depending on the
 235  * arguments.   If a receive call is pending and should
 236  * NOT be completed, 'GNUNET_CONNECTION_receive_cancel'
 237  * should be called explicitly first.
 238  *
 239  * @param sock socket to destroy
 240  * @param finish_pending_write should pending writes be completed or aborted?
 241  *        (this applies to transmissions where the data has already been
 242  *        read from the application; all other transmissions should be
 243  *        aborted using 'GNUNET_CONNECTION_notify_transmit_ready_cancel').
 244  */
 245 void
 246 GNUNET_CONNECTION_destroy (struct GNUNET_CONNECTION_Handle *sock,
 247                            int finish_pending_write);
 248
 249
 250 /**
 251  * Receive data from the given socket.  Note that this function will
 252  * call "receiver" asynchronously using the scheduler.  It will
 253  * "immediately" return.  Note that there MUST only be one active
 254  * receive call per socket at any given point in time (so do not
 255  * call receive again until the receiver callback has been invoked).
 256  *
 257  * @param sock socket handle
 258  * @param max maximum number of bytes to read
 259  * @param timeout maximum amount of time to wait
 260  * @param receiver function to call with received data
 261  * @param receiver_cls closure for receiver
 262  */
 263 void
 264 GNUNET_CONNECTION_receive (struct GNUNET_CONNECTION_Handle *sock, size_t max,
 265                            struct GNUNET_TIME_Relative timeout,
 266                            GNUNET_CONNECTION_Receiver receiver,
 267                            void *receiver_cls);
 268
 269
 270 /**
 271  * Cancel receive job on the given socket.  Note that the
 272  * receiver callback must not have been called yet in order
 273  * for the cancellation to be valid.
 274  *
 275  * @param sock socket handle
 276  * @return closure of the original receiver callback closure
 277  */
 278 void *
 279 GNUNET_CONNECTION_receive_cancel (struct GNUNET_CONNECTION_Handle *sock);
 280
 281
 282 /**
 283  * Function called to notify a client about the socket
 284  * begin ready to queue more data.  "buf" will be
 285  * NULL and "size" zero if the socket was closed for
 286  * writing in the meantime.
 287  *
 288  * @param cls closure
 289  * @param size number of bytes available in buf
 290  * @param buf where the callee should write the message
 291  * @return number of bytes written to buf
 292  */
 293 typedef size_t (*GNUNET_CONNECTION_TransmitReadyNotify) (void *cls, size_t size,
 294                                                          void *buf);
 295
 296
 297 /**
 298  * Opaque handle that can be used to cancel
 299  * a transmit-ready notification.
 300  */
 301 struct GNUNET_CONNECTION_TransmitHandle;
 302
 303 /**
 304  * Ask the socket to call us once the specified number of bytes
 305  * are free in the transmission buffer.  May call the notify
 306  * method immediately if enough space is available.  Note that
 307  * this function will abort if "size" is greater than
 308  * GNUNET_SERVER_MAX_MESSAGE_SIZE.
 309  *
 310  * Note that "notify" will be called either when enough
 311  * buffer space is available OR when the socket is destroyed.
 312  * The size parameter given to notify is guaranteed to be
 313  * larger or equal to size if the buffer is ready, or zero
 314  * if the socket was destroyed (or at least closed for
 315  * writing).  Finally, any time before 'notify' is called, a
 316  * client may call "notify_transmit_ready_cancel" to cancel
 317  * the transmission request.
 318  *
 319  * Only one transmission request can be scheduled at the same
 320  * time.  Notify will be run with the same scheduler priority
 321  * as that of the caller.
 322  *
 323  * @param sock socket
 324  * @param size number of bytes to send
 325  * @param timeout after how long should we give up (and call
 326  *        notify with buf NULL and size 0)?
 327  * @param notify function to call when buffer space is available
 328  * @param notify_cls closure for notify
 329  * @return non-NULL if the notify callback was queued,
 330  *         NULL if we are already going to notify someone else (busy)
 331  */
 332 struct GNUNET_CONNECTION_TransmitHandle *
 333 GNUNET_CONNECTION_notify_transmit_ready (struct GNUNET_CONNECTION_Handle *sock,
 334                                          size_t size,
 335                                          struct GNUNET_TIME_Relative timeout,
 336                                          GNUNET_CONNECTION_TransmitReadyNotify
 337                                          notify, void *notify_cls);
 338
 339
 340 /**
 341  * Cancel the specified transmission-ready
 342  * notification.
 343  *
 344  * @param th handle for notification to cancel
 345  */
 346 void
 347 GNUNET_CONNECTION_notify_transmit_ready_cancel (struct
 348                                                 GNUNET_CONNECTION_TransmitHandle
 349                                                 *th);
 350
 351
 352 /**
 353  * Configure this connection to ignore shutdown signals.
 354  *
 355  * @param sock socket handle
 356  * @param do_ignore GNUNET_YES to ignore, GNUNET_NO to restore default
 357  */
 358 void
 359 GNUNET_CONNECTION_ignore_shutdown (struct GNUNET_CONNECTION_Handle *sock,
 360                                    int do_ignore);
 361
 362
 363 #if 0                           /* keep Emacsens' auto-indent happy */
 364 {
 365 #endif
 366 #ifdef __cplusplus
 367 }
 368 #endif
 369
 370
 371 /* ifndef GNUNET_CONNECTION_LIB_H */
 372 #endif
 373 /* end of gnunet_connection_lib.h */