Gambas Documentation
Application Repository
Code Snippets
Compilation & Installation
Components
gb
gb.args
gb.cairo
gb.chart
gb.clipper
gb.complex
gb.compress
gb.crypt
gb.data
.List.Backwards
.List.Item
AvlTree
Circular
_new
Clear
IsEmpty
IsFull
Overwrite
Peek
Read
Reader
Reset
Resize
Size
Write
Writer
Deque
Heap
List
PrioQueue
Queue
Stack
Trie
TriePrefix
gb.db
gb.db.form
gb.db.mysql
gb.db.odbc
gb.db.postgresql
gb.db.sqlite2
gb.db.sqlite3
gb.dbus
gb.dbus.trayicon
gb.debug
gb.desktop
gb.desktop.gnome.keyring
gb.desktop.x11
gb.eval
gb.eval.highlight
gb.form
gb.form.dialog
gb.form.editor
gb.form.htmlview
gb.form.mdi
gb.form.print
gb.form.stock
gb.form.terminal
gb.gmp
gb.gsl
gb.gtk
gb.gtk.opengl
gb.gtk3
gb.gtk3.opengl
gb.gtk3.webview
gb.gui
gb.gui.opengl
gb.gui.qt
gb.gui.qt.ext
gb.gui.qt.opengl
gb.gui.qt.webkit
gb.gui.trayicon
gb.gui.webview
gb.hash
gb.highlight
gb.image
gb.image.effect
gb.image.imlib
gb.image.io
gb.inotify
gb.jit
gb.libxml
gb.logging
gb.map
gb.markdown
gb.media
gb.media.form
gb.memcached
gb.mime
gb.mongodb
gb.mysql
gb.ncurses
gb.net
gb.net.curl
gb.net.pop3
gb.net.smtp
gb.openal
gb.opengl
gb.opengl.glsl
gb.opengl.glu
gb.opengl.sge
gb.openssl
gb.option
gb.pcre
gb.pdf
gb.poppler
gb.qt4
gb.qt4.ext
gb.qt4.opengl
gb.qt4.webkit
gb.qt4.webview
gb.qt5
gb.qt5.ext
gb.qt5.opengl
gb.qt5.webkit
gb.qt5.webview
gb.qt6
gb.qt6.ext
gb.qt6.opengl
gb.qt6.webview
gb.report
gb.report2
gb.scanner
gb.sdl
gb.sdl.sound
gb.sdl2
gb.sdl2.audio
gb.settings
gb.signal
gb.term
gb.test
gb.util
gb.util.web
gb.v4l
gb.vb
gb.web
gb.web.feed
gb.web.form
gb.web.gui
gb.xml
gb.xml.html
gb.xml.rpc
gb.xml.xslt
Controls pictures
Deprecated components
Developer Documentation
Development Environment Documentation
Documents
Error Messages
Gambas Playground
How To's
Language Index
Language Overviews
Last Changes
Lexicon
README
Search the wiki
To Do
Topics
Tutorials
Wiki License
Wiki Manual

Circular (gb.data)

A Circular buffer, or Circular for short, is a fixed-size buffer with one read and one write pointer. When data is read/written, the proper pointer is moved forward independently of the other one. When the end of the buffer is reached, the pointer wraps around to the beginning. Thus, old never-read values can be overwritten.

This datatype may be ideal for communications between entities where it does not really matter when old values get overwritten, but we still want a fixed-size buffer. For example, log messages are traditionally treated using this technique.

More information on circular buffers on Wikipedia

This class is creatable.

Properties
IsEmpty   property Read IsEmpty As Boolean
IsFull   property Read IsFull As Boolean
Overwrite   property Overwrite As Boolean
Reader   property Reader As Integer
Size   property Size As Integer
Writer   property Writer As Integer

Methods
Clear   Remove all the elements in the Circular by advancing the read pointer to the write pointer.
Peek   Function Peek ( ) As Variant
Read   Function Read ( ) As Variant
Reset   Sub Reset ( )
Resize   Sub Resize ( Size As Integer )
Write   Sub Write ( Value As Variant )