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"
25 #include "gsimpleasyncresult.h"
29 G_DEFINE_ABSTRACT_TYPE (GSocketAddressEnumerator
, g_socket_address_enumerator
, G_TYPE_OBJECT
);
31 static void g_socket_address_enumerator_real_next_async (GSocketAddressEnumerator
*enumerator
,
32 GCancellable
*cancellable
,
33 GAsyncReadyCallback callback
,
35 static GSocketAddress
*g_socket_address_enumerator_real_next_finish (GSocketAddressEnumerator
*enumerator
,
40 g_socket_address_enumerator_init (GSocketAddressEnumerator
*enumerator
)
45 g_socket_address_enumerator_class_init (GSocketAddressEnumeratorClass
*enumerator_class
)
47 enumerator_class
->next_async
= g_socket_address_enumerator_real_next_async
;
48 enumerator_class
->next_finish
= g_socket_address_enumerator_real_next_finish
;
52 * g_socket_address_enumerator_next:
53 * @enumerator: a #GSocketAddressEnumerator
54 * @cancellable: optional #GCancellable object, %NULL to ignore.
57 * Retrieves the next #GSocketAddress from @enumerator. Note that this
58 * may block for some amount of time. (Eg, a #GNetworkAddress may need
59 * to do a DNS lookup before it can return an address.) Use
60 * g_socket_address_enumerator_next_async() if you need to avoid
63 * If @enumerator is expected to yield addresses, but for some reason
64 * is unable to (eg, because of a DNS error), then the first call to
65 * g_socket_address_enumerator_next() will return an appropriate error
66 * in *@error. However, if the first call to
67 * g_socket_address_enumerator_next() succeeds, then any further
68 * internal errors (other than @cancellable being triggered) will be
71 * Return value: a #GSocketAddress (owned by the caller), or %NULL on
72 * error (in which case *@error will be set) or if there are no
76 g_socket_address_enumerator_next (GSocketAddressEnumerator
*enumerator
,
77 GCancellable
*cancellable
,
80 GSocketAddressEnumeratorClass
*klass
;
82 g_return_val_if_fail (G_IS_SOCKET_ADDRESS_ENUMERATOR (enumerator
), NULL
);
84 klass
= G_SOCKET_ADDRESS_ENUMERATOR_GET_CLASS (enumerator
);
86 return (* klass
->next
) (enumerator
, cancellable
, error
);
89 /* Default implementation just calls the synchronous method; this can
90 * be used if the implementation already knows all of its addresses,
91 * and so the synchronous method will never block.
94 g_socket_address_enumerator_real_next_async (GSocketAddressEnumerator
*enumerator
,
95 GCancellable
*cancellable
,
96 GAsyncReadyCallback callback
,
99 GSimpleAsyncResult
*result
;
100 GSocketAddress
*address
;
101 GError
*error
= NULL
;
103 result
= g_simple_async_result_new (G_OBJECT (enumerator
),
105 g_socket_address_enumerator_real_next_async
);
106 address
= g_socket_address_enumerator_next (enumerator
, cancellable
, &error
);
108 g_simple_async_result_set_op_res_gpointer (result
, address
, NULL
);
111 g_simple_async_result_set_from_error (result
, error
);
112 g_error_free (error
);
114 g_simple_async_result_complete_in_idle (result
);
115 g_object_unref (result
);
119 * g_socket_address_enumerator_next_async:
120 * @enumerator: a #GSocketAddressEnumerator
121 * @cancellable: optional #GCancellable object, %NULL to ignore.
122 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
123 * @user_data: the data to pass to callback function
125 * Asynchronously retrieves the next #GSocketAddress from @enumerator
126 * and then calls @callback, which must call
127 * g_socket_address_enumerator_next_finish() to get the result.
130 g_socket_address_enumerator_next_async (GSocketAddressEnumerator
*enumerator
,
131 GCancellable
*cancellable
,
132 GAsyncReadyCallback callback
,
135 GSocketAddressEnumeratorClass
*klass
;
137 g_return_if_fail (G_IS_SOCKET_ADDRESS_ENUMERATOR (enumerator
));
139 klass
= G_SOCKET_ADDRESS_ENUMERATOR_GET_CLASS (enumerator
);
141 (* klass
->next_async
) (enumerator
, cancellable
, callback
, user_data
);
144 static GSocketAddress
*
145 g_socket_address_enumerator_real_next_finish (GSocketAddressEnumerator
*enumerator
,
146 GAsyncResult
*result
,
149 GSimpleAsyncResult
*simple
;
151 g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (result
), NULL
);
152 simple
= G_SIMPLE_ASYNC_RESULT (result
);
153 g_return_val_if_fail (g_simple_async_result_get_source_tag (simple
) == g_socket_address_enumerator_real_next_async
, NULL
);
155 if (g_simple_async_result_propagate_error (simple
, error
))
158 return g_simple_async_result_get_op_res_gpointer (simple
);
162 * g_socket_address_enumerator_next_finish:
163 * @enumerator: a #GSocketAddressEnumerator
164 * @result: a #GAsyncResult
167 * Retrieves the result of a completed call to
168 * g_socket_address_enumerator_next_async(). See
169 * g_socket_address_enumerator_next() for more information about
172 * Return value: a #GSocketAddress (owned by the caller), or %NULL on
173 * error (in which case *@error will be set) or if there are no
177 g_socket_address_enumerator_next_finish (GSocketAddressEnumerator
*enumerator
,
178 GAsyncResult
*result
,
181 GSocketAddressEnumeratorClass
*klass
;
183 g_return_val_if_fail (G_IS_SOCKET_ADDRESS_ENUMERATOR (enumerator
), NULL
);
185 klass
= G_SOCKET_ADDRESS_ENUMERATOR_GET_CLASS (enumerator
);
187 return (* klass
->next_finish
) (enumerator
, result
, error
);
190 #define __G_SOCKET_ADDRESS_ENUMERATOR_C__
191 #include "gioaliasdef.c"