diff options
author | Archie Cobbs <archie@FreeBSD.org> | 1999-11-15 20:17:04 +0000 |
---|---|---|
committer | Archie Cobbs <archie@FreeBSD.org> | 1999-11-15 20:17:04 +0000 |
commit | da8c951da4599068ff307af22bd3d068c093d95d (patch) | |
tree | 427ed91e2f3a17ed21fbec0ff0817d7e1f5e3ade | |
parent | 3ec12efecc8336a17f8732731607afdc293af208 (diff) | |
download | src-da8c951da4599068ff307af22bd3d068c093d95d.tar.gz src-da8c951da4599068ff307af22bd3d068c093d95d.zip |
Add some more comments to the sl_compress_tcp() function.
Notes
Notes:
svn path=/head/; revision=53192
-rw-r--r-- | sys/net/slcompress.c | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/sys/net/slcompress.c b/sys/net/slcompress.c index ca772220a659..200e9c17e969 100644 --- a/sys/net/slcompress.c +++ b/sys/net/slcompress.c @@ -148,8 +148,15 @@ sl_compress_init(comp, max_state) } /* - * Attempt to compress a TCP packet. This function assumes that the - * complete IP+TCP headers have been pulled up into the first mbuf. + * Attempt to compress an outgoing TCP packet and return the type of + * the result. The caller must have already verified that the protocol + * is TCP. The first mbuf must contain the complete IP and TCP headers, + * and "ip" must be == mtod(m, struct ip *). "comp" supplies the + * compression state, and "compress_cid" tells us whether it is OK + * to leave out the CID field when feasible. + * + * The caller is responsible for adjusting m->m_pkthdr.len upon return, + * if m is an M_PKTHDR mbuf. */ u_int sl_compress_tcp(m, ip, comp, compress_cid) |