compression.h
1 #ifndef COMPRESSION_H
2 #define COMPRESSION_H 1
3 
4 
5 /* ========================================================================== */
6 /* Include files */
7 
8 #include "config.h"
9 
10 
11 #if !CFG_CMPR_DISABLE
12 
13 
14 /*! \addtogroup COMPRESSION */
15 /*! @{ */
16 
17 
18 /* ========================================================================== */
19 /* Constants */
20 
21 /*! \name Compression algorithms */
22 /*! @{ */
23 # define CMPR_ALG_DEFLATE 0x0001U /*!< \brief DEFLATE according to RFC 1951 */
24 /*! @} */
25 
26 
27 /*! @} */
28 
29 
30 /* ========================================================================== */
31 /* Function prototypes */
32 
33 struct cmpr_stream* cmpr_stream_constructor(unsigned int, int,
34  ssize_t (*tx_send)(int, const void*, size_t, int),
35  ssize_t (*rx_recv)(int, void*, size_t, int) );
36 void cmpr_stream_destructor(void*);
37 posix_ssize_t cmpr_send(void*, const void*, size_t);
38 int cmpr_flush(void*);
39 int cmpr_terminate(void*);
40 posix_ssize_t cmpr_recv(void*, void*, size_t, int);
41 int cmpr_init(void);
42 void cmpr_exit(void);
43 
44 
45 #endif /* !CFG_CMPR_DISABLE */
46 
47 
48 #endif /* COMPRESSION_H */
49 
50 /* EOF */
cmpr_recv
posix_ssize_t cmpr_recv(void *, void *, size_t, int)
Receive data.
Definition: compression.c:443
cmpr_terminate
int cmpr_terminate(void *)
Flush TX direction and terminate data stream.
Definition: compression.c:410
cmpr_flush
int cmpr_flush(void *)
Flush TX direction.
Definition: compression.c:384
cmpr_exit
void cmpr_exit(void)
Shutdown compress module.
Definition: compression.c:870
cmpr_init
int cmpr_init(void)
Initialize compression module.
Definition: compression.c:821
cmpr_stream_destructor
void cmpr_stream_destructor(void *)
Destroy compressed data stream object allocated by compression module.
Definition: compression.c:768
cmpr_stream_constructor
struct cmpr_stream * cmpr_stream_constructor(unsigned int, int, ssize_t(*tx_send)(int, const void *, size_t, int), ssize_t(*rx_recv)(int, void *, size_t, int))
Compressed data stream object constructor.
Definition: compression.c:615
cmpr_send
posix_ssize_t cmpr_send(void *, const void *, size_t)
Send data.
Definition: compression.c:362
Generated at 2024-04-27 using  doxygen