# queue03

queue03 - fifo queue (number 01 is the template)

Author | Joep Suijs, Copyright © 2009, all rights reserved.
Adapted-by |
Compiler | >=2.4i

Description

    this library provides a (one) byte fifo queue.
    This queue is interrupt-safe in the sense that you can write to the queue from the interrupt and
    read from the main program or vice versa without special precautions.
    Reading (or writing) from both interrupt and main program might not work properly.

    The basic interface is pseudo var:
    queue03 = x -- put x into queue; block if queue is full
    x = queue03 -- read x from queue; block if queue is empty

    non-blocking access to the same queue is provided by
    queue03_nb_put()
    and
    queue03_nb_get()

    other methods:
    queue03_clear()    -- clear queue (makes queue empty)
    queue03_empty()    -- returns true if queue is emtpy (depricated, use queue1_is_empty())
    queue03_is_empty() -- returns true if queue is emtpy
    queue03_is_full()  -- returns true if queue is full
    queue03_nr_free()  -- returns nr of free places in queue
    queue03_nr_used()  -- returns nr of used places in queue

Dependencies

No dependency found

## Summary

### Global variables/contants

- `var volatile byte queue03_in_pointer = 0 ; wijst naar vrije locatie`
- `var volatile byte queue03_data[queue03_size + 1]`
- `var volatile byte queue03_out_pointer = 0 ; wijst naar databyte`

### Procedures

- `queue03'put(byte in v)`
- `queue03_clear()`
- `queue03_nb'put(byte in v)`

### Functions

- `queue03_nr_free() return byte`
- `queue03'get() return byte`
- `queue03_nr_used() return byte`
- `queue03_nb_put(byte in v) return bit`
- `queue03_is_full() return bit`
- `queue03_nb'get() return byte`
- `queue03_nb_get(byte out v) return bit`
- `queue03_is_empty() return bit`
- `queue03_empty() return bit`

## API details

### Global variables/contants

- `var volatile byte queue03_in_pointer = 0 ; wijst naar vrije locatie`

  No documentation found

- `var volatile byte queue03_data[queue03_size + 1]`

      queue vars

- `var volatile byte queue03_out_pointer = 0 ; wijst naar databyte`

  No documentation found

### Procedures

- `queue03'put(byte in v)`

      queue03'put - put one byte into queue

      When the queue is full, it waits until a byte is removed from the queue.

- `queue03_clear()`

      deprecated

- `queue03_nb'put(byte in v)`

      queue03_nb'put - put one byte into queue (non-blocking)

### Functions

- `queue03_nr_free() return byte`

      queue03_nr_free - returns nr of free places in queue

- `queue03'get() return byte`

      queue03'get - get one byte from queue

      returns byte from queue.
      When the queue is empty, it waits until a byte is put into the queue.

- `queue03_nr_used() return byte`

      queue03_nr_used - returns nr of used places in queue

- `queue03_nb_put(byte in v) return bit`

      queue03_nb_put - put one byte into queue (non-blocking)

      return:  true  when the byte is put into the queue
      false when the queue is full (byte is not put in queue)

- `queue03_is_full() return bit`

      queue03_is_full()  -- returns true if queue is full

- `queue03_nb'get() return byte`

      queue03_nb'get - get one byte from queue (non-blocking)

      returns byte from queue, 0 if queue empty

- `queue03_nb_get(byte out v) return bit`

      queue03_nb_get - get one byte from queue (non-blocking)

      The byte read is put into v (calling param)
      returns: true  when we read a byte from the queue
      false when the queue is empty (byte is not read from queue)

- `queue03_is_empty() return bit`

      queue03_is_empty() -- returns true if queue is emtpy

- `queue03_empty() return bit`

## Related samples

No sample found