simgear/io/iochannel.hxx

   1 /**
   2  * \file iochannel.hxx
   3  * High level IO channel base class.
   4  */
   5
   6 // Written by Curtis Olson, started November 1999.
   7 //
   8 // Copyright (C) 1999  Curtis L. Olson - http://www.flightgear.org/~curt
   9 //
  10 // This program is free software; you can redistribute it and/or
  11 // modify it under the terms of the GNU General Public License as
  12 // published by the Free Software Foundation; either version 2 of the
  13 // License, or (at your option) any later version.
  14 //
  15 // This program is distributed in the hope that it will be useful, but
  16 // WITHOUT ANY WARRANTY; without even the implied warranty of
  17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18 // 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  23 //
  24 // $Id$
  25
  26
  27 #ifndef _IOCHANNEL_HXX
  28 #define _IOCHANNEL_HXX
  29
  30
  31 #include <simgear/compiler.h>
  32
  33 // #include "protocol.hxx"
  34
  35 #include <string>
  36 #include <vector>
  37
  38 using std::vector;
  39 using std::string;
  40
  41
  42 #define SG_IO_MAX_MSG_SIZE 16384
  43
  44 /**
  45  * Specify if this is a read (IN), write (OUT), or r/w (BI) directional
  46  * channel
  47  */
  48 enum SGProtocolDir {
  49     SG_IO_NONE = 0,
  50     SG_IO_IN = 1,
  51     SG_IO_OUT = 2,
  52     SG_IO_BI = 3
  53 };
  54
  55 /**
  56  * Specify the channel type
  57  */
  58 enum SGChannelType {
  59     sgFileType = 0,
  60     sgSerialType = 1,
  61     sgSocketType = 2
  62 };
  63
  64
  65 /**
  66  * The SGIOChannel base class provides a consistent method for
  67  * applications to communication through various mediums. By providing
  68  * a base class with multiple derived classes, and application such as
  69  * FlightGear can implement a way to speak any protocol via any kind
  70  * of I/O channel.
  71  *
  72  * All of the SGIOChannel derived classes have exactly the same usage
  73  * interface once an instance has been created.
  74  *
  75  */
  76 class SGIOChannel {
  77
  78     SGChannelType type;
  79     SGProtocolDir dir;
  80     bool valid;
  81
  82 public:
  83
  84     /** Constructor */
  85     SGIOChannel();
  86
  87     /** Destructor */
  88     virtual ~SGIOChannel();
  89
  90     /** Open a channel.
  91      * @param d channel communication "direction"
  92      * Direction can be one of:
  93      *  - SG_IO_IN - data will be flowing into this object to the application.
  94      *  - SG_IO_OUT - data will be flowing out of this object from the
  95      *                application.
  96      *  - SG_IO_BI - data will be flowing in both directions.
  97      *  - SG_IO_NONE - data will not be flowing in either direction.
  98      *                 This is here for the sake of completeness.
  99      * @return result of open
 100      */
 101     virtual bool open( const SGProtocolDir d );
 102
 103     /**
 104      * The read() method is modeled after the read() Unix system
 105      * call. You must provide a pointer to a character buffer that has
 106      * enough allocated space for your potential read. You can also
 107      * specify the maximum number of bytes allowed for this particular
 108      * read. The actual number of bytes read is returned.  You are
 109      * responsible to ensure that the size of buf is large enough to
 110      * accomodate your input message
 111      * @param buf a char pointer to your input buffer
 112      * @param length max number of bytes to read
 113      * @return number of bytes read
 114      */
 115     virtual int read( char *buf, int length );
 116
 117     /**
 118      * The readline() method is similar to read() except that it will
 119      * stop at the first end of line encountered in the input buffer.
 120      * @param buf a char pointer to your input buffer
 121      * @param length max number of bytes to read
 122      * @return number of bytes read
 123      */
 124     virtual int readline( char *buf, int length );
 125
 126
 127     /**
 128      * The write() method is modeled after the write() Unix system
 129      * call and is analogous to the read() method. You provide a
 130      * pointer to a buffer of data, and then length of that data to be
 131      * written out. The number of bytes written is returned.
 132      * @param buf a char pointer to your output buffer
 133      * @param length number of bytes to write
 134      * @return number of bytes written
 135      */
 136     virtual int write( const char *buf, const int length );
 137
 138     /**
 139      * The writestring() method is a simple wrapper that will
 140      * calculate the length of a null terminated character array and
 141      * write it to the output channel.
 142      * @param buf a char pointer to your output buffer
 143      * @return number of bytes written
 144      */
 145     virtual int writestring( const char *str );
 146
 147     /**
 148      * The close() method is modeled after the close() Unix system
 149      * call and will close an open device. You should call this method
 150      * when you are done using your IO class, before it is destructed.
 151      * @return result of close
 152      */
 153     virtual bool close();
 154
 155     /**
 156      * The eof() method returns true if end of file has been reached
 157      * in a context where that makes sense.  Otherwise it returns
 158      * false.
 159      * @return result of eof check
 160      */
 161     virtual bool eof();
 162
 163     inline void set_type( SGChannelType t ) { type = t; }
 164     inline SGChannelType get_type() const { return type; }
 165
 166     inline void set_dir( const SGProtocolDir d ) { dir = d; }
 167     inline SGProtocolDir get_dir() const { return dir; }
 168     inline bool isvalid() const { return valid; }
 169     inline void set_valid( const bool v ) { valid = v; }
 170 };
 171
 172
 173 #endif // _IOCHANNEL_HXX
 174
 175