jDttSP/chan.h

   1 /* chan.h
   2
   3 fast inter-user-process single-reader/single-writer channels
   4 using a modified version of jack ringbuffers and memory-mapped files.
   5
   6 This file is part of a program that implements a Software-Defined Radio.
   7
   8 Copyright (C) 2004 by Frank Brickle, AB2KT and Bob McGwier, N4HY
   9
  10 This program is free software; you can redistribute it and/or modify
  11 it under the terms of the GNU General Public License as published by
  12 the Free Software Foundation; either version 2 of the License, or
  13 (at your option) any later version.
  14
  15 This program is distributed in the hope that it will be useful,
  16 but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 GNU General Public License for more details.
  19
  20 You should have received a copy of the GNU General Public License
  21 along with this program; if not, write to the Free Software
  22 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  23
  24 The authors can be reached by email at
  25
  26 ab2kt@arrl.net
  27 or
  28 rwmcgwier@comcast.net
  29
  30 or by paper mail at
  31
  32 The DTTS Microwave Society
  33 6 Kathleen Place
  34 Bridgewater, NJ 08807
  35 */
  36
  37 #ifndef _chan_h
  38 #define _chan_h
  39
  40 #include <sys/types.h>
  41 #include <sys/param.h>
  42 #include <sys/stat.h>
  43 #include <sys/time.h>
  44 #include <sys/mman.h>
  45 #include <unistd.h>
  46 #include <fcntl.h>
  47 #include <stdlib.h>
  48 #include <values.h>
  49 #include <stdio.h>
  50 #include <ctype.h>
  51 #include <string.h>
  52 #include <math.h>
  53 #include <assert.h>
  54 #include <libgen.h>
  55 #include <datatypes.h>
  56 #include <banal.h>
  57 #include <bufvec.h>
  58 #include <ringb.h>
  59
  60 typedef
  61 struct _chan {
  62   struct {
  63     size_t buf, rib, tot, tru;
  64   } size;
  65   struct {
  66     char *path;
  67     int desc;
  68   } file;
  69   struct {
  70     char *base;
  71   } map;
  72   ringb_t *rb;
  73 } ChanDesc, *Chan;
  74
  75 extern size_t putChan(Chan c, char *data, size_t size);
  76 extern size_t getChan(Chan c, char *data, size_t size);
  77 extern BOOLEAN putChan_nowait(Chan c, char *data, size_t size);
  78 extern size_t putChan_force(Chan c, char *data, size_t size);
  79 extern BOOLEAN getChan_nowait(Chan c, char *data, size_t size);
  80 extern void resetChan(Chan c);
  81 // NB want will be rounded up to a power of 2
  82 extern Chan openChan(char *path, size_t want);
  83 extern void closeChan(Chan c);
  84
  85 #endif