common/JackMidiReadQueue.h

   1 /*
   2 Copyright (C) 2010 Devin Anderson
   3
   4 This program is free software; you can redistribute it and/or modify
   5 it under the terms of the GNU Lesser General Public License as published by
   6 the Free Software Foundation; either version 2.1 of the License, or
   7 (at your option) any later version.
   8
   9 This program is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 GNU Lesser General Public License for more details.
  13
  14 You should have received a copy of the GNU Lesser General Public License
  15 along with this program; if not, write to the Free Software
  16 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  17
  18 */
  19
  20 #ifndef __JackMidiReadQueue__
  21 #define __JackMidiReadQueue__
  22
  23 #include "JackMidiPort.h"
  24
  25 namespace Jack {
  26
  27     /**
  28      * Interface for objects that MIDI events can be read from.
  29      */
  30
  31     class SERVER_EXPORT JackMidiReadQueue {
  32
  33     public:
  34
  35         virtual
  36         ~JackMidiReadQueue();
  37
  38         /**
  39          * Dequeues an event from the queue.  Returns the event, or 0 if no
  40          * events are available for reading.
  41          *
  42          * An event dequeued from the read queue is guaranteed to be valid up
  43          * until another event is dequeued, at which all bets are off.  Make
  44          * sure that you handle each event you dequeue before dequeueing the
  45          * next event.
  46          */
  47
  48         virtual jack_midi_event_t *
  49         DequeueEvent() = 0;
  50
  51     };
  52
  53 }
  54
  55 #endif