Add some more comments to the sl_compress_tcp() function.

This commit is contained in:
Archie Cobbs 1999-11-15 20:17:04 +00:00
parent 3ec12efecc
commit da8c951da4
Notes: svn2git 2020-12-20 02:59:44 +00:00
svn path=/head/; revision=53192

View file

@ -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)