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 (*readable)       (SoupSocket *);
  30         void (*writable)       (SoupSocket *);
  31         void (*disconnected)   (SoupSocket *);
  32
  33         void (*new_connection) (SoupSocket *, SoupSocket *);
  34
  35         /* Padding for future expansion */
  36         void (*_libsoup_reserved1) (void);
  37         void (*_libsoup_reserved2) (void);
  38         void (*_libsoup_reserved3) (void);
  39         void (*_libsoup_reserved4) (void);
  40 } SoupSocketClass;
  41
  42 #define SOUP_SOCKET_LOCAL_ADDRESS       "local-address"
  43 #define SOUP_SOCKET_REMOTE_ADDRESS      "remote-address"
  44 #define SOUP_SOCKET_FLAG_NONBLOCKING    "non-blocking"
  45 #define SOUP_SOCKET_IS_SERVER           "is-server"
  46 #define SOUP_SOCKET_SSL_CREDENTIALS     "ssl-creds"
  47 #define SOUP_SOCKET_SSL_STRICT          "ssl-strict"
  48 #define SOUP_SOCKET_TRUSTED_CERTIFICATE "trusted-certificate"
  49 #define SOUP_SOCKET_ASYNC_CONTEXT       "async-context"
  50 #define SOUP_SOCKET_TIMEOUT             "timeout"
  51 #define SOUP_SOCKET_TLS_CERTIFICATE     "tls-certificate"
  52 #define SOUP_SOCKET_TLS_ERRORS          "tls-errors"
  53
  54 typedef void (*SoupSocketCallback)            (SoupSocket         *sock,
  55                                                guint               status,
  56                                                gpointer            user_data);
  57
  58 GType soup_socket_get_type (void);
  59
  60 SoupSocket    *soup_socket_new                (const char         *optname1,
  61                                                ...) G_GNUC_NULL_TERMINATED;
  62
  63 void           soup_socket_connect_async      (SoupSocket         *sock,
  64                                                GCancellable       *cancellable,
  65                                                SoupSocketCallback  callback,
  66                                                gpointer            user_data);
  67 guint          soup_socket_connect_sync       (SoupSocket         *sock,
  68                                                GCancellable       *cancellable);
  69 int            soup_socket_get_fd             (SoupSocket         *sock);
  70
  71 gboolean       soup_socket_listen             (SoupSocket         *sock);
  72
  73 gboolean       soup_socket_start_ssl          (SoupSocket         *sock,
  74                                                GCancellable       *cancellable);
  75 gboolean       soup_socket_start_proxy_ssl    (SoupSocket         *sock,
  76                                                const char         *ssl_host,
  77                                                GCancellable       *cancellable);
  78 gboolean       soup_socket_is_ssl             (SoupSocket         *sock);
  79
  80 void           soup_socket_disconnect         (SoupSocket         *sock);
  81 gboolean       soup_socket_is_connected       (SoupSocket         *sock);
  82
  83 SoupAddress   *soup_socket_get_local_address  (SoupSocket         *sock);
  84 SoupAddress   *soup_socket_get_remote_address (SoupSocket         *sock);
  85
  86
  87 typedef enum {
  88         SOUP_SOCKET_OK,
  89         SOUP_SOCKET_WOULD_BLOCK,
  90         SOUP_SOCKET_EOF,
  91         SOUP_SOCKET_ERROR
  92 } SoupSocketIOStatus;
  93
  94 SoupSocketIOStatus  soup_socket_read       (SoupSocket         *sock,
  95                                             gpointer            buffer,
  96                                             gsize               len,
  97                                             gsize              *nread,
  98                                             GCancellable       *cancellable,
  99                                             GError            **error);
 100 SoupSocketIOStatus  soup_socket_read_until (SoupSocket         *sock,
 101                                             gpointer            buffer,
 102                                             gsize               len,
 103                                             gconstpointer       boundary,
 104                                             gsize               boundary_len,
 105                                             gsize              *nread,
 106                                             gboolean           *got_boundary,
 107                                             GCancellable       *cancellable,
 108                                             GError            **error);
 109
 110 SoupSocketIOStatus  soup_socket_write      (SoupSocket         *sock,
 111                                             gconstpointer       buffer,
 112                                             gsize               len,
 113                                             gsize              *nwrote,
 114                                             GCancellable       *cancellable,
 115                                             GError            **error);
 116
 117 G_END_DECLS
 118
 119 #endif /* SOUP_SOCKET_H */