filexfer.h

Uploading and downloading files.

Like every self-respecting BBS worth the coffee it was coded on, Megistos allows users to transfer files from and to the system. The file transfer subsystem is a pretty complex thing in itself. Thankfully, its API is disproportionately easy to use.

This interface provides functions to add files to the user's upload or download queue, call the file transfer module, and customise its actions before and after the file transfer itself.

Original banner, legalese and change history follow.

 *****************************************************************************
 **                                                                         **
 **  FILE:     filexfer.h                                                   **
 **  AUTHORS:  Alexios                                                      **
 **  REVISION: A, November 94                                               **
 **  PURPOSE:  Interface to the upload/download stuff.                      **
 **  NOTES:                                                                 **
 **  LEGALESE:                                                              **
 **                                                                         **
 **  This program is free software; you  can redistribute it and/or modify  **
 **  it under the terms of the GNU  General Public License as published by  **
 **  the Free Software Foundation; either version 2 of the License, or (at  **
 **  your option) any later version.                                        **
 **                                                                         **
 **  This program 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  **
 **  General Public License for more details.                               **
 **                                                                         **
 **  You  should have received a copy   of the GNU  General Public License  **
 **  along with    this program;  if   not, write  to  the   Free Software  **
 **  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.              **
 **                                                                         **
 *****************************************************************************


 *
 * $Id: filexfer.h,v 1.3 2001/04/22 14:49:04 alexios Exp $
 *
 * $Log: filexfer.h,v $
 * Revision 1.3  2001/04/22 14:49:04  alexios
 * Merged in leftover 0.99.2 changes and additional bug fixes.
 *
 * Revision 0.5  1998/08/14 11:23:21  alexios
 * Added "transient" mode for files (transient files can be
 * downloaded, but not tagged). Updated addwild() to allow
 * specification of download mode.
 *
 * Revision 0.4  1998/07/26 21:17:06  alexios
 * Added scripts to be called after success or failure of a
 * file transfer.
 *
 * Revision 0.3  1997/11/06 20:03:39  alexios
 * Added GPL legalese to the top of this file.
 *
 * Revision 0.2  1997/11/06 16:49:10  alexios
 * Changed the file transfer module to allow registration of
 * audit entries for the new auditing scheme.
 *
 * Revision 0.1  1997/08/26 15:48:53  alexios
 * First registered revision. Adequate.
 *
 *
 *

xfer_item

File transfer item structure (deprecated)

XFER_ITEM_MAGIC

Proper way to refer to a transfer item.

File transfer modes

File transfer modes.

xfer_setaudit

Customise post-transfer auditing.

xfer_setcmd

Customise post-transfer commands.

xfer_add

Add a file to the transfer queue.

xfer_addwild

Add a number of files to the transfer queue.

xfer_run

Begin the file transfer.

xfer_kill_list

Empties the transfer queue.

xfer_kill_taglist

Clears the tagged file list.

Author:

Alexios

Alphabetic index