libsoup/soup-address.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_ADDRESS_H
   7 #define SOUP_ADDRESS_H
   8
   9 #include <sys/types.h>
  10
  11 #include <libsoup/soup-portability.h>
  12 #include <libsoup/soup-types.h>
  13
  14 #define SOUP_TYPE_ADDRESS            (soup_address_get_type ())
  15 #define SOUP_ADDRESS(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), SOUP_TYPE_ADDRESS, SoupAddress))
  16 #define SOUP_ADDRESS_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), SOUP_TYPE_ADDRESS, SoupAddressClass))
  17 #define SOUP_IS_ADDRESS(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), SOUP_TYPE_ADDRESS))
  18 #define SOUP_IS_ADDRESS_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((obj), SOUP_TYPE_ADDRESS))
  19 #define SOUP_ADDRESS_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), SOUP_TYPE_ADDRESS, SoupAddressClass))
  20
  21 struct SoupAddress {
  22         GObject parent;
  23
  24 };
  25
  26 typedef struct {
  27         GObjectClass parent_class;
  28
  29         /* signals */
  30         void (*dns_result) (SoupAddress *addr, guint status);
  31 } SoupAddressClass;
  32
  33 /* This is messy, but gtk-doc doesn't understand if the #if occurs
  34  * inside the typedef.
  35  */
  36 #ifdef AF_INET6
  37 typedef enum {
  38         SOUP_ADDRESS_FAMILY_IPV4 = AF_INET,
  39         SOUP_ADDRESS_FAMILY_IPV6 = AF_INET6
  40 } SoupAddressFamily;
  41 #else
  42 typedef enum {
  43         SOUP_ADDRESS_FAMILY_IPV4 = AF_INET,
  44         SOUP_ADDRESS_FAMILY_IPV6 = -1
  45 } SoupAddressFamily;
  46 #endif
  47
  48 /**
  49  * SOUP_ADDRESS_ANY_PORT:
  50  *
  51  * This can be passed to any #SoupAddress method that expects a port,
  52  * to indicate that you don't care what port is used.
  53  **/
  54 #define SOUP_ADDRESS_ANY_PORT 0
  55
  56 /**
  57  * SoupAddressCallback:
  58  * @addr: the #SoupAddress that was resolved
  59  * @status: %SOUP_STATUS_OK or %SOUP_STATUS_CANT_RESOLVE
  60  * @data: the user data that was passed to
  61  * soup_address_resolve_async()
  62  *
  63  * The callback function passed to soup_address_resolve_async().
  64  **/
  65 typedef void   (*SoupAddressCallback)            (SoupAddress         *addr,
  66                                                   guint                status,
  67                                                   gpointer             data);
  68
  69 GType soup_address_get_type (void);
  70
  71 SoupAddress     *soup_address_new                (const char          *name,
  72                                                   guint                port);
  73 SoupAddress     *soup_address_new_from_sockaddr  (struct sockaddr     *sa,
  74                                                   int                  len);
  75 SoupAddress     *soup_address_new_any            (SoupAddressFamily    family,
  76                                                   guint                port);
  77
  78 void             soup_address_resolve_async      (SoupAddress         *addr,
  79                                                   SoupAddressCallback  callback,
  80                                                   gpointer             user_data);
  81 guint            soup_address_resolve_sync       (SoupAddress         *addr);
  82
  83 const char      *soup_address_get_name           (SoupAddress         *addr);
  84 const char      *soup_address_get_physical       (SoupAddress         *addr);
  85 guint            soup_address_get_port           (SoupAddress         *addr);
  86 struct sockaddr *soup_address_get_sockaddr       (SoupAddress         *addr,
  87                                                   int                 *len);
  88
  89 #endif /* SOUP_ADDRESS_H */