Mercurial > dropbear

annotate circbuffer.h @ 1060:4c733310c21d nocircbuffer

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
reword comment for clarity
author Matt Johnston <matt@ucc.asn.au>
date Sun, 01 Mar 2015 23:26:42 +0800
parents c71df09bc610
children acf444bcb115
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
108
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
1 /*
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
2 * Dropbear SSH
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
3 *
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
4 * Copyright (c) 2002-2004 Matt Johnston
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
5 * All rights reserved.
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
6 *
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
8 * of this software and associated documentation files (the "Software"), to deal
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
9 * in the Software without restriction, including without limitation the rights
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
11 * copies of the Software, and to permit persons to whom the Software is
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
12 * furnished to do so, subject to the following conditions:
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
13 *
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
14 * The above copyright notice and this permission notice shall be included in
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
15 * all copies or substantial portions of the Software.
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
16 *
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
23 * SOFTWARE. */
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
24
1036
deed0571cacc DROPBEAR_ prefix for include guards to avoid collisions
Thorsten Horstmann <thorsten.horstmann@web.de>
parents: 108
diff changeset
25 #ifndef DROPBEAR_CIRCBUFFER_H_
deed0571cacc DROPBEAR_ prefix for include guards to avoid collisions
Thorsten Horstmann <thorsten.horstmann@web.de>
parents: 108
diff changeset
26 #define DROPBEAR_CIRCBUFFER_H_
108
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
27 struct circbuf {
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
28
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
29 unsigned int size;
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
30 unsigned int readpos;
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
31 unsigned int writepos;
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
32 unsigned int used;
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
33 unsigned char* data;
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
34 };
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
35
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
36 typedef struct circbuf circbuffer;
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
37
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
38 circbuffer * cbuf_new(unsigned int size);
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
39 void cbuf_free(circbuffer * cbuf);
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
40
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
41 unsigned int cbuf_getused(circbuffer * cbuf); /* how much data stored */
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
42 unsigned int cbuf_getavail(circbuffer * cbuf); /* how much we can write */
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
43 unsigned int cbuf_readlen(circbuffer *cbuf); /* max linear read len */
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
44 unsigned int cbuf_writelen(circbuffer *cbuf); /* max linear write len */
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
45
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
46 unsigned char* cbuf_readptr(circbuffer *cbuf, unsigned int len);
1054
c71df09bc610 Avoid copying data into circular buffer
Matt Johnston <matt@ucc.asn.au>
parents: 1036
diff changeset
47 void cbuf_readptrs(circbuffer *cbuf,
c71df09bc610 Avoid copying data into circular buffer
Matt Johnston <matt@ucc.asn.au>
parents: 1036
diff changeset
48 unsigned char **p1, unsigned int *len1,
c71df09bc610 Avoid copying data into circular buffer
Matt Johnston <matt@ucc.asn.au>
parents: 1036
diff changeset
49 unsigned char **p2, unsigned int *len2);
108
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
50 unsigned char* cbuf_writeptr(circbuffer *cbuf, unsigned int len);
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
51 void cbuf_incrwrite(circbuffer *cbuf, unsigned int len);
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
52 void cbuf_incrread(circbuffer *cbuf, unsigned int len);
10f4d3319780 - added circular buffering for channels
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
53 #endif