File: dbuf.h

package info (click to toggle)
ircd 2.10.02-1
  • links: PTS
  • area: main
  • in suites: hamm
  • size: 2,228 kB
  • ctags: 2,087
  • sloc: ansic: 29,122; makefile: 664; sh: 307; perl: 18
file content (85 lines) | stat: -rw-r--r-- 2,744 bytes parent folder | download
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
/*
 * IRC - Internet Relay Chat, include/dbuf.h
 * Copyright (C) 1990 Markku Savela
 * Copyright (C) 1996 - 1997 Carlo Wood
 *
 * 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, 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.
 */

#ifndef DBUF_H
#define DBUF_H

/*
 * These structure definitions are only here to be used
 * as a whole, *DO NOT EVER REFER TO THESE FIELDS INSIDE
 * THE STRUCTURES*! It must be possible to change the internal
 * implementation of this package without changing the
 * interface.
 */

typedef struct dbuf {
  u_int length;			/* Current number of bytes stored */
  u_int offset;			/* Offset to the first byte */
  struct dbufbuf *head;		/* First data buffer, if length > 0 */
  struct dbufbuf *tail;		/* last data buffer, if length > 0 */
} dbuf;

/*
 * And this 'dbufbuf' should never be referenced outside the
 * implementation of 'dbuf'--would be "hidden" if C had such
 * keyword...
 * If it was possible, this would compile to be exactly 1 memory
 * page in size. 2048 bytes seems to be the most common size, so
 * as long as a pointer is 4 bytes, we get 2032 bytes for buffer
 * data after we take away a bit for malloc to play with. -avalon
 */
typedef struct dbufbuf
{
  struct dbufbuf *next;		/* Next data buffer, NULL if this is last */
  char data[2032];		/* Actual data stored here */
} dbufbuf;

/*=============================================================================
 * Macro's
 */

/*
 * DBufLength
 *
 * Returns the current number of bytes stored into the buffer.
 */
#define DBufLength(dyn) ((dyn)->length)

/*
 * DBufClear
 *
 * Scratch the current content of the buffer.
 * Release all allocated buffers and make it empty.
 */
#define DBufClear(dyn) dbuf_delete((dyn), DBufLength(dyn))

/*=============================================================================
 * Proto types
 */

extern int dbuf_delete(dbuf *dyn, int length);
extern int dbuf_put(dbuf *dyn, char *buf, int length);
extern char *dbuf_map(dbuf *dyn, int *length);
extern int dbuf_get(dbuf *dyn, char *buf, int length);
extern int dbuf_getmsg(dbuf *dyn, char *buf, int length);

extern int dbufalloc, dbufblocks;

#endif /* DBUF_H */