Branch data Line data Source code
1 : : /* GIO - GLib Input, Output and Streaming Library
2 : : *
3 : : * Copyright © 2008 Christian Kellner, Samuel Cormier-Iijima
4 : : * © 2009 codethink
5 : : *
6 : : * SPDX-License-Identifier: LGPL-2.1-or-later
7 : : *
8 : : * This library is free software; you can redistribute it and/or
9 : : * modify it under the terms of the GNU Lesser General Public
10 : : * License as published by the Free Software Foundation; either
11 : : * version 2.1 of the License, or (at your option) any later version.
12 : : *
13 : : * This library is distributed in the hope that it will be useful,
14 : : * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 : : * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 : : * Lesser General Public License for more details.
17 : : *
18 : : * You should have received a copy of the GNU Lesser General
19 : : * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
20 : : *
21 : : * Authors: Christian Kellner <gicmo@gnome.org>
22 : : * Samuel Cormier-Iijima <sciyoshi@gmail.com>
23 : : * Ryan Lortie <desrt@desrt.ca>
24 : : */
25 : :
26 : : #include "config.h"
27 : : #include "goutputstream.h"
28 : : #include "gsocketoutputstream.h"
29 : : #include "gsocket.h"
30 : : #include "glibintl.h"
31 : :
32 : : #include "gcancellable.h"
33 : : #include "gpollableinputstream.h"
34 : : #include "gpollableoutputstream.h"
35 : : #include "gioerror.h"
36 : : #include "glibintl.h"
37 : : #include "gfiledescriptorbased.h"
38 : : #include "gioprivate.h"
39 : :
40 : : struct _GSocketOutputStreamPrivate
41 : : {
42 : : GSocket *socket;
43 : :
44 : : /* pending operation metadata */
45 : : gconstpointer buffer;
46 : : gsize count;
47 : : };
48 : :
49 : : static void g_socket_output_stream_pollable_iface_init (GPollableOutputStreamInterface *iface);
50 : : #ifdef G_OS_UNIX
51 : : static void g_socket_output_stream_file_descriptor_based_iface_init (GFileDescriptorBasedIface *iface);
52 : : #endif
53 : :
54 : : #define g_socket_output_stream_get_type _g_socket_output_stream_get_type
55 : :
56 : : #ifdef G_OS_UNIX
57 : 31519 : G_DEFINE_TYPE_WITH_CODE (GSocketOutputStream, g_socket_output_stream, G_TYPE_OUTPUT_STREAM,
58 : : G_ADD_PRIVATE (GSocketOutputStream)
59 : : G_IMPLEMENT_INTERFACE (G_TYPE_POLLABLE_OUTPUT_STREAM, g_socket_output_stream_pollable_iface_init)
60 : : G_IMPLEMENT_INTERFACE (G_TYPE_FILE_DESCRIPTOR_BASED, g_socket_output_stream_file_descriptor_based_iface_init)
61 : : )
62 : : #else
63 : : G_DEFINE_TYPE_WITH_CODE (GSocketOutputStream, g_socket_output_stream, G_TYPE_OUTPUT_STREAM,
64 : : G_ADD_PRIVATE (GSocketOutputStream)
65 : : G_IMPLEMENT_INTERFACE (G_TYPE_POLLABLE_OUTPUT_STREAM, g_socket_output_stream_pollable_iface_init)
66 : : )
67 : : #endif
68 : :
69 : : enum
70 : : {
71 : : PROP_0,
72 : : PROP_SOCKET
73 : : };
74 : :
75 : : static void
76 : 0 : g_socket_output_stream_get_property (GObject *object,
77 : : guint prop_id,
78 : : GValue *value,
79 : : GParamSpec *pspec)
80 : : {
81 : 0 : GSocketOutputStream *stream = G_SOCKET_OUTPUT_STREAM (object);
82 : :
83 : 0 : switch (prop_id)
84 : : {
85 : 0 : case PROP_SOCKET:
86 : 0 : g_value_set_object (value, stream->priv->socket);
87 : 0 : break;
88 : :
89 : 0 : default:
90 : 0 : G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
91 : : }
92 : 0 : }
93 : :
94 : : static void
95 : 1845 : g_socket_output_stream_set_property (GObject *object,
96 : : guint prop_id,
97 : : const GValue *value,
98 : : GParamSpec *pspec)
99 : : {
100 : 1845 : GSocketOutputStream *stream = G_SOCKET_OUTPUT_STREAM (object);
101 : :
102 : 1845 : switch (prop_id)
103 : : {
104 : 1845 : case PROP_SOCKET:
105 : 1845 : stream->priv->socket = g_value_dup_object (value);
106 : 1845 : break;
107 : :
108 : 0 : default:
109 : 0 : G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
110 : : }
111 : 1845 : }
112 : :
113 : : static void
114 : 1590 : g_socket_output_stream_finalize (GObject *object)
115 : : {
116 : 1590 : GSocketOutputStream *stream = G_SOCKET_OUTPUT_STREAM (object);
117 : :
118 : 1590 : if (stream->priv->socket)
119 : 1590 : g_object_unref (stream->priv->socket);
120 : :
121 : 1590 : G_OBJECT_CLASS (g_socket_output_stream_parent_class)->finalize (object);
122 : 1590 : }
123 : :
124 : : static gssize
125 : 8487 : g_socket_output_stream_write (GOutputStream *stream,
126 : : const void *buffer,
127 : : gsize count,
128 : : GCancellable *cancellable,
129 : : GError **error)
130 : : {
131 : 8487 : GSocketOutputStream *output_stream = G_SOCKET_OUTPUT_STREAM (stream);
132 : :
133 : 8487 : return g_socket_send_with_blocking (output_stream->priv->socket,
134 : : buffer, count, TRUE,
135 : : cancellable, error);
136 : : }
137 : :
138 : : static gboolean
139 : 1 : g_socket_output_stream_writev (GOutputStream *stream,
140 : : const GOutputVector *vectors,
141 : : gsize n_vectors,
142 : : gsize *bytes_written,
143 : : GCancellable *cancellable,
144 : : GError **error)
145 : : {
146 : 1 : GSocketOutputStream *output_stream = G_SOCKET_OUTPUT_STREAM (stream);
147 : : GPollableReturn res;
148 : :
149 : : /* Clamp the number of vectors if more given than we can write in one go.
150 : : * The caller has to handle short writes anyway.
151 : : */
152 : 1 : if (n_vectors > G_IOV_MAX)
153 : 0 : n_vectors = G_IOV_MAX;
154 : :
155 : 1 : res = g_socket_send_message_with_timeout (output_stream->priv->socket, NULL,
156 : : vectors, n_vectors,
157 : : NULL, 0, G_SOCKET_MSG_NONE,
158 : : -1, bytes_written,
159 : : cancellable, error);
160 : :
161 : : /* we have a non-zero timeout so this can't happen */
162 : 1 : g_assert (res != G_POLLABLE_RETURN_WOULD_BLOCK);
163 : :
164 : 1 : return res == G_POLLABLE_RETURN_OK;
165 : : }
166 : :
167 : : static gboolean
168 : 2 : g_socket_output_stream_pollable_is_writable (GPollableOutputStream *pollable)
169 : : {
170 : 2 : GSocketOutputStream *output_stream = G_SOCKET_OUTPUT_STREAM (pollable);
171 : :
172 : 2 : return g_socket_condition_check (output_stream->priv->socket, G_IO_OUT);
173 : : }
174 : :
175 : : static gssize
176 : 595 : g_socket_output_stream_pollable_write_nonblocking (GPollableOutputStream *pollable,
177 : : const void *buffer,
178 : : gsize size,
179 : : GError **error)
180 : : {
181 : 595 : GSocketOutputStream *output_stream = G_SOCKET_OUTPUT_STREAM (pollable);
182 : :
183 : 595 : return g_socket_send_with_blocking (output_stream->priv->socket,
184 : : buffer, size, FALSE,
185 : : NULL, error);
186 : : }
187 : :
188 : : static GPollableReturn
189 : 1 : g_socket_output_stream_pollable_writev_nonblocking (GPollableOutputStream *pollable,
190 : : const GOutputVector *vectors,
191 : : gsize n_vectors,
192 : : gsize *bytes_written,
193 : : GError **error)
194 : : {
195 : 1 : GSocketOutputStream *output_stream = G_SOCKET_OUTPUT_STREAM (pollable);
196 : :
197 : : /* Clamp the number of vectors if more given than we can write in one go.
198 : : * The caller has to handle short writes anyway.
199 : : */
200 : 1 : if (n_vectors > G_IOV_MAX)
201 : 0 : n_vectors = G_IOV_MAX;
202 : :
203 : 1 : return g_socket_send_message_with_timeout (output_stream->priv->socket,
204 : : NULL, vectors, n_vectors,
205 : : NULL, 0, G_SOCKET_MSG_NONE, 0,
206 : : bytes_written, NULL, error);
207 : : }
208 : :
209 : : static GSource *
210 : 48 : g_socket_output_stream_pollable_create_source (GPollableOutputStream *pollable,
211 : : GCancellable *cancellable)
212 : : {
213 : 48 : GSocketOutputStream *output_stream = G_SOCKET_OUTPUT_STREAM (pollable);
214 : : GSource *socket_source, *pollable_source;
215 : :
216 : 48 : pollable_source = g_pollable_source_new (G_OBJECT (output_stream));
217 : 48 : socket_source = g_socket_create_source (output_stream->priv->socket,
218 : : G_IO_OUT, cancellable);
219 : 48 : g_source_set_dummy_callback (socket_source);
220 : 48 : g_source_add_child_source (pollable_source, socket_source);
221 : 48 : g_source_unref (socket_source);
222 : :
223 : 48 : return pollable_source;
224 : : }
225 : :
226 : : #ifdef G_OS_UNIX
227 : : static int
228 : 0 : g_socket_output_stream_get_fd (GFileDescriptorBased *fd_based)
229 : : {
230 : 0 : GSocketOutputStream *output_stream = G_SOCKET_OUTPUT_STREAM (fd_based);
231 : :
232 : 0 : return g_socket_get_fd (output_stream->priv->socket);
233 : : }
234 : : #endif
235 : :
236 : : static void
237 : 99 : g_socket_output_stream_class_init (GSocketOutputStreamClass *klass)
238 : : {
239 : 99 : GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
240 : 99 : GOutputStreamClass *goutputstream_class = G_OUTPUT_STREAM_CLASS (klass);
241 : :
242 : 99 : gobject_class->finalize = g_socket_output_stream_finalize;
243 : 99 : gobject_class->get_property = g_socket_output_stream_get_property;
244 : 99 : gobject_class->set_property = g_socket_output_stream_set_property;
245 : :
246 : 99 : goutputstream_class->write_fn = g_socket_output_stream_write;
247 : 99 : goutputstream_class->writev_fn = g_socket_output_stream_writev;
248 : :
249 : 99 : g_object_class_install_property (gobject_class, PROP_SOCKET,
250 : : g_param_spec_object ("socket", NULL, NULL,
251 : : G_TYPE_SOCKET, G_PARAM_CONSTRUCT_ONLY |
252 : : G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
253 : 99 : }
254 : :
255 : : #ifdef G_OS_UNIX
256 : : static void
257 : 99 : g_socket_output_stream_file_descriptor_based_iface_init (GFileDescriptorBasedIface *iface)
258 : : {
259 : 99 : iface->get_fd = g_socket_output_stream_get_fd;
260 : 99 : }
261 : : #endif
262 : :
263 : : static void
264 : 99 : g_socket_output_stream_pollable_iface_init (GPollableOutputStreamInterface *iface)
265 : : {
266 : 99 : iface->is_writable = g_socket_output_stream_pollable_is_writable;
267 : 99 : iface->create_source = g_socket_output_stream_pollable_create_source;
268 : 99 : iface->write_nonblocking = g_socket_output_stream_pollable_write_nonblocking;
269 : 99 : iface->writev_nonblocking = g_socket_output_stream_pollable_writev_nonblocking;
270 : 99 : }
271 : :
272 : : static void
273 : 1845 : g_socket_output_stream_init (GSocketOutputStream *stream)
274 : : {
275 : 1845 : stream->priv = g_socket_output_stream_get_instance_private (stream);
276 : 1845 : }
277 : :
278 : : GSocketOutputStream *
279 : 1845 : _g_socket_output_stream_new (GSocket *socket)
280 : : {
281 : 1845 : return g_object_new (G_TYPE_SOCKET_OUTPUT_STREAM, "socket", socket, NULL);
282 : : }
|
