ProFTPD Developer's Guide: API Structs

ProFTPD Version 1.2

 struct Class {

   char *Class;
   unsigned long Count;

  };

 struct IO_Buffer {

   char *buf, *cp;
   int left, bufsize;

 };

 struct IO_File {

   /* memory pool for this object */
   pool *pool;
   int fd;

   /* 0 == read, 1 == write */
   int mode;

   /* errno, if applicable */
   int xerrno;

   int flags;
   unsigned int restart_secs;
 
   IOBUF *buf;
    
   /* request buffer size */
   IOREQ *req;

   /* default size of the request buffer */
   int bufsize;

 };

 struct IO_Request {

   IOREQ *next, *prev;

   /* memory pool for this object */
   pool *pool;

   /* read or write */
   int req_type;

   /* request flags */
   int req_flags;
       
   IOFILE *file;

   char *buf;
   char *bp, *bufnext;

   /* buffer size */
   int bufsize;

   /* client buffer, and head pointer */
   char *cl_buf, *cl_bp;

   /* bytes remaining in the client buffer */
   int cl_bytes;

   /* client IO funtion (for async operations) */
   int (*cl_io)(IOREQ *, char *, int);

   /* error occurred */
   void (*cl_err)(IOREQ *, int);

   /* remote side closed */
   void (*cl_close)(IOREQ *);

 };

 struct XAset {
    
   xasetmember_t *xas_list;

   /* memory pool for this object */
   pool *mempool;

   XASET_COMPARE xas_compare;

 };

 struct XAsetmember {

   xasetmember_t *next, *prev;

 };

 struct cleanup {

   void *data;
   void (*plain_cleanup)(void *);
   void (*child_cleanup)(void *);
   struct cleanup *next;

 };

 struct config_struc {

   struct config_struc *next, *prev;
 
   /* this will be one of the CONF_* types */
   int config_type;

   /* memory pool for this object */
   pool *pool;

   /* the set in which we're stored */
   xaset_t *set;

   char *name;
   int argc;
   void **argv;

   /* override classes */
   long overrides;

   /* flags */
   long flags;

   /* server to which this config element is attached */
   server_rec *server;

   /* parent configuration record */
   config_rec *parent;

   /* sub-configuration */
   xaset_t *subset;

 };

 struct filename {

   struct filename *down;
   struct filename *right;
   int top;
   char line[1];

 };

 struct fs_dir_handler {

   fsdir_t *next;
   char *name;

   /* parent handlers */
   fsdir_t *parent;
   void *private;

   /* actual handler functions */
   int (*stat)(fsdir_t *, const char *, struct stat *);
   int (*lstat)(fsdir_t *, const char *, struct stat *);
   int (*rename)(fsdir_t *, const char *, const char *);
   int (*unlink)(fsdir_t *, const char *);
   int (*open)(fsdir_t *, const char *, int);
   int (*creat)(fsdir_t *, const char *, mode_t);
   int (*close)(fsdir_t *, int);
   int (*read)(fsdir_t *, int, char *, size_t);
   int (*write)(fsdir_t *, int, char char *, size_t);
   off_t (*lseek)(fsdir_t *, int, off_t, int);
   int (*link)(fsdir_t *, const char *, const char *);
   int (*symlink)(fsdir_t *, const char *, const char *);
   int (*readlink)(fsdir_t *, const char *, char *, size_t);
   int (*chmod)(fsdir_t *, const char *, mode_t);
   int (*chown)(fsdir_t *, const char *, uid_t, gid_t);
   int (*chdir)(fsdir_t *, const char *);

   /* for actual operations on the directory (or subdirs)
    * we cast the return from opendir to DIR * in src/fs.c
    * so modules can use their own data type
    */
   void *(*opendir)(fsdir_t *, const char *);

   int (*closedir)(fsdir_t *, void *);
   struct dirent *(*readdir)(fsdir_t *, void *);

 };

 struct fs_dir_match {

   fsmatch_t *next;
   char *name;
   int opmask;

   int (*dir_hit)(fsdir_t *, const char *, int);
   int (*file_hit)(fsdir_t *, const char *, int);

 };

 struct logfile_struc {

   logfile_t *next, *prev;
       
   int lf_fd;
   int lf_classes;
   char *lf_filename;
   logformat_t *lf_format;

   /* pointer to the "owning" configuration */
   config_rec *lf_conf;

 };

 struct logformat_struc {

   logformat_t *next, *prev;

   char *lf_nickname;
   unsigned char *lf_format;
 
 };

 struct modret_struc {

   /* which module handled this? */
   module *mr_handler_module;

   /* not zero if there was an error */
   int mr_error;

   /* numeric error code */
   char *mr_numeric;

   /* text message */
   char *mr_message;

   /* additional data -- undefined */
   void *data;

 };

 struct module_struc {

   module *next, *prev;

   /* module API version -- NOT module version */
   int ver;

   /* module name */
   char *name;

   /* configuration directive table */
   conftable *conftable;

   /* command handler table */
   cmdtable *cmdtable;

   /* authentication handler table */
   authtable *authtable;

   /* module initialization */
   int (*module_init)();

   /* post-fork initialization */
   int (*module_init_child)();

   /* internal use, greater number == higher priority */
   int priority;

 };

 struct opendir_struct {

   opendir_t *next, *prev;
   DIR *dir;
   fsdir_t *fsdir;

 };

 struct option

#if __STDC__
   const char *name;
#else
   char *name;
#endif

   /* has_arg can't be enum because some compilers complain
    * about type mismatches in all the code that assumes
    * it is an int.
    */
   int has_arg;

   int *flag;
   int val;

 };

 struct option_help {

   char *long_opt, *short_opt, *desc;

 };

 struct pool {

   union block_hdr *first;
   union block_hdr *last;
   struct clean *cleanups;
   struct pool *sub_pools;
   struct pool *sub_next;
   struct pool *sub_prev;
   struct pool *parent;
   char *free_first_avail;
   char symbol;

 }

 struct privdata {

   char *tag;
 
   union {

     void *ptr_val;
     int int_val;
     long long_val;
     char *str_val;

   } value;

   module *m;

 };

 struct rehash {

   struct rehash *next;
   void *data;
   void (*rehash)(void *);

 };

 struct sort_filename {

   time_t mtime;
   char *name, *suffix;

 };

 struct symbol_hash {

   struct symbol_hash *next, *prev;

   /* pointer to the directive, command, or other symbol */
   char *sym_name;

   /* one of the SYM_* macros */
   char sym_type;

   module *sym_module;

   union {

     conftable *sym_conf;
     cmdtable *sym_cmd;
     authtable *sym_auth;
     void *sym_generic;

   } ptr;

 };