Component: Circular Buffer Free (Buffer)
From Flowcode Help
(Redirected from Component: ID 4b470b69 a5ec 4c2c 9b3e 67c88ba17583)
Jump to navigationJump to searchAuthor | Matrix Ltd |
Version | 1.5 |
Category | Buffer |
Contents
Circular Buffer Free component
Circular buffer component allowing easy and efficient first in first out (FIFO) style data byte storage. Useful when used with a comms component to capture data as it comes in ready for processing when we have time. Also features macros to allow you to check for specific incoming responses such as "OK" or "ERROR".
Component Source Code
Please click here to download the component source project: FC_Comp_Source_CircularBuffer_Free.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_CircularBuffer_Free.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
FlushBuffer
FlushBuffer | |
Clears the contents of the buffer and re-initialises the index locations. | |
- VOID | Return |
GetByte
GetByte | |
Reads the next available byte from the circular buffer, Returns 255/512 if the buffer is empty. | |
- UINT | Return |
GetConsoleHandle
GetConsoleHandle | |
Gets the handle to the console allowing data displaying on the panel etc. | |
- HANDLE | Return |
GetIndexedByte
GetIndexedByte | |
Gets the value of a single byte at a known location in the buffer. Leaves the buffer contents and pointers untouched. | |
- UINT | address |
- BYTE | Return |
GetNumberBytes
GetNumberBytes | |
Returns the number of valid data bytes currently inside the buffer. | |
- UINT | Return |
LookForValue
PeekByte
PeekByte | |
Reads the next available byte from the circular buffer without advancing the current index, Returns 255/512 if the buffer is empty. | |
- UINT | Return |
PutByte
WaitForValue