Component: DBBufferC

Required Interfaces

Provided Interfaces

Variables

typedef enum DBBufferC.__nesc_unnamed4243 { DBBufferC.kIDLE, DBBufferC.kALLOC_SCHEMA, DBBufferC.kALLOC_BUFFER, DBBufferC.kALLOC_ROW, DBBufferC.kALLOC_NAME, DBBufferC.kREAD_ROW, DBBufferC.kEEPROM_WRITE, DBBufferC.kEEPROM_ALLOC_ROW, DBBufferC.kREADING_LENGTH, DBBufferC.kALLOC_FOR_READ, DBBufferC.kREADING_DATA, DBBufferC.kWRITE_BUFFER, DBBufferC.kHEADER_READ, DBBufferC.kWRITE_FILE_COUNT, DBBufferC.kREAD_FILE_COUNT, DBBufferC.kREAD_OPEN, DBBufferC.kREAD_LENGTHS, DBBufferC.kSKIP_BYTES, DBBufferC.kREAD_NAME, DBBufferC.kREAD_FIELD_LEN, DBBufferC.kALLOC_FIELD_DATA, DBBufferC.kREAD_FIELD_DATA, DBBufferC.kALLOC_QUERY, DBBufferC.kREAD_QUERY, DBBufferC.kREAD_BUFFER, DBBufferC.kWRITING_LENGTHS, DBBufferC.kWRITING_NAME, DBBufferC.kWRITING_QUERY, DBBufferC.kWRITING_BUFFER, DBBufferC.kWRITE_FIELD_LEN, DBBufferC.kWRITE_FIELD_DATA, DBBufferC.kWRITE_NEXT_BUFFER, DBBufferC.kNOT_READY, DBBufferC.kOPEN_BUFFER, DBBufferC.kRADIO_ENQUEUE, DBBufferC.kCLEANUP } AllocState

DBBuffer is a output buffer abstraction for TinyDB.
typedef struct DBBufferC.__nesc_unnamed4244 { BufferType type; BufferPolicy policy; ParsedQuery **qh; uint16_t numRows; uint16_t nextFree; uint16_t nextFull; uint16_t len; uint16_t rowSize; long data; char **name; union DBBufferC.__nesc_unnamed4245 { char **bufdata; struct DBBufferC.__nesc_unnamed4246 { bool isOpen; bool isWrite; } eeprom; } u; } Buffer
DBBufferC.Buffer mBuffers[DBBufferC.kNUM_BUFS]
long mUsedBufs
uint8_t mCurBuffer
uint16_t mCurRow
uint8_t mLen
uint8_t mSearchFile
uint8_t mCurFile
uint8_t mLenBytes[3]
Handle mCurRowHandle
Handle mEepromRow
QueryResultPtr mCurResult
ParsedQuery *mAllocSchema
ParsedQuery *mCurQuery
uint8_t mCurResultIdx
DBBufferC.AllocState mState
char *mNamePtr
char mDbgBuf[10]
uint8_t ATTR_TYPES[DBBufferC.NUM_ATTR_FIELDS]
uint8_t ATTR_SIZES[DBBufferC.NUM_ATTR_FIELDS]
char ATTR_NAMES[DBBufferC.NUM_ATTR_FIELDS][STRING_SIZE]
TinyDBError calcNextFreeRow(DBBufferC.Buffer *buf)
(PRIVATE) Adjust the next free row in the buffer

Returns: err_OutOfMemory if the policy indicates that no more inserts should be allowed
TinyDBError getBuf(uint8_t bufId, DBBufferC.Buffer **buf)
(PRIVATE) Return a pointer to buffer bufId in buf if bufId is a valid buf.
void cleanupBuffer(int i, int lineno)
(PRIVATE) Clean up buffer id b.
void initCatalog(void)
TinyDBError getSpecialBufferId(BufferType type, uint8_t *bufferId)
TinyDBError continueRadioBufferEnqueue(void)

Function Index

command result_t StdControl.init (void)
command result_t StdControl.start (void)
command result_t StdControl.stop (void)
void initCatalog(void)
command TinyDBError DBBuffer.enqueue (uint8_t bufferId, QueryResultPtr r, bool *pending, ParsedQuery *pq) Enqueue a result into the specified buffer Note that if pending returns true, this routine may store a reference to r (so it had better not be on the stack!)
TinyDBError continueRadioBufferEnqueue(void)
command TinyDBError DBBuffer.peek (uint8_t bufferId, QueryResult *qr, bool *pending) Copy the top most result in the buffer into buf

Returns: err_NoMoreResults if no results are available

err_UnsupportedBuffer if the buffer doesn't support peek/pop
command TinyDBError DBBuffer.getResult (uint8_t bufferId, uint16_t idx, QueryResult *qr, bool *pending) Copy the nth result in the buffer into buf

Returns: err_NoMoreResults if idx > getSize() or if buffer[idx] is empty (unset)
command TinyDBError DBBuffer.size (uint8_t bufferId, uint16_t *size)
command TinyDBError DBBuffer.alloc (uint8_t bufferId, BufferType type, uint16_t size, BufferPolicy policy, ParsedQuery *schema, char *name, bool *pending, long data) Allocate the buffer with the specified size sizes is an array of sizes of each field, with one entry per field
Note that this may keep a reference to schema or name until after pending is complete (so neither may be allocated on the callers stack!)
Signals allocComplete when allocation is complete if *pending is true on return
command uint16_t DBBuffer.maxSize (uint8_t bufferId)

Returns: the number of rows in this buffer
command ParsedQuery DBBuffer.getSchema (uint8_t bufferId)

