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 <glib-object.h>
  10 #include <libsoup/soup-address.h>
  11 #include <libsoup/soup-error.h>
  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 typedef struct SoupSocketPrivate SoupSocketPrivate;
  21
  22 typedef struct {
  23         GObject parent;
  24
  25         SoupSocketPrivate *priv;
  26 } SoupSocket;
  27
  28 typedef struct {
  29         GObjectClass parent_class;
  30
  31         /* signals */
  32         void (*connect_result) (SoupSocket *, SoupKnownErrorCode);
  33         void (*readable)       (SoupSocket *);
  34         void (*writable)       (SoupSocket *);
  35         void (*disconnected)   (SoupSocket *);
  36
  37         void (*new_connection) (SoupSocket *, SoupSocket *);
  38 } SoupSocketClass;
  39
  40 typedef enum {
  41         SOUP_SOCKET_FLAG_NONBLOCKING,
  42         SOUP_SOCKET_FLAG_NODELAY,
  43         SOUP_SOCKET_FLAG_REUSEADDR,
  44 } SoupSocketFlag;
  45
  46 GType soup_socket_get_type (void);
  47
  48 SoupSocket    *soup_socket_new                (void);
  49 void           soup_socket_set_flag           (SoupSocket         *sock,
  50                                                SoupSocketFlag      flag,
  51                                                gboolean            value);
  52
  53 void           soup_socket_connect            (SoupSocket         *sock,
  54                                                SoupAddress        *rem_addr);
  55 gboolean       soup_socket_listen             (SoupSocket         *sock,
  56                                                SoupAddress        *local_addr);
  57 void           soup_socket_start_ssl          (SoupSocket         *sock);
  58
  59 void           soup_socket_disconnect         (SoupSocket         *sock);
  60 gboolean       soup_socket_is_connected       (SoupSocket         *sock);
  61
  62 typedef void (*SoupSocketCallback)            (SoupSocket         *sock,
  63                                                SoupKnownErrorCode  status,
  64                                                gpointer            user_data);
  65 typedef void (*SoupSocketListenerCallback)    (SoupSocket         *listener,
  66                                                SoupSocket         *sock,
  67                                                gpointer            user_data);
  68
  69 SoupSocket    *soup_socket_client_new         (const char         *hostname,
  70                                                guint               port,
  71                                                gboolean            ssl,
  72                                                SoupSocketCallback  callback,
  73                                                gpointer            user_data);
  74 SoupSocket    *soup_socket_server_new         (SoupAddress        *local_addr,
  75                                                gboolean            ssl,
  76                                                SoupSocketListenerCallback,
  77                                                gpointer            user_data);
  78
  79
  80 GIOChannel    *soup_socket_get_iochannel      (SoupSocket         *sock);
  81
  82 SoupAddress   *soup_socket_get_local_address  (SoupSocket         *sock);
  83 SoupAddress   *soup_socket_get_remote_address (SoupSocket         *sock);
  84
  85
  86 typedef enum {
  87         SOUP_SOCKET_OK,
  88         SOUP_SOCKET_WOULD_BLOCK,
  89         SOUP_SOCKET_EOF,
  90         SOUP_SOCKET_ERROR
  91 } SoupSocketIOStatus;
  92
  93 SoupSocketIOStatus  soup_socket_read       (SoupSocket         *sock,
  94                                             gpointer            buffer,
  95                                             guint               len,
  96                                             guint              *nread);
  97 SoupSocketIOStatus  soup_socket_read_until (SoupSocket         *sock,
  98                                             gpointer            buffer,
  99                                             guint               len,
 100                                             gconstpointer       boundary,
 101                                             guint               boundary_len,
 102                                             guint              *nread,
 103                                             gboolean           *got_boundary);
 104
 105 SoupSocketIOStatus  soup_socket_write      (SoupSocket         *sock,
 106                                             gconstpointer       buffer,
 107                                             guint               len,
 108                                             guint              *nwrote);
 109
 110
 111 #endif /* SOUP_SOCKET_H */