1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2008 Red Hat, Inc.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General
16 * Public License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18 * Boston, MA 02111-1307, USA.
22 #include "gsocketaddressenumerator.h"
28 G_DEFINE_ABSTRACT_TYPE (GSocketAddressEnumerator
, g_socket_address_enumerator
, G_TYPE_OBJECT
);
30 static void g_socket_address_enumerator_real_next_async (GSocketAddressEnumerator
*enumerator
,
31 GCancellable
*cancellable
,
32 GAsyncReadyCallback callback
,
34 static GSocketAddress
*g_socket_address_enumerator_real_next_finish (GSocketAddressEnumerator
*enumerator
,
39 g_socket_address_enumerator_init (GSocketAddressEnumerator
*enumerator
)
44 g_socket_address_enumerator_class_init (GSocketAddressEnumeratorClass
*enumerator_class
)
46 enumerator_class
->next_async
= g_socket_address_enumerator_real_next_async
;
47 enumerator_class
->next_finish
= g_socket_address_enumerator_real_next_finish
;
51 * g_socket_address_enumerator_next:
52 * @enumerator: a #GSocketAddressEnumerator
53 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
56 * Retrieves the next #GSocketAddress from @enumerator. Note that this
57 * may block for some amount of time. (Eg, a #GNetworkAddress may need
58 * to do a DNS lookup before it can return an address.) Use
59 * g_socket_address_enumerator_next_async() if you need to avoid
62 * If @enumerator is expected to yield addresses, but for some reason
63 * is unable to (eg, because of a DNS error), then the first call to
64 * g_socket_address_enumerator_next() will return an appropriate error
65 * in *@error. However, if the first call to
66 * g_socket_address_enumerator_next() succeeds, then any further
67 * internal errors (other than @cancellable being triggered) will be
70 * Return value: (transfer full): a #GSocketAddress (owned by the caller), or %NULL on
71 * error (in which case *@error will be set) or if there are no
75 g_socket_address_enumerator_next (GSocketAddressEnumerator
*enumerator
,
76 GCancellable
*cancellable
,
79 GSocketAddressEnumeratorClass
*klass
;
81 g_return_val_if_fail (G_IS_SOCKET_ADDRESS_ENUMERATOR (enumerator
), NULL
);
83 klass
= G_SOCKET_ADDRESS_ENUMERATOR_GET_CLASS (enumerator
);
85 return (* klass
->next
) (enumerator
, cancellable
, error
);
88 /* Default implementation just calls the synchronous method; this can
89 * be used if the implementation already knows all of its addresses,
90 * and so the synchronous method will never block.
93 g_socket_address_enumerator_real_next_async (GSocketAddressEnumerator
*enumerator
,
94 GCancellable
*cancellable
,
95 GAsyncReadyCallback callback
,
99 GSocketAddress
*address
;
100 GError
*error
= NULL
;
102 task
= g_task_new (enumerator
, NULL
, callback
, user_data
);
104 address
= g_socket_address_enumerator_next (enumerator
, cancellable
, &error
);
106 g_task_return_error (task
, error
);
108 g_task_return_pointer (task
, address
, g_object_unref
);
110 g_object_unref (task
);
114 * g_socket_address_enumerator_next_async:
115 * @enumerator: a #GSocketAddressEnumerator
116 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
117 * @callback: (scope async): a #GAsyncReadyCallback to call when the request
119 * @user_data: (closure): the data to pass to callback function
121 * Asynchronously retrieves the next #GSocketAddress from @enumerator
122 * and then calls @callback, which must call
123 * g_socket_address_enumerator_next_finish() to get the result.
126 g_socket_address_enumerator_next_async (GSocketAddressEnumerator
*enumerator
,
127 GCancellable
*cancellable
,
128 GAsyncReadyCallback callback
,
131 GSocketAddressEnumeratorClass
*klass
;
133 g_return_if_fail (G_IS_SOCKET_ADDRESS_ENUMERATOR (enumerator
));
135 klass
= G_SOCKET_ADDRESS_ENUMERATOR_GET_CLASS (enumerator
);
137 (* klass
->next_async
) (enumerator
, cancellable
, callback
, user_data
);
140 static GSocketAddress
*
141 g_socket_address_enumerator_real_next_finish (GSocketAddressEnumerator
*enumerator
,
142 GAsyncResult
*result
,
145 g_return_val_if_fail (g_task_is_valid (result
, enumerator
), NULL
);
147 return g_task_propagate_pointer (G_TASK (result
), error
);
151 * g_socket_address_enumerator_next_finish:
152 * @enumerator: a #GSocketAddressEnumerator
153 * @result: a #GAsyncResult
156 * Retrieves the result of a completed call to
157 * g_socket_address_enumerator_next_async(). See
158 * g_socket_address_enumerator_next() for more information about
161 * Return value: (transfer full): a #GSocketAddress (owned by the caller), or %NULL on
162 * error (in which case *@error will be set) or if there are no
166 g_socket_address_enumerator_next_finish (GSocketAddressEnumerator
*enumerator
,
167 GAsyncResult
*result
,
170 GSocketAddressEnumeratorClass
*klass
;
172 g_return_val_if_fail (G_IS_SOCKET_ADDRESS_ENUMERATOR (enumerator
), NULL
);
174 klass
= G_SOCKET_ADDRESS_ENUMERATOR_GET_CLASS (enumerator
);
176 return (* klass
->next_finish
) (enumerator
, result
, error
);