HcBin.h File Reference

API Definition for HcBin objects (Hillcrest Binary Files). More...

#include <stdint.h>

Include dependency graph for HcBin.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	HcBin_s

Typedefs
typedef struct HcBin_s	HcBin_t

Detailed Description

API Definition for HcBin objects (Hillcrest Binary Files).

Author

David Wheeler

Date

10 February 2016

This interface definition is intended to represent such files in a way that supports compression and/or streaming data via a serial interface.

Typedef Documentation

HcBin_t

typedef struct HcBin_s HcBin_t

Abstract Data Type for Hillcrest Binary Files.

Function pointers provide open, close and other operations. Note restrictions on calling order among these operations. Open must be called first, followed by calls to getMeta, getAppLen and getPacketLen. Only then should getAppData be called, starting from offset 0 and increasing continuously. close may be called at any time to terminate the session.