Returns: the schema of the result
command TinyDBError DBBuffer.getFieldId (uint8_t bufferId, FieldPtr f, uint8_t *id) Copy the index of the named field f in bufferId (which was generated via a call to getBufferId) into id, if f exists in the result buffer
command TinyDBError DBBuffer.getField (uint8_t bufferId, QueryResult *qr, uint8_t idx, char *resultBuf) Copy data from the idxth field of qr into resultBuf.
command TinyDBError DBBuffer.nextUnusedBuffer (uint8_t *bufferId)
command TinyDBError DBBuffer.getBufferIdFromName (char *name, uint8_t *bufferId) Looks up the buffer id that corresponds to the specified name

Parameters:
name - The name of the buffer
bufferId - (on return) The id of buffer name

Returns: err_InvalidIndex if no such buffer exists
command TinyDBError DBBuffer.qidFromBufferId (uint8_t bufId, uint8_t *qid) Given a buffer id, return the query id which describes its schema
command TinyDBError DBBuffer.getBufferId (uint8_t bufIdx, bool special, uint8_t *bufferId)
command uint8_t CatalogTable.catalogFieldSize (uint8_t bufIdx, uint8_t fieldNo) Return the size of the requested field in a "special" catalog table.
command TinyDBError DBBuffer.openBuffer (uint8_t bufIdx, bool *pending) Open the specified buffer for writing
event result_t DBBuffer.resultReady (uint8_t bufferId)
event result_t DBBuffer.getNext (uint8_t bufferId)
event result_t DBBuffer.allocComplete (uint8_t bufferId, TinyDBError result)
event result_t DBBuffer.putComplete (uint8_t bufferId, QueryResult *buf, TinyDBError result)
event result_t MemAlloc.allocComplete (HandlePtr handle, result_t success)
event result_t MemAlloc.compactComplete (void)
event result_t MemAlloc.reallocComplete (Handle handle, result_t success)
event result_t QueryProcessor.queryComplete (ParsedQueryPtr q)
event result_t CommandUse.commandDone (char *commandName, char *resultBuf, SchemaErrorNo err)
event result_t AttrUse.getAttrDone (char *name, char *resultBuf, SchemaErrorNo errorNo)
event result_t AttrUse.startAttrDone (uint8_t id)
event bool RadioQueue.enqueueDone (void)
TinyDBError calcNextFreeRow(DBBufferC.Buffer *buf) (PRIVATE) Adjust the next free row in the buffer

Returns: err_OutOfMemory if the policy indicates that no more inserts should be allowed
TinyDBError getBuf (uint8_t bufId, DBBufferC.Buffer **buf) (PRIVATE) Return a pointer to buffer bufId in buf if bufId is a valid buf.
void cleanupBuffer (int b, int lineNo) (PRIVATE) Clean up buffer id b.
TinyDBError getSpecialBufferId(BufferType type, uint8_t *bufferId)

Function Descriptions

DBBuffer.alloc

command TinyDBError DBBuffer.alloc (uint8_t bufferId, BufferType type, uint16_t size, BufferPolicy policy, ParsedQuery *schema, char *name, bool *pending, long data)

Allocate the buffer with the specified size sizes is an array of sizes of each field, with one entry per field

Note that this may keep a reference to schema or name until after pending is complete (so neither may be allocated on the callers stack!)

Signals allocComplete when allocation is complete if *pending is true on return

Parameters:
bufferId - The buffer to allocate
type - The type of the buffer (see DBBuffer.h -- only kRAM and kRADIO are supported)
size - The size (in rows) of the buffer
policy - The eviction policy to use with the buffer (see DBBuffer.h)
schema - The schema (layout) of rows in this buffer (expressed as a query)
name - The name of the schema (or NULL if it has no name)
pending - On return, set to true if the buffer is still being allocated (expect allocComplete if true).
data - is currently unused

Returns: err_UnsupportedPolicy if the specified policy can't be applied

DBBuffer.getField

command TinyDBError DBBuffer.getField (uint8_t bufferId, QueryResult *qr, uint8_t idx, char *resultBuf)

Copy data from the idxth field of qr into resultBuf. qr must have been produced via a call to peek() or getResult() on the same bufferId.

DBBuffer.getBufferId

command TinyDBError DBBuffer.getBufferId (uint8_t bufIdx, bool special, uint8_t *bufferId)

Returns:

the buffer id that corresponds to the specified bufIdx if special is false, bufIdx is just the query id that we want to read from otherwise, it's the index into special buffers -- e.g. catalog buffers -- that we want to use

CatalogTable.catalogFieldSize

command uint8_t CatalogTable.catalogFieldSize (uint8_t bufIdx, uint8_t fieldNo)

Return the size of the requested field in a "special" catalog table. Return 0 if the field number is out of range or bufIdx is an unknown field.

getBuf

TinyDBError getBuf(uint8_t bufId, DBBufferC.Buffer **buf)

(PRIVATE) Return a pointer to buffer bufId in buf if bufId is a valid buf. Otherwise, return err_InvalidIndex

cleanupBuffer

void cleanupBuffer(int b, int lineNo)

(PRIVATE) Clean up buffer id b. Deallocates all associated memory and sets the buffer use bits appropriately. Note that this should work even an allocation is partly completed -- it checks for NULL before deallocating.

Returns:	err_NoMoreResults if no results are available
	err_UnsupportedBuffer if the buffer doesn't support peek/pop

Parameters:	name - The name of the buffer bufferId - (on return) The id of buffer name
Returns:	err_InvalidIndex if no such buffer exists