Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 83 lines (75 sloc) 3.102 kb
f3a3214e »
2005-06-29 Make send/receive-pack be closer to doing something interesting
1 #ifndef PKTLINE_H
2 #define PKTLINE_H
3
07d68930 »
2006-06-26 Fix pkt-line.h to compile with a non-GCC compiler
4 #include "git-compat-util.h"
f5615d24 »
2009-10-30 pkt-line: Add strbuf based functions
5 #include "strbuf.h"
07d68930 »
2006-06-26 Fix pkt-line.h to compile with a non-GCC compiler
6
f3a3214e »
2005-06-29 Make send/receive-pack be closer to doing something interesting
7 /*
e1485428 »
2013-02-20 pkt-line: move a misplaced comment
8 * Write a packetized stream, where each line is preceded by
9 * its length (including the header) as a 4-byte hex number.
10 * A length of 'zero' means end of stream (and a length of 1-3
11 * would be an error).
12 *
13 * This is all pretty stupid, but we use this packetized line
14 * format to make a streaming format possible without ever
15 * over-running the read buffers. That way we'll never read
16 * into what might be the pack data (which should go to another
17 * process entirely).
18 *
19 * The writing side could use stdio, but since the reading
20 * side can't, we stay with pure read/write interfaces.
f3a3214e »
2005-06-29 Make send/receive-pack be closer to doing something interesting
21 */
22 void packet_flush(int fd);
4ec99bf0 »
2005-08-09 [PATCH] -Werror fixes
23 void packet_write(int fd, const char *fmt, ...) __attribute__((format (printf, 2, 3)));
f5615d24 »
2009-10-30 pkt-line: Add strbuf based functions
24 void packet_buf_flush(struct strbuf *buf);
25 void packet_buf_write(struct strbuf *buf, const char *fmt, ...) __attribute__((format (printf, 2, 3)));
f3a3214e »
2005-06-29 Make send/receive-pack be closer to doing something interesting
26
03809429 »
2013-02-20 pkt-line: provide a generic reading function with options
27 /*
4981fe75 »
2013-02-23 pkt-line: share buffer/descriptor reading implementation
28 * Read a packetized line into the buffer, which must be at least size bytes
29 * long. The return value specifies the number of bytes read into the buffer.
30 *
01689909 »
2014-03-31 comments: fix misuses of "nor"
31 * If src_buffer and *src_buffer are not NULL, it should point to a buffer
32 * containing the packet data to parse, of at least *src_len bytes. After the
33 * function returns, src_buf will be incremented and src_len decremented by the
34 * number of bytes consumed.
4981fe75 »
2013-02-23 pkt-line: share buffer/descriptor reading implementation
35 *
36 * If src_buffer (or *src_buffer) is NULL, then data is read from the
37 * descriptor "fd".
03809429 »
2013-02-20 pkt-line: provide a generic reading function with options
38 *
39 * If options does not contain PACKET_READ_GENTLE_ON_EOF, we will die under any
40 * of the following conditions:
41 *
42 * 1. Read error from descriptor.
43 *
44 * 2. Protocol error from the remote (e.g., bogus length characters).
45 *
46 * 3. Receiving a packet larger than "size" bytes.
47 *
48 * 4. Truncated output from the remote (e.g., we expected a packet but got
49 * EOF, or we got a partial packet followed by EOF).
50 *
51 * If options does contain PACKET_READ_GENTLE_ON_EOF, we will not die on
52 * condition 4 (truncated input), but instead return -1. However, we will still
53 * die for the other 3 conditions.
819b929d »
2013-02-20 pkt-line: teach packet_read_line to chomp newlines
54 *
55 * If options contains PACKET_READ_CHOMP_NEWLINE, a trailing newline (if
56 * present) is removed from the buffer before returning.
03809429 »
2013-02-20 pkt-line: provide a generic reading function with options
57 */
58 #define PACKET_READ_GENTLE_ON_EOF (1u<<0)
819b929d »
2013-02-20 pkt-line: teach packet_read_line to chomp newlines
59 #define PACKET_READ_CHOMP_NEWLINE (1u<<1)
4981fe75 »
2013-02-23 pkt-line: share buffer/descriptor reading implementation
60 int packet_read(int fd, char **src_buffer, size_t *src_len, char
61 *buffer, unsigned size, int options);
03809429 »
2013-02-20 pkt-line: provide a generic reading function with options
62
819b929d »
2013-02-20 pkt-line: teach packet_read_line to chomp newlines
63 /*
64 * Convenience wrapper for packet_read that is not gentle, and sets the
74543a04 »
2013-02-20 pkt-line: provide a LARGE_PACKET_MAX static buffer
65 * CHOMP_NEWLINE option. The return value is NULL for a flush packet,
66 * and otherwise points to a static buffer (that may be overwritten by
67 * subsequent calls). If the size parameter is not NULL, the length of the
68 * packet is written to it.
819b929d »
2013-02-20 pkt-line: teach packet_read_line to chomp newlines
69 */
74543a04 »
2013-02-20 pkt-line: provide a LARGE_PACKET_MAX static buffer
70 char *packet_read_line(int fd, int *size);
71
4981fe75 »
2013-02-23 pkt-line: share buffer/descriptor reading implementation
72 /*
73 * Same as packet_read_line, but read from a buf rather than a descriptor;
74 * see packet_read for details on how src_* is used.
75 */
76 char *packet_read_line_buf(char **src_buf, size_t *src_len, int *size);
03809429 »
2013-02-20 pkt-line: provide a generic reading function with options
77
047ec602 »
2013-02-20 pkt-line: move LARGE_PACKET_MAX definition from sideband
78 #define DEFAULT_PACKET_MAX 1000
79 #define LARGE_PACKET_MAX 65520
74543a04 »
2013-02-20 pkt-line: provide a LARGE_PACKET_MAX static buffer
80 extern char packet_buffer[LARGE_PACKET_MAX];
047ec602 »
2013-02-20 pkt-line: move LARGE_PACKET_MAX definition from sideband
81
f3a3214e »
2005-06-29 Make send/receive-pack be closer to doing something interesting
82 #endif
Something went wrong with that request. Please try again.