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