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_IS_SERVER        "is-server"
  39 #define SOUP_SOCKET_SSL_CREDENTIALS  "ssl-creds"
  40
  41 GType soup_socket_get_type (void);
  42
  43 SoupSocket    *soup_socket_new                (const char         *optname1,
  44                                                ...);
  45
  46 guint          soup_socket_connect            (SoupSocket         *sock,
  47                                                SoupAddress        *remote_addr);
  48 gboolean       soup_socket_listen             (SoupSocket         *sock,
  49                                                SoupAddress        *local_addr);
  50 gboolean       soup_socket_start_ssl          (SoupSocket         *sock);
  51 gboolean       soup_socket_start_proxy_ssl    (SoupSocket         *sock,
  52                                                const char         *ssl_host);
  53
  54 void           soup_socket_disconnect         (SoupSocket         *sock);
  55 gboolean       soup_socket_is_connected       (SoupSocket         *sock);
  56
  57 typedef void (*SoupSocketCallback)            (SoupSocket         *sock,
  58                                                guint               status,
  59                                                gpointer            user_data);
  60 typedef void (*SoupSocketListenerCallback)    (SoupSocket         *listener,
  61                                                SoupSocket         *sock,
  62                                                gpointer            user_data);
  63
  64 SoupSocket    *soup_socket_client_new_async   (const char         *hostname,
  65                                                guint               port,
  66                                                gpointer            ssl_creds,
  67                                                SoupSocketCallback  callback,
  68                                                gpointer            user_data);
  69 SoupSocket    *soup_socket_client_new_sync    (const char         *hostname,
  70                                                guint               port,
  71                                                gpointer            ssl_creds,
  72                                                guint              *status_ret);
  73 SoupSocket    *soup_socket_server_new         (SoupAddress        *local_addr,
  74                                                gpointer            ssl_creds,
  75                                                SoupSocketListenerCallback callback,
  76                                                gpointer            user_data);
  77
  78 SoupAddress   *soup_socket_get_local_address  (SoupSocket         *sock);
  79 SoupAddress   *soup_socket_get_remote_address (SoupSocket         *sock);
  80
  81
  82 typedef enum {
  83         SOUP_SOCKET_OK,
  84         SOUP_SOCKET_WOULD_BLOCK,
  85         SOUP_SOCKET_EOF,
  86         SOUP_SOCKET_ERROR
  87 } SoupSocketIOStatus;
  88
  89 SoupSocketIOStatus  soup_socket_read       (SoupSocket         *sock,
  90                                             gpointer            buffer,
  91                                             gsize               len,
  92                                             gsize              *nread);
  93 SoupSocketIOStatus  soup_socket_read_until (SoupSocket         *sock,
  94                                             gpointer            buffer,
  95                                             gsize               len,
  96                                             gconstpointer       boundary,
  97                                             gsize               boundary_len,
  98                                             gsize              *nread,
  99                                             gboolean           *got_boundary);
 100
 101 SoupSocketIOStatus  soup_socket_write      (SoupSocket         *sock,
 102                                             gconstpointer       buffer,
 103                                             gsize               len,
 104                                             gsize              *nwrote);
 105
 106
 107 #endif /* SOUP_SOCKET_H */