libgnomevfs/gnome-vfs-socket.h

   1 /* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */
   2 /* gnome-vfs-socket.h
   3  *
   4  * Copyright (C) 2001 Seth Nickell
   5  * Copyright (C) 2001 Maciej Stachowiak
   6  *
   7  * The Gnome Library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public License as
   9  * published by the Free Software Foundation; either version 2 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * The Gnome Library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with the Gnome Library; see the file COPYING.LIB.  If not,
  19  * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  *
  22  */
  23 /*
  24  * Authors: Seth Nickell <snickell@stanford.edu>
  25  *          Maciej Stachowiak <mjs@noisehavoc.org>
  26  *          (reverse-engineered from code by Ian McKellar <yakk@yakk.net>)
  27  */
  28
  29 #ifndef GNOME_VFS_SOCKET_H
  30 #define GNOME_VFS_SOCKET_H
  31
  32 #include <glib/gtypes.h>
  33 #include <libgnomevfs/gnome-vfs-file-size.h>
  34 #include <libgnomevfs/gnome-vfs-result.h>
  35
  36 G_BEGIN_DECLS
  37
  38 typedef struct GnomeVFSSocket GnomeVFSSocket;
  39
  40
  41 typedef GnomeVFSResult (*GnomeVFSSocketReadFunc)  (gpointer connection,
  42                                                    gpointer buffer,
  43                                                    GnomeVFSFileSize bytes,
  44                                                    GnomeVFSFileSize *bytes_read);
  45 typedef GnomeVFSResult (*GnomeVFSSocketWriteFunc) (gpointer connection,
  46                                                    gconstpointer buffer,
  47                                                    GnomeVFSFileSize bytes,
  48                                                    GnomeVFSFileSize *bytes_written);
  49
  50 typedef void           (*GnomeVFSSocketCloseFunc) (gpointer connection);
  51
  52 typedef struct {
  53   GnomeVFSSocketReadFunc read;
  54   GnomeVFSSocketWriteFunc write;
  55   GnomeVFSSocketCloseFunc close;
  56 } GnomeVFSSocketImpl;
  57
  58
  59 GnomeVFSSocket* gnome_vfs_socket_new     (GnomeVFSSocketImpl *impl,
  60                                           void               *connection);
  61 GnomeVFSResult  gnome_vfs_socket_write   (GnomeVFSSocket     *socket,
  62                                           gconstpointer       buffer,
  63                                           int                 bytes,
  64                                           GnomeVFSFileSize   *bytes_written);
  65 GnomeVFSResult  gnome_vfs_socket_close   (GnomeVFSSocket     *socket);
  66 GnomeVFSResult  gnome_vfs_socket_read    (GnomeVFSSocket     *socket,
  67                                           gpointer            buffer,
  68                                           GnomeVFSFileSize    bytes,
  69                                           GnomeVFSFileSize   *bytes_read);
  70
  71 G_END_DECLS
  72
  73 #endif /* GNOME_VFS_SOCKET_H */