ringbuffer 3 LCM Library
ringbuffer

## Synopsis

    typedef             lcm_ringbuf_t;
    lcm_ringbuf_t *     lcm_ringbuf_new                     (unsigned int ring_size);
    void                lcm_ringbuf_free                    (lcm_ringbuf_t *ring);
    char *              lcm_ringbuf_alloc                   (lcm_ringbuf_t *ring,
                                                             unsigned int len);
    void                lcm_ringbuf_shrink_last             (lcm_ringbuf_t *ring,
                                                             const char *buf,
                                                             unsigned int len);
    double              lcm_ringbuf_available               (lcm_ringbuf_t *ring);
    void                lcm_ringbuf_dealloc                 (lcm_ringbuf_t *ring,
                                                             char *buf);

## Description

## Details

### lcm_ringbuf_t

    typedef struct _lcm_ringbuf lcm_ringbuf_t;

lcm_ringbuf_t

### lcm_ringbuf_new ()

    lcm_ringbuf_t *     lcm_ringbuf_new                     (unsigned int ring_size);

ring_size :

Returns :

lcm_ringbuf_new

### lcm_ringbuf_free ()

    void                lcm_ringbuf_free                    (lcm_ringbuf_t *ring);

ring :

lcm_ringbuf_free

### lcm_ringbuf_alloc ()

    char *              lcm_ringbuf_alloc                   (lcm_ringbuf_t *ring,
                                                             unsigned int len);

ring :

len :

Returns :

lcm_ringbuf_alloc

### lcm_ringbuf_shrink_last ()

    void                lcm_ringbuf_shrink_last             (lcm_ringbuf_t *ring,
                                                             const char *buf,
                                                             unsigned int len);

ring :

buf :

len :

lcm_ringbuf_shrink_last

### lcm_ringbuf_available ()

    double              lcm_ringbuf_available               (lcm_ringbuf_t *ring);

ring :

Returns :

lcm_ringbuf_available

### lcm_ringbuf_dealloc ()

    void                lcm_ringbuf_dealloc                 (lcm_ringbuf_t *ring,
                                                             char *buf);

ring :

buf :

lcm_ringbuf_dealloc