1

#ifndef LINE_PROTO_H

     2

#define LINE_PROTO_H

     3

     4

/*

     5

 * Support for protocols that send/receive lines

     6

 */

     7

#include "sock.h"

     8

#include "error.h"

     9

    10

/*

    11

 * The state handle

    12

 */

    13

struct line_proto;

    14

    15

/*

    16

 * The callback for receiving lines

    17

 */

    18

typedef void (*line_proto_read_cb)(char *line, void *arg);

    19

    20

/*

    21

 * Create a new line_proto off the the given sock_stream. The newly allocated line_proto will be returned via *lp_ptr.

    22

 *

    23

 * The incoming lines are buffered in a buffer of \a buf_size bytes. This imposes a maximum limit on the line length.

    24

 *

    25

 * The given callback function/argument will be used to provide event-based recv support.

    26

 */

    27

err_t line_proto_create (struct line_proto **lp_ptr, struct sock_stream *sock, size_t buf_size,

    28

        line_proto_read_cb cb_func, void *cb_arg, struct error_info *err);

    29

    30

/*

    31

 * Runs the socket recv() into our internal buffer. If a full line was received, a pointer to our internal bufffer is

    32

 * returned via *line_ptr, and we return SUCCESS. If we don't yet have a full line, and receiving more would block,

    33

 * NULL is returned via *line_ptr instead. Otherwise, nonzero error return code.

    34

 */

    36

    37

/*

    38

 * Write a single line to the sock_stream, buffering any incomplete fragment that remains unset. Returns zero if the

    39

 * line was succesfully sent, >0 if it was only partially sent, or -err on errors.

    40

 *

    41

 * The given line should already include the terminating '\r\n' character sequence.

    42

 */

    50

    51

/*

    52

 * Get current error_info*

    53

 */

    54

const struct error_info* line_proto_error (struct line_proto *lp);

    55

    56

#endif /* LINE_PROTO_H */