File: io.h

package info (click to toggle)
proftpd 1.2.0pre9-4
  • links: PTS
  • area: main
  • in suites: slink
  • size: 2,392 kB
  • ctags: 2,648
  • sloc: ansic: 24,012; sh: 1,754; makefile: 536; perl: 281
file content (128 lines) | stat: -rw-r--r-- 4,561 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
/*
 * ProFTPD - FTP server daemon
 * Copyright (c) 1997, 1998 Public Flood Software
 *  
 * 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307, USA.
 */

/* Connection streams, ring-buffers and other goodies related to 
 * non-blocking I/O 
 * $Id: io.h,v 1.2 1999/03/05 02:53:23 flood Exp $
 */

#ifndef __IO_H
#define __IO_H

#define IO_READ		0
#define IO_WRITE	1

#define IOR_REMOVE	(1 << 0)	/* Request scheduled for removal */
#define IOR_CLOSED	(1 << 1)	/* File is closed */
#define IOR_ERROR	(1 << 2)	/* Request resulted in error */
#define IOR_REMOVE_FILE (1 << 3)	/* Destroy associated file */

#define IO_NONBLOCK	(1 << 0)	/* No longer used?!? */
#define IO_INTR		(1 << 1)	/* Indicates that io_* funcs are
                                           allowed to be interrupted
                                           by EINTR, and return -2
                                         */
#define IO_NORESTART	(1 << 2)	/* Indicates that io_* funcs should
                                           not automagically restart
                                           if read() or write() should
                                           return EWOULDBLOCK/EAGAIN
                                           The default is to restart.
                                         */
#define IO_ABORT	(1 << 3)        /* temporary internal flag used
                                           to indicated that i/o on
                                           an IOFILE has been been
                                           aborted and should return -2
                                           at the next possible instant.
                                           In combintation with IO_INTR
                                           and interruptable syscalls
                                           this should be near instantly.
                                           This flag cannot be tested
                                           for as it is cleared immediately
                                           after being detected
                                          */


typedef struct IO_File IOFILE;
typedef struct IO_Buffer IOBUF;
typedef struct IO_Request IOREQ;

struct IO_File {
  pool *pool;				/* Each one has it's own pool */
  int  fd;				/* File descriptor */
  int  mode;				/* 0 == read, 1 == write */
  int  xerrno;				/* errno if applicable */

  int  flags;
  unsigned int restart_secs;

  IOBUF *buf;
  IOREQ *req;				/* Request buffer */
  int  bufsize;				/* Default size of request buffer */
};

struct IO_Buffer {
  char *buf,*cp;
  int left,bufsize;
};

/* cl_read can be used during write operations to asyncronously gather
 * data from a function.  If cl_read returns -1, an error is assumed,
 * otherwise 0 == EOF (write completed)
 */

struct IO_Request {
  IOREQ *next,*prev;

  pool *pool;

  int req_type;				/* Read or Write */
  int req_flags;			/* Request flags */
  IOFILE *file;

  char *buf;
  char *bp,*bufnext;
  int bufsize;				/* Buffer size */

  char *cl_buf,*cl_bp;			/* Client buffer, and head pointer */
  int cl_bytes;				/* Bytes remaining in client buffer */
  int (*cl_io)(IOREQ*,char*,int);	/* Client io function (for async operations) */
  void (*cl_err)(IOREQ*,int);		/* Error occured */
  void (*cl_close)(IOREQ*);		/* Remote side closed */
};

/* Prototypes */

void init_io();
IOFILE *io_open(pool*,int,int);
IOFILE *io_reopen(IOFILE*,int,int);
int io_poll(IOFILE*);
int io_close(IOFILE*);
int io_write(IOFILE*,char*,int);
int io_write_async(IOFILE*,char*,int);
int io_read(IOFILE*,char*,int,int);
int io_printf(IOFILE*,char*,...);
int io_printf_async(IOFILE*,char*,...);
void io_abort(IOFILE*);
void io_set_restart(IOFILE*,int);
void io_set_poll_sleep(IOFILE*,unsigned int);
char *io_gets(char*,int,IOFILE*);
char *io_telnet_gets(char*,int,IOFILE*,IOFILE*);
void io_set_errno(IOFILE *f, int xerrno);

#endif /* __IO_H */