1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */
/* gnome-vfs-socket.c
*
* Copyright (C) 2001 Seth Nickell
* Copyright (C) 2001 Maciej Stachowiak
*
* The Gnome Library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public License as
* published by the Free Software Foundation; either version 2 of the
* License, or (at your option) any later version.
*
* The Gnome Library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with the Gnome Library; see the file COPYING.LIB. If not,
* write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*
*/
/*
* Authors: Seth Nickell <snickell@stanford.edu>
* Maciej Stachowiak <mjs@noisehavoc.org>
* (reverse-engineered from code by Ian McKellar <yakk@yakk.net>)
*/
#include <config.h>
#include "gnome-vfs-socket.h"
#include <glib.h>
struct GnomeVFSSocket {
GnomeVFSSocketImpl *impl;
gpointer connection;
};
/**
* gnome_vfs_socket_new:
* @impl: an implementation of socket, e.g. #GnomeVFSSSL.
* @connection: pointer to a connection object used by @impl to track.
* state (the exact nature of @connection varies from implementation to
* implementation).
*
* Creates a new #GnomeVFSSocket using the specific implementation
* @impl.
*
* Return value: a newly created socket.
*/
GnomeVFSSocket* gnome_vfs_socket_new (GnomeVFSSocketImpl *impl,
void *connection)
{
GnomeVFSSocket *socket;
socket = g_new0 (GnomeVFSSocket, 1);
socket->impl = impl;
socket->connection = connection;
return socket;
}
/**
* gnome_vfs_socket_write:
* @socket: socket to write data to.
* @buffer: data to write to the socket.
* @bytes: number of bytes from @buffer to write to @socket.
* @bytes_written: pointer to a #GnomeVFSFileSize, will contain
* the number of bytes actually written to the @socket on return.
* @cancellation: optional cancellation object.
*
* Write @bytes bytes of data from @buffer to @socket.
*
* Return value: #GnomeVFSResult indicating the success of the operation.
*/
GnomeVFSResult
gnome_vfs_socket_write (GnomeVFSSocket *socket,
gconstpointer buffer,
int bytes,
GnomeVFSFileSize *bytes_written,
GnomeVFSCancellation *cancellation)
{
if (gnome_vfs_cancellation_check (cancellation)) {
if (bytes_written != NULL) {
*bytes_written = 0;
}
return GNOME_VFS_ERROR_CANCELLED;
}
return socket->impl->write (socket->connection,
buffer, bytes, bytes_written,
cancellation);
}
/**
* gnome_vfs_socket_close:
* @socket: the socket to be closed.
* @cancellation: optional cancellation object.
*
* Close @socket, freeing any resources it may be using.
*
* Return value: #GnomeVFSResult indicating the success of the operation.
*/
GnomeVFSResult
gnome_vfs_socket_close (GnomeVFSSocket *socket,
GnomeVFSCancellation *cancellation)
{
socket->impl->close (socket->connection, cancellation);
g_free (socket);
return GNOME_VFS_OK;
}
/**
* gnome_vfs_socket_read:
* @socket: socket to read data from.
* @buffer: allocated buffer of at least @bytes bytes to be read into.
* @bytes: number of bytes to read from @socket into @buffer.
* @bytes_read: pointer to a #GnomeVFSFileSize, will contain
* the number of bytes actually read from the socket on return.
* @cancellation: optional cancellation object.
*
* Read @bytes bytes of data from the @socket into @buffer.
*
* Return value: #GnomeVFSResult indicating the success of the operation.
*/
GnomeVFSResult
gnome_vfs_socket_read (GnomeVFSSocket *socket,
gpointer buffer,
GnomeVFSFileSize bytes,
GnomeVFSFileSize *bytes_read,
GnomeVFSCancellation *cancellation)
{
if (gnome_vfs_cancellation_check (cancellation)) {
if (bytes_read != NULL) {
*bytes_read = 0;
}
return GNOME_VFS_ERROR_CANCELLED;
}
return socket->impl->read (socket->connection,
buffer, bytes, bytes_read,
cancellation);
}
/**
* gnome_vfs_socket_set_timeout:
* @socket: socket to set the timeout of.
* @timeout: the timeout.
* @cancellation: optional cancellation object.
*
* Set a timeout of @timeout. If @timeout is %NULL, following operations
* will block indefinitely).
*
* Note if you set @timeout to 0 (means tv_sec and tv_usec are both 0)
* every following operation will return immediately. (This can be used
* for polling.)
*
* Return value: #GnomeVFSResult indicating the success of the operation.
*
* Since: 2.8
*/
GnomeVFSResult
gnome_vfs_socket_set_timeout (GnomeVFSSocket *socket,
GTimeVal *timeout,
GnomeVFSCancellation *cancellation)
{
return socket->impl->set_timeout (socket->connection,
timeout,
cancellation);
}
/**
* gnome_vfs_socket_free:
* @socket: The #GnomeVFSSocket you want to free.
*
* Frees the memory allocated for @socket, but does
* not call any #GnomeVFSSocketImpl function.
*
* Since: 2.8
*/
void
gnome_vfs_socket_free (GnomeVFSSocket *socket)
{
g_return_if_fail (socket != NULL);
g_free (socket);
}
|
