NCBI C Toolkit Cross Reference

C/connect/ncbi_ftp_connector.h

  1 #ifndef CONNECT___NCBI_FTP_CONNECTOR__H
  2 #define CONNECT___NCBI_FTP_CONNECTOR__H
  3 
  4 /* $Id: ncbi_ftp_connector.h,v 1.3 2008/10/16 18:55:44 kazimird Exp $
  5  * ===========================================================================
  6  *
  7  *                            PUBLIC DOMAIN NOTICE
  8  *               National Center for Biotechnology Information
  9  *
 10  *  This software/database is a "United States Government Work" under the
 11  *  terms of the United States Copyright Act.  It was written as part of
 12  *  the author's official duties as a United States Government employee and
 13  *  thus cannot be copyrighted.  This software/database is freely available
 14  *  to the public for use. The National Library of Medicine and the U.S.
 15  *  Government have not placed any restriction on its use or reproduction.
 16  *
 17  *  Although all reasonable efforts have been taken to ensure the accuracy
 18  *  and reliability of the software and data, the NLM and the U.S.
 19  *  Government do not and cannot warrant the performance or results that
 20  *  may be obtained by using this software or data. The NLM and the U.S.
 21  *  Government disclaim all warranties, express or implied, including
 22  *  warranties of performance, merchantability or fitness for any particular
 23  *  purpose.
 24  *
 25  *  Please cite the author in any work or product based on this material.
 26  *
 27  * ===========================================================================
 28  *
 29  * Author:  Anton Lavrentiev
 30  *
 31  * File Description:
 32  *   FTP CONNECTOR
 33  *
 34  *   See <connect/ncbi_connector.h> for the detailed specification of
 35  *   the connector's methods and structures.
 36  *
 37  */
 38 
 39 #include <connect/ncbi_buffer.h>
 40 #include <connect/ncbi_connector.h>
 41 
 42 
 43 /** @addtogroup Connectors
 44  *
 45  * @{
 46  */
 47 
 48 
 49 #ifdef __cplusplus
 50 extern "C" {
 51 #endif
 52 
 53 
 54 typedef enum {
 55     fFCDC_LogControl = 1,
 56     fFCDC_LogData    = 2,
 57     fFCDC_LogAll     = fFCDC_LogControl | fFCDC_LogData
 58 } EFCDC_Flags;
 59 typedef unsigned int TFCDC_Flags;
 60 
 61 typedef enum { /* DEPRECATED -- DON'T USE */
 62     eFCDC_LogControl = fFCDC_LogControl,
 63     eFCDC_LogData    = fFCDC_LogData,
 64     eFCDC_LogAll     = fFCDC_LogAll
 65 } EFCDC_OldFlags;
 66 
 67 
 68 /* Create new CONNECTOR structure to handle ftp download transfer.
 69  * Return NULL on error.
 70  */
 71 extern NCBI_XCONNECT_EXPORT CONNECTOR FTP_CreateDownloadConnector
 72 (const char*    host,     /* hostname, required                             */
 73  unsigned short port,     /* port #, 21 [standard] if 0 passed here         */
 74  const char*    user,     /* username, "ftp" [==anonymous] by default       */
 75  const char*    pass,     /* password, "none" by default                    */
 76  const char*    path,     /* initial directory to chdir to on open          */
 77  TFCDC_Flags    flag      /* mostly for logging socket data [optional]      */
 78 );
 79 
 80 
 81 #ifdef __cplusplus
 82 }  /* extern "C" */
 83 #endif
 84 
 85 
 86 /* @} */
 87 
 88 #endif /* CONNECT___NCBI_FTP_CONNECTOR__H */
 89
[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ]
This page was automatically generated by the LXR engine.
Visit the LXR main site for more information.