pkt-line: move a misplaced comment
[git/jrn.git] / pkt-line.h
blob7a67e9c65be2621bff63d6828c59f13d87c4a583
1 #ifndef PKTLINE_H
2 #define PKTLINE_H
4 #include "git-compat-util.h"
5 #include "strbuf.h"
7 /*
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).
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).
19 * The writing side could use stdio, but since the reading
20 * side can't, we stay with pure read/write interfaces.
22 void packet_flush(int fd);
23 void packet_write(int fd, const char *fmt, ...) __attribute__((format (printf, 2, 3)));
24 void packet_buf_flush(struct strbuf *buf);
25 void packet_buf_write(struct strbuf *buf, const char *fmt, ...) __attribute__((format (printf, 2, 3)));
27 int packet_read_line(int fd, char *buffer, unsigned size);
28 int packet_read(int fd, char *buffer, unsigned size);
29 int packet_get_line(struct strbuf *out, char **src_buf, size_t *src_len);
30 ssize_t safe_write(int, const void *, ssize_t);
32 #endif