summaryrefslogtreecommitdiff
path: root/libsoup/soup-address.h
diff options
context:
space:
mode:
authorDan Winship <danw@src.gnome.org>2005-06-14 15:34:22 +0000
committerDan Winship <danw@src.gnome.org>2005-06-14 15:34:22 +0000
commit5069f32c25a4a1ef85b698d9cbd283418c8a8de7 (patch)
treea84274aea41d69681642a5135b2f70f7e2a76f6d /libsoup/soup-address.h
parent4d7ce6c1f91c2f8da1be6ace4ba45325e59d7c19 (diff)
downloadlibsoup-5069f32c25a4a1ef85b698d9cbd283418c8a8de7.tar.gz
add/fix gtk-doc comments, make functions match prototypes, etc
* libsoup/*.[ch]: add/fix gtk-doc comments, make functions match prototypes, etc * docs/reference/*: update, fix, etc
Diffstat (limited to 'libsoup/soup-address.h')
-rw-r--r--libsoup/soup-address.h26
1 files changed, 21 insertions, 5 deletions
diff --git a/libsoup/soup-address.h b/libsoup/soup-address.h
index 5bc88aa0..b27c20d2 100644
--- a/libsoup/soup-address.h
+++ b/libsoup/soup-address.h
@@ -45,8 +45,27 @@ typedef enum {
} SoupAddressFamily;
#endif
+/**
+ * SOUP_ADDRESS_ANY_PORT:
+ *
+ * This can be passed to any #SoupAddress method that expects a port,
+ * to indicate that you don't care what port is used.
+ **/
#define SOUP_ADDRESS_ANY_PORT 0
+/**
+ * SoupAddressCallback:
+ * @addr: the #SoupAddress that was resolved
+ * @status: %SOUP_STATUS_OK or %SOUP_STATUS_CANT_RESOLVE
+ * @data: the user data that was passed to
+ * soup_address_resolve_async()
+ *
+ * The callback function passed to soup_address_resolve_async().
+ **/
+typedef void (*SoupAddressCallback) (SoupAddress *addr,
+ guint status,
+ gpointer data);
+
GType soup_address_get_type (void);
SoupAddress *soup_address_new (const char *name,
@@ -56,18 +75,15 @@ SoupAddress *soup_address_new_from_sockaddr (struct sockaddr *sa,
SoupAddress *soup_address_new_any (SoupAddressFamily family,
guint port);
-typedef void (*SoupAddressCallback) (SoupAddress *addr,
- guint status,
- gpointer data);
void soup_address_resolve_async (SoupAddress *addr,
SoupAddressCallback callback,
gpointer user_data);
guint soup_address_resolve_sync (SoupAddress *addr);
const char *soup_address_get_name (SoupAddress *addr);
-struct sockaddr *soup_address_get_sockaddr (SoupAddress *addr,
- int *len);
const char *soup_address_get_physical (SoupAddress *addr);
guint soup_address_get_port (SoupAddress *addr);
+struct sockaddr *soup_address_get_sockaddr (SoupAddress *addr,
+ int *len);
#endif /* SOUP_ADDRESS_H */