cbuf.h

Go to the documentation of this file.

/*
 * Copyright (c) 2010-2012 Digi International Inc.,
 * All rights not expressly granted are reserved.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * Digi International Inc. 11001 Bren Road East, Minnetonka, MN 55343
 * =======================================================================
 */

#ifndef XBEE_CBUF_H
#define XBEE_CBUF_H

#include "xbee/platform.h"
#include <stddef.h>
XBEE_BEGIN_DECLS

typedef struct xbee_cbuf_t {
   unsigned int   head;    // front, or head index of data
   unsigned int   tail;    // back, or tail index of data
   unsigned int   mask;    // 2^n - 1
   uint8_t        data[1]; // variable length (<mask> bytes + 1 separator byte)
} xbee_cbuf_t;

#define XBEE_CBUF_OVERHEAD sizeof(xbee_cbuf_t)

int xbee_cbuf_init( xbee_cbuf_t FAR *cbuf, unsigned int datasize);

int xbee_cbuf_putch( xbee_cbuf_t FAR *cbuf, uint_fast8_t ch);


int xbee_cbuf_getch( xbee_cbuf_t FAR *cbuf);


#define xbee_cbuf_length(cbuf)   ((cbuf)->mask)


unsigned int xbee_cbuf_used( xbee_cbuf_t FAR *cbuf);


unsigned int xbee_cbuf_free( xbee_cbuf_t FAR *cbuf);


void xbee_cbuf_flush( xbee_cbuf_t FAR *cbuf);


unsigned int xbee_cbuf_put( xbee_cbuf_t FAR *cbuf, const void FAR *buffer,
                                                      unsigned int length);
unsigned int xbee_cbuf_get( xbee_cbuf_t *cbuf, void FAR *buffer,
                                                      unsigned int length);

XBEE_END_DECLS

// If compiling in Dynamic C, automatically #use the appropriate C file.
#ifdef __DC__
   #use "xbee_cbuf.c"
#endif

#endif      // XBEE_CBUF_H defined