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 #include <gio/gio.h>
  11
  12 G_BEGIN_DECLS
  13
  14 #define SOUP_TYPE_SOCKET            (soup_socket_get_type ())
  15 #define SOUP_SOCKET(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), SOUP_TYPE_SOCKET, SoupSocket))
  16 #define SOUP_SOCKET_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), SOUP_TYPE_SOCKET, SoupSocketClass))
  17 #define SOUP_IS_SOCKET(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), SOUP_TYPE_SOCKET))
  18 #define SOUP_IS_SOCKET_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((obj), SOUP_TYPE_SOCKET))
  19 #define SOUP_SOCKET_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), SOUP_TYPE_SOCKET, SoupSocketClass))
  20
  21 struct _SoupSocket {
  22         GObject parent;
  23
  24 };
  25
  26 typedef struct {
  27         GObjectClass parent_class;
  28
  29         /* signals */
  30         void (*readable)       (SoupSocket *);
  31         void (*writable)       (SoupSocket *);
  32         void (*disconnected)   (SoupSocket *);
  33
  34         void (*new_connection) (SoupSocket *, SoupSocket *);
  35
  36         /* Padding for future expansion */
  37         void (*_libsoup_reserved1) (void);
  38         void (*_libsoup_reserved2) (void);
  39         void (*_libsoup_reserved3) (void);
  40         void (*_libsoup_reserved4) (void);
  41 } SoupSocketClass;
  42
  43 #define SOUP_SOCKET_LOCAL_ADDRESS    "local-address"
  44 #define SOUP_SOCKET_REMOTE_ADDRESS   "remote-address"
  45 #define SOUP_SOCKET_FLAG_NONBLOCKING "non-blocking"
  46 #define SOUP_SOCKET_IS_SERVER        "is-server"
  47 #define SOUP_SOCKET_SSL_CREDENTIALS  "ssl-creds"
  48 #define SOUP_SOCKET_ASYNC_CONTEXT    "async-context"
  49 #define SOUP_SOCKET_TIMEOUT          "timeout"
  50
  51 typedef void (*SoupSocketCallback)            (SoupSocket         *sock,
  52                                                guint               status,
  53                                                gpointer            user_data);
  54
  55 GType soup_socket_get_type (void);
  56
  57 SoupSocket    *soup_socket_new                (const char         *optname1,
  58                                                ...) G_GNUC_NULL_TERMINATED;
  59
  60 void           soup_socket_connect_async      (SoupSocket         *sock,
  61                                                GCancellable       *cancellable,
  62                                                SoupSocketCallback  callback,
  63                                                gpointer            user_data);
  64 guint          soup_socket_connect_sync       (SoupSocket         *sock,
  65                                                GCancellable       *cancellable);
  66 int            soup_socket_get_fd             (SoupSocket         *sock);
  67
  68 gboolean       soup_socket_listen             (SoupSocket         *sock);
  69
  70 gboolean       soup_socket_start_ssl          (SoupSocket         *sock,
  71                                                GCancellable       *cancellable);
  72 gboolean       soup_socket_start_proxy_ssl    (SoupSocket         *sock,
  73                                                const char         *ssl_host,
  74                                                GCancellable       *cancellable);
  75 gboolean       soup_socket_is_ssl             (SoupSocket         *sock);
  76
  77 void           soup_socket_disconnect         (SoupSocket         *sock);
  78 gboolean       soup_socket_is_connected       (SoupSocket         *sock);
  79
  80 SoupAddress   *soup_socket_get_local_address  (SoupSocket         *sock);
  81 SoupAddress   *soup_socket_get_remote_address (SoupSocket         *sock);
  82
  83
  84 typedef enum {
  85         SOUP_SOCKET_OK,
  86         SOUP_SOCKET_WOULD_BLOCK,
  87         SOUP_SOCKET_EOF,
  88         SOUP_SOCKET_ERROR
  89 } SoupSocketIOStatus;
  90
  91 SoupSocketIOStatus  soup_socket_read       (SoupSocket         *sock,
  92                                             gpointer            buffer,
  93                                             gsize               len,
  94                                             gsize              *nread,
  95                                             GCancellable       *cancellable,
  96                                             GError            **error);
  97 SoupSocketIOStatus  soup_socket_read_until (SoupSocket         *sock,
  98                                             gpointer            buffer,
  99                                             gsize               len,
 100                                             gconstpointer       boundary,
 101                                             gsize               boundary_len,
 102                                             gsize              *nread,
 103                                             gboolean           *got_boundary,
 104                                             GCancellable       *cancellable,
 105                                             GError            **error);
 106
 107 SoupSocketIOStatus  soup_socket_write      (SoupSocket         *sock,
 108                                             gconstpointer       buffer,
 109                                             gsize               len,
 110                                             gsize              *nwrote,
 111                                             GCancellable       *cancellable,
 112                                             GError            **error);
 113
 114 G_END_DECLS
 115
 116 #endif /* SOUP_SOCKET_H */