simgear/io/iochannel.hxx

   1 // iochannel.hxx -- High level IO channel class
   2 //
   3 // Written by Curtis Olson, started November 1999.
   4 //
   5 // Copyright (C) 1999  Curtis L. Olson - curt@flightgear.org
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 //
  21 // $Id$
  22
  23
  24 #ifndef _IOCHANNEL_HXX
  25 #define _IOCHANNEL_HXX
  26
  27
  28 #include <simgear/compiler.h>
  29
  30 // #include "protocol.hxx"
  31
  32 #include STL_STRING
  33 #include <vector>
  34
  35 SG_USING_STD(vector);
  36 SG_USING_STD(string);
  37
  38
  39 #define SG_IO_MAX_MSG_SIZE 16384
  40
  41 enum SGProtocolDir {
  42     SG_IO_NONE = 0,
  43     SG_IO_IN = 1,
  44     SG_IO_OUT = 2,
  45     SG_IO_BI = 3
  46 };
  47
  48
  49 enum SGChannelType {
  50     sgFileType = 0,
  51     sgSerialType = 1,
  52     sgSocketType = 2
  53 };
  54
  55 class SGIOChannel {
  56
  57     SGChannelType type;
  58     SGProtocolDir dir;
  59     bool valid;
  60
  61 public:
  62
  63     SGIOChannel();
  64     virtual ~SGIOChannel();
  65
  66     virtual bool open( const SGProtocolDir d );
  67     virtual int read( char *buf, int length );
  68     virtual int readline( char *buf, int length );
  69     virtual int write( const char *buf, const int length );
  70     virtual int writestring( const char *str );
  71     virtual bool close();
  72
  73     inline void set_type( SGChannelType t ) { type = t; }
  74     inline SGChannelType get_type() const { return type; }
  75
  76     inline void set_dir( const SGProtocolDir d ) { dir = d; }
  77     inline SGProtocolDir get_dir() const { return dir; }
  78     inline bool isvalid() const { return valid; }
  79 };
  80
  81
  82 #endif // _IOCHANNEL_HXX
  83
  84