libsoup/soup-socket.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /*
   3  * Copyright (C) 2000-2003, Ximian, Inc.
   4  */
   5
   6 #ifndef SOUP_SOCKET_H
   7 #define SOUP_SOCKET_H 1
   8
   9 #include <libsoup/soup-types.h>
  10
  11 G_BEGIN_DECLS
  12
  13 #define SOUP_TYPE_SOCKET            (soup_socket_get_type ())
  14 #define SOUP_SOCKET(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), SOUP_TYPE_SOCKET, SoupSocket))
  15 #define SOUP_SOCKET_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), SOUP_TYPE_SOCKET, SoupSocketClass))
  16 #define SOUP_IS_SOCKET(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), SOUP_TYPE_SOCKET))
  17 #define SOUP_IS_SOCKET_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((obj), SOUP_TYPE_SOCKET))
  18 #define SOUP_SOCKET_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), SOUP_TYPE_SOCKET, SoupSocketClass))
  19
  20 struct SoupSocket {
  21         GObject parent;
  22
  23 };
  24
  25 typedef struct {
  26         GObjectClass parent_class;
  27
  28         /* signals */
  29         void (*connect_result) (SoupSocket *, guint);
  30         void (*readable)       (SoupSocket *);
  31         void (*writable)       (SoupSocket *);
  32         void (*disconnected)   (SoupSocket *);
  33
  34         void (*new_connection) (SoupSocket *, SoupSocket *);
  35 } SoupSocketClass;
  36
  37 #define SOUP_SOCKET_FLAG_NONBLOCKING "non-blocking"
  38 #define SOUP_SOCKET_FLAG_NODELAY     "nodelay"
  39 #define SOUP_SOCKET_FLAG_REUSEADDR   "reuseaddr"
  40 #define SOUP_SOCKET_FLAG_CLOEXEC     "cloexec"
  41 #define SOUP_SOCKET_IS_SERVER        "is-server"
  42 #define SOUP_SOCKET_SSL_CREDENTIALS  "ssl-creds"
  43 #define SOUP_SOCKET_ASYNC_CONTEXT    "async-context"
  44 #define SOUP_SOCKET_TIMEOUT          "timeout"
  45
  46 /**
  47  * SoupSocketCallback:
  48  * @sock: the #SoupSocket
  49  * @status: an HTTP status code indicating success or failure
  50  * @user_data: the data passed to soup_socket_client_new_async()
  51  *
  52  * The callback function passed to soup_socket_client_new_async().
  53  **/
  54 typedef void (*SoupSocketCallback)            (SoupSocket         *sock,
  55                                                guint               status,
  56                                                gpointer            user_data);
  57
  58 /**
  59  * SoupSocketListenerCallback:
  60  * @listener: the listening #SoupSocket
  61  * @sock: the newly-received #SoupSocket
  62  * @user_data: the data passed to soup_socket_server_new().
  63  *
  64  * The callback function passed to soup_socket_server_new(), which
  65  * receives new connections.
  66  **/
  67 typedef void (*SoupSocketListenerCallback)    (SoupSocket         *listener,
  68                                                SoupSocket         *sock,
  69                                                gpointer            user_data);
  70
  71 GType soup_socket_get_type (void);
  72
  73 SoupSocket    *soup_socket_new                (const char         *optname1,
  74                                                ...) G_GNUC_NULL_TERMINATED;
  75
  76 guint          soup_socket_connect            (SoupSocket         *sock,
  77                                                SoupAddress        *remote_addr);
  78 gboolean       soup_socket_listen             (SoupSocket         *sock,
  79                                                SoupAddress        *local_addr);
  80 gboolean       soup_socket_start_ssl          (SoupSocket         *sock);
  81 gboolean       soup_socket_start_proxy_ssl    (SoupSocket         *sock,
  82                                                const char         *ssl_host);
  83
  84 void           soup_socket_disconnect         (SoupSocket         *sock);
  85 gboolean       soup_socket_is_connected       (SoupSocket         *sock);
  86
  87 SoupSocket    *soup_socket_client_new_async   (const char         *hostname,
  88                                                guint               port,
  89                                                gpointer            ssl_creds,
  90                                                SoupSocketCallback  callback,
  91                                                gpointer            user_data);
  92 SoupSocket    *soup_socket_client_new_sync    (const char         *hostname,
  93                                                guint               port,
  94                                                gpointer            ssl_creds,
  95                                                guint              *status_ret);
  96 SoupSocket    *soup_socket_server_new         (SoupAddress        *local_addr,
  97                                                gpointer            ssl_creds,
  98                                                SoupSocketListenerCallback callback,
  99                                                gpointer            user_data);
 100
 101 SoupAddress   *soup_socket_get_local_address  (SoupSocket         *sock);
 102 SoupAddress   *soup_socket_get_remote_address (SoupSocket         *sock);
 103
 104
 105 /**
 106  * SoupSocketIOStatus:
 107  * @SOUP_SOCKET_OK: Success
 108  * @SOUP_SOCKET_WOULD_BLOCK: Cannot read/write any more at this time
 109  * @SOUP_SOCKET_EOF: End of file
 110  * @SOUP_SOCKET_ERROR: Other error
 111  *
 112  * Return value from the #SoupSocket IO methods.
 113  **/
 114 typedef enum {
 115         SOUP_SOCKET_OK,
 116         SOUP_SOCKET_WOULD_BLOCK,
 117         SOUP_SOCKET_EOF,
 118         SOUP_SOCKET_ERROR
 119 } SoupSocketIOStatus;
 120
 121 SoupSocketIOStatus  soup_socket_read       (SoupSocket         *sock,
 122                                             gpointer            buffer,
 123                                             gsize               len,
 124                                             gsize              *nread);
 125 SoupSocketIOStatus  soup_socket_read_until (SoupSocket         *sock,
 126                                             gpointer            buffer,
 127                                             gsize               len,
 128                                             gconstpointer       boundary,
 129                                             gsize               boundary_len,
 130                                             gsize              *nread,
 131                                             gboolean           *got_boundary);
 132
 133 SoupSocketIOStatus  soup_socket_write      (SoupSocket         *sock,
 134                                             gconstpointer       buffer,
 135                                             gsize               len,
 136                                             gsize              *nwrote);
 137
 138 G_END_DECLS
 139
 140 #endif /* SOUP_SOCKET_H */