1 /*
2  * This file is part of gtkD.
3  *
4  * gtkD is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License
6  * as published by the Free Software Foundation; either version 3
7  * of the License, or (at your option) any later version, with
8  * some exceptions, please read the COPYING file.
9  *
10  * gtkD 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
13  * GNU Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with gtkD; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
18  */
19 
20 // generated automatically - do not change
21 // find conversion definition on APILookup.txt
22 // implement new conversion functionalities on the wrap.utils pakage
23 
24 
25 module gio.DatagramBasedIF;
26 
27 private import gio.Cancellable;
28 private import gio.c.functions;
29 public  import gio.c.types;
30 private import glib.ErrorG;
31 private import glib.GException;
32 private import glib.Source;
33 
34 
35 /**
36  * A #GDatagramBased is a networking interface for representing datagram-based
37  * communications. It is a more or less direct mapping of the core parts of the
38  * BSD socket API in a portable GObject interface. It is implemented by
39  * #GSocket, which wraps the UNIX socket API on UNIX and winsock2 on Windows.
40  * 
41  * #GDatagramBased is entirely platform independent, and is intended to be used
42  * alongside higher-level networking APIs such as #GIOStream.
43  * 
44  * It uses vectored scatter/gather I/O by default, allowing for many messages
45  * to be sent or received in a single call. Where possible, implementations of
46  * the interface should take advantage of vectored I/O to minimise processing
47  * or system calls. For example, #GSocket uses recvmmsg() and sendmmsg() where
48  * possible. Callers should take advantage of scatter/gather I/O (the use of
49  * multiple buffers per message) to avoid unnecessary copying of data to
50  * assemble or disassemble a message.
51  * 
52  * Each #GDatagramBased operation has a timeout parameter which may be negative
53  * for blocking behaviour, zero for non-blocking behaviour, or positive for
54  * timeout behaviour. A blocking operation blocks until finished or there is an
55  * error. A non-blocking operation will return immediately with a
56  * %G_IO_ERROR_WOULD_BLOCK error if it cannot make progress. A timeout operation
57  * will block until the operation is complete or the timeout expires; if the
58  * timeout expires it will return what progress it made, or
59  * %G_IO_ERROR_TIMED_OUT if no progress was made. To know when a call would
60  * successfully run you can call g_datagram_based_condition_check() or
61  * g_datagram_based_condition_wait(). You can also use
62  * g_datagram_based_create_source() and attach it to a #GMainContext to get
63  * callbacks when I/O is possible.
64  * 
65  * When running a non-blocking operation applications should always be able to
66  * handle getting a %G_IO_ERROR_WOULD_BLOCK error even when some other function
67  * said that I/O was possible. This can easily happen in case of a race
68  * condition in the application, but it can also happen for other reasons. For
69  * instance, on Windows a socket is always seen as writable until a write
70  * returns %G_IO_ERROR_WOULD_BLOCK.
71  * 
72  * As with #GSocket, #GDatagramBaseds can be either connection oriented (for
73  * example, SCTP) or connectionless (for example, UDP). #GDatagramBaseds must be
74  * datagram-based, not stream-based. The interface does not cover connection
75  * establishment — use methods on the underlying type to establish a connection
76  * before sending and receiving data through the #GDatagramBased API. For
77  * connectionless socket types the target/source address is specified or
78  * received in each I/O operation.
79  * 
80  * Like most other APIs in GLib, #GDatagramBased is not inherently thread safe.
81  * To use a #GDatagramBased concurrently from multiple threads, you must
82  * implement your own locking.
83  *
84  * Since: 2.48
85  */
86 public interface DatagramBasedIF{
87 	/** Get the main Gtk struct */
88 	public GDatagramBased* getDatagramBasedStruct(bool transferOwnership = false);
89 
90 	/** the main Gtk struct as a void* */
91 	protected void* getStruct();
92 
93 
94 	/** */
95 	public static GType getType()
96 	{
97 		return g_datagram_based_get_type();
98 	}
99 
100 	/**
101 	 * Checks on the readiness of @datagram_based to perform operations. The
102 	 * operations specified in @condition are checked for and masked against the
103 	 * currently-satisfied conditions on @datagram_based. The result is returned.
104 	 *
105 	 * %G_IO_IN will be set in the return value if data is available to read with
106 	 * g_datagram_based_receive_messages(), or if the connection is closed remotely
107 	 * (EOS); and if the datagram_based has not been closed locally using some
108 	 * implementation-specific method (such as g_socket_close() or
109 	 * g_socket_shutdown() with @shutdown_read set, if it’s a #GSocket).
110 	 *
111 	 * If the connection is shut down or closed (by calling g_socket_close() or
112 	 * g_socket_shutdown() with @shutdown_read set, if it’s a #GSocket, for
113 	 * example), all calls to this function will return %G_IO_ERROR_CLOSED.
114 	 *
115 	 * %G_IO_OUT will be set if it is expected that at least one byte can be sent
116 	 * using g_datagram_based_send_messages() without blocking. It will not be set
117 	 * if the datagram_based has been closed locally.
118 	 *
119 	 * %G_IO_HUP will be set if the connection has been closed locally.
120 	 *
121 	 * %G_IO_ERR will be set if there was an asynchronous error in transmitting data
122 	 * previously enqueued using g_datagram_based_send_messages().
123 	 *
124 	 * Note that on Windows, it is possible for an operation to return
125 	 * %G_IO_ERROR_WOULD_BLOCK even immediately after
126 	 * g_datagram_based_condition_check() has claimed that the #GDatagramBased is
127 	 * ready for writing. Rather than calling g_datagram_based_condition_check() and
128 	 * then writing to the #GDatagramBased if it succeeds, it is generally better to
129 	 * simply try writing right away, and try again later if the initial attempt
130 	 * returns %G_IO_ERROR_WOULD_BLOCK.
131 	 *
132 	 * It is meaningless to specify %G_IO_ERR or %G_IO_HUP in @condition; these
133 	 * conditions will always be set in the output if they are true. Apart from
134 	 * these flags, the output is guaranteed to be masked by @condition.
135 	 *
136 	 * This call never blocks.
137 	 *
138 	 * Params:
139 	 *     condition = a #GIOCondition mask to check
140 	 *
141 	 * Returns: the #GIOCondition mask of the current state
142 	 *
143 	 * Since: 2.48
144 	 */
145 	public GIOCondition conditionCheck(GIOCondition condition);
146 
147 	/**
148 	 * Waits for up to @timeout microseconds for condition to become true on
149 	 * @datagram_based. If the condition is met, %TRUE is returned.
150 	 *
151 	 * If @cancellable is cancelled before the condition is met, or if @timeout is
152 	 * reached before the condition is met, then %FALSE is returned and @error is
153 	 * set appropriately (%G_IO_ERROR_CANCELLED or %G_IO_ERROR_TIMED_OUT).
154 	 *
155 	 * Params:
156 	 *     condition = a #GIOCondition mask to wait for
157 	 *     timeout = the maximum time (in microseconds) to wait, 0 to not block, or -1
158 	 *         to block indefinitely
159 	 *     cancellable = a #GCancellable
160 	 *
161 	 * Returns: %TRUE if the condition was met, %FALSE otherwise
162 	 *
163 	 * Since: 2.48
164 	 *
165 	 * Throws: GException on failure.
166 	 */
167 	public bool conditionWait(GIOCondition condition, long timeout, Cancellable cancellable);
168 
169 	/**
170 	 * Creates a #GSource that can be attached to a #GMainContext to monitor for
171 	 * the availability of the specified @condition on the #GDatagramBased. The
172 	 * #GSource keeps a reference to the @datagram_based.
173 	 *
174 	 * The callback on the source is of the #GDatagramBasedSourceFunc type.
175 	 *
176 	 * It is meaningless to specify %G_IO_ERR or %G_IO_HUP in @condition; these
177 	 * conditions will always be reported in the callback if they are true.
178 	 *
179 	 * If non-%NULL, @cancellable can be used to cancel the source, which will
180 	 * cause the source to trigger, reporting the current condition (which is
181 	 * likely 0 unless cancellation happened at the same time as a condition
182 	 * change). You can check for this in the callback using
183 	 * g_cancellable_is_cancelled().
184 	 *
185 	 * Params:
186 	 *     condition = a #GIOCondition mask to monitor
187 	 *     cancellable = a #GCancellable
188 	 *
189 	 * Returns: a newly allocated #GSource
190 	 *
191 	 * Since: 2.48
192 	 */
193 	public Source createSource(GIOCondition condition, Cancellable cancellable);
194 
195 	/**
196 	 * Receive one or more data messages from @datagram_based in one go.
197 	 *
198 	 * @messages must point to an array of #GInputMessage structs and
199 	 * @num_messages must be the length of this array. Each #GInputMessage
200 	 * contains a pointer to an array of #GInputVector structs describing the
201 	 * buffers that the data received in each message will be written to.
202 	 *
203 	 * @flags modify how all messages are received. The commonly available
204 	 * arguments for this are available in the #GSocketMsgFlags enum, but the
205 	 * values there are the same as the system values, and the flags
206 	 * are passed in as-is, so you can pass in system-specific flags too. These
207 	 * flags affect the overall receive operation. Flags affecting individual
208 	 * messages are returned in #GInputMessage.flags.
209 	 *
210 	 * The other members of #GInputMessage are treated as described in its
211 	 * documentation.
212 	 *
213 	 * If @timeout is negative the call will block until @num_messages have been
214 	 * received, the connection is closed remotely (EOS), @cancellable is cancelled,
215 	 * or an error occurs.
216 	 *
217 	 * If @timeout is 0 the call will return up to @num_messages without blocking,
218 	 * or %G_IO_ERROR_WOULD_BLOCK if no messages are queued in the operating system
219 	 * to be received.
220 	 *
221 	 * If @timeout is positive the call will block on the same conditions as if
222 	 * @timeout were negative. If the timeout is reached
223 	 * before any messages are received, %G_IO_ERROR_TIMED_OUT is returned,
224 	 * otherwise it will return the number of messages received before timing out.
225 	 * (Note: This is effectively the behaviour of `MSG_WAITFORONE` with
226 	 * recvmmsg().)
227 	 *
228 	 * To be notified when messages are available, wait for the %G_IO_IN condition.
229 	 * Note though that you may still receive %G_IO_ERROR_WOULD_BLOCK from
230 	 * g_datagram_based_receive_messages() even if you were previously notified of a
231 	 * %G_IO_IN condition.
232 	 *
233 	 * If the remote peer closes the connection, any messages queued in the
234 	 * underlying receive buffer will be returned, and subsequent calls to
235 	 * g_datagram_based_receive_messages() will return 0 (with no error set).
236 	 *
237 	 * If the connection is shut down or closed (by calling g_socket_close() or
238 	 * g_socket_shutdown() with @shutdown_read set, if it’s a #GSocket, for
239 	 * example), all calls to this function will return %G_IO_ERROR_CLOSED.
240 	 *
241 	 * On error -1 is returned and @error is set accordingly. An error will only
242 	 * be returned if zero messages could be received; otherwise the number of
243 	 * messages successfully received before the error will be returned. If
244 	 * @cancellable is cancelled, %G_IO_ERROR_CANCELLED is returned as with any
245 	 * other error.
246 	 *
247 	 * Params:
248 	 *     messages = an array of #GInputMessage structs
249 	 *     flags = an int containing #GSocketMsgFlags flags for the overall operation
250 	 *     timeout = the maximum time (in microseconds) to wait, 0 to not block, or -1
251 	 *         to block indefinitely
252 	 *     cancellable = a %GCancellable
253 	 *
254 	 * Returns: number of messages received, or -1 on error. Note that the number
255 	 *     of messages received may be smaller than @num_messages if @timeout is
256 	 *     zero or positive, if the peer closed the connection, or if @num_messages
257 	 *     was larger than `UIO_MAXIOV` (1024), in which case the caller may re-try
258 	 *     to receive the remaining messages.
259 	 *
260 	 * Since: 2.48
261 	 *
262 	 * Throws: GException on failure.
263 	 */
264 	public int receiveMessages(GInputMessage[] messages, int flags, long timeout, Cancellable cancellable);
265 
266 	/**
267 	 * Send one or more data messages from @datagram_based in one go.
268 	 *
269 	 * @messages must point to an array of #GOutputMessage structs and
270 	 * @num_messages must be the length of this array. Each #GOutputMessage
271 	 * contains an address to send the data to, and a pointer to an array of
272 	 * #GOutputVector structs to describe the buffers that the data to be sent
273 	 * for each message will be gathered from.
274 	 *
275 	 * @flags modify how the message is sent. The commonly available arguments
276 	 * for this are available in the #GSocketMsgFlags enum, but the
277 	 * values there are the same as the system values, and the flags
278 	 * are passed in as-is, so you can pass in system-specific flags too.
279 	 *
280 	 * The other members of #GOutputMessage are treated as described in its
281 	 * documentation.
282 	 *
283 	 * If @timeout is negative the call will block until @num_messages have been
284 	 * sent, @cancellable is cancelled, or an error occurs.
285 	 *
286 	 * If @timeout is 0 the call will send up to @num_messages without blocking,
287 	 * or will return %G_IO_ERROR_WOULD_BLOCK if there is no space to send messages.
288 	 *
289 	 * If @timeout is positive the call will block on the same conditions as if
290 	 * @timeout were negative. If the timeout is reached before any messages are
291 	 * sent, %G_IO_ERROR_TIMED_OUT is returned, otherwise it will return the number
292 	 * of messages sent before timing out.
293 	 *
294 	 * To be notified when messages can be sent, wait for the %G_IO_OUT condition.
295 	 * Note though that you may still receive %G_IO_ERROR_WOULD_BLOCK from
296 	 * g_datagram_based_send_messages() even if you were previously notified of a
297 	 * %G_IO_OUT condition. (On Windows in particular, this is very common due to
298 	 * the way the underlying APIs work.)
299 	 *
300 	 * If the connection is shut down or closed (by calling g_socket_close() or
301 	 * g_socket_shutdown() with @shutdown_write set, if it’s a #GSocket, for
302 	 * example), all calls to this function will return %G_IO_ERROR_CLOSED.
303 	 *
304 	 * On error -1 is returned and @error is set accordingly. An error will only
305 	 * be returned if zero messages could be sent; otherwise the number of messages
306 	 * successfully sent before the error will be returned. If @cancellable is
307 	 * cancelled, %G_IO_ERROR_CANCELLED is returned as with any other error.
308 	 *
309 	 * Params:
310 	 *     messages = an array of #GOutputMessage structs
311 	 *     flags = an int containing #GSocketMsgFlags flags
312 	 *     timeout = the maximum time (in microseconds) to wait, 0 to not block, or -1
313 	 *         to block indefinitely
314 	 *     cancellable = a %GCancellable
315 	 *
316 	 * Returns: number of messages sent, or -1 on error. Note that the number of
317 	 *     messages sent may be smaller than @num_messages if @timeout is zero
318 	 *     or positive, or if @num_messages was larger than `UIO_MAXIOV` (1024), in
319 	 *     which case the caller may re-try to send the remaining messages.
320 	 *
321 	 * Since: 2.48
322 	 *
323 	 * Throws: GException on failure.
324 	 */
325 	public int sendMessages(GOutputMessage[] messages, int flags, long timeout, Cancellable cancellable);
326 }