home *** CD-ROM | disk | FTP | other *** search
/ Piper's Pit BBS/FTP: ibm 0020 - 0029 / ibm0020-0029 / ibm0028.tar / ibm0028 / GRLF-C-1.ZIP / GCOMM / YMGR.C < prev    next >
Encoding:
C/C++ Source or Header  |  1990-08-14  |  4.6 KB  |  114 lines
  1. /*
  2.  * YMGR.C
  3.  *
  4.  * Contains:     YmodemGReceive()
  5.  *
  6.  * The Greenleaf Comm Library
  7.  *
  8.  * Copyright (C) 1989-90 Greenleaf Software Inc.  All Rights Reserved.
  9.  *
  10.  */
  11.  
  12. #include <stdio.h>
  13. #include "gf.h"
  14. #include "asiports.h"
  15. #include "xfer.h"
  16. #include "_xfer.h"
  17.  
  18. /*
  19.  *
  20.  * int YmodemGReceive( int port,
  21.  *                     void ( *message_routine )( char *message ),
  22.  *                     void ( *idle_routine )( XFER *status_block ),
  23.  *                     unsigned int abort_key )
  24.  *
  25.  * ARGUMENTS
  26.  *
  27.  * int port:                           The port can be any opened COM port.
  28.  *                                     Take note of the fact that XMODEM file
  29.  *                                     transfers must have a totally transparent
  30.  *                                     eight bit connection.  This means that
  31.  *                                     The port must be opened with eight bits,
  32.  *                                     and XON/XOFF handshaking must be turned
  33.  *                                     off.  In addition, the buffer sizes
  34.  *                                     should be large enough to accomodate the
  35.  *                                     largest XMODEM buffer, which is about
  36.  *                                     1030 bytes.
  37.  *
  38.  * void ( *message_routine )( char * ):The driver routine calls this message
  39.  *                                     routine to print out major progress
  40.  *                                     messages and error messages.  This can
  41.  *                                     be as simple or complicated a routine as
  42.  *                                     the user desires.  All the routine needs
  43.  *                                     to be able to do is print out a string.
  44.  *                                     Note that none of the strings have any
  45.  *                                     embedded control characters.  If this
  46.  *                                     parameter is a NULL, then no message
  47.  *                                     routine is called.
  48.  *
  49.  * void ( *idle_routine)( XFER * ):    This idle routine is called whenever
  50.  *                                     the driver is waiting for buffers to
  51.  *                                     empty out or fill up.  It passes a
  52.  *                                     pointer to the current Xfer status
  53.  *                                     block.  This information will typically
  54.  *                                     be used to update a status display.
  55.  *                                     See XFER.H for documentation on what
  56.  *                                     the fields in the parameter block mean.
  57.  *                                     ANSITERM.C has an example of a status
  58.  *                                     screen using this information.  If this
  59.  *                                     parameter is a NULL, then no idle
  60.  *                                     routine is called.
  61.  *
  62.  * unsigned int abort_key:             The driver routine looks at the
  63.  *                                     keyboard frequently to see if the user
  64.  *                                     wants to abort.  The calling program
  65.  *                                     defines the acceptable abort key with
  66.  *                                     this parameter.
  67.  *
  68.  * DESCRIPTION
  69.  *
  70.  * This routine calls the driver program to perform a YMODEM file receive.
  71.  * Note that no file name is in the parameter list for this routine, since
  72.  * the file name will be sent from the remote end.  Since this is a YMODEM-G
  73.  * transfer, the connection to the remote end must be error free.  In
  74.  * addition, the receive must be able to save files as fast as they are
  75.  * sent, since there is no handshaking.
  76.  *
  77.  * SIDE EFFECTS
  78.  *
  79.  * File(s) may have been transfered.
  80.  *
  81.  * RETURNS
  82.  *
  83.  * The routine returns one of the defined XFER_RETURN codes defined
  84.  * in XFER.H.
  85.  *
  86.  * AUTHOR
  87.  *  Mark Nelson          28-Aug-1989  20:57:40.92
  88.  *
  89.  * MODIFICATIONS
  90.  *
  91.  */
  92.  
  93. int GF_CONV YmodemGReceive( int port,
  94.                     void ( GF_CDECL *message_routine )( char *message ),
  95.                     void ( GF_CDECL *idle_routine )( XFER *status_block ),
  96.                     unsigned int abort_key )
  97. {
  98.     XFER xmodem;
  99.  
  100.     xmodem.port = port;
  101.     xmodem.return_file_name = NULL;
  102.     xmodem.filename = NULL;
  103.     xmodem.file_length = 0L;
  104.     xmodem.message_routine = message_routine;
  105.     xmodem.idle_routine = idle_routine;
  106.     xmodem.abort_key = abort_key;
  107.     xmodem.transfer_type = XFER_TYPE_YMODEM_G;
  108.     xmodem.x.xmodem.crc_mode = TRUE;
  109.     _YmodemReceive( &xmodem );
  110.     return( xmodem.return_status );
  111. }
  112.  
  113.  
  114.