pipe.h

00001 /***************************************************************************
00002  *   Copyright (C) 2001 by Rick L. Vinyard, Jr.                            *
00003  *   rvinyard@cs.nmsu.edu                                                  *
00004  *                                                                         *
00005  *   This program is free software; you can redistribute it and/or modify  *
00006  *   it under the terms of the GNU Lesser General Public License as        *
00007  *   published by the Free Software Foundation version 2.1.                *
00008  *                                                                         *
00009  *   This program is distributed in the hope that it will be useful,       *
00010  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
00011  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
00012  *   GNU General Public License for more details.                          *
00013  *                                                                         *
00014  *   You should have received a copy of the GNU Lesser General Public      *
00015  *   License along with this library; if not, write to the                 *
00016  *   Free Software Foundation, Inc.,                                       *
00017  *   51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA              *
00018  ***************************************************************************/
00019 #ifndef CONEXUSPIPE_H
00020 #define CONEXUSPIPE_H
00021 
00022 #include <conexus/filedescriptor.h>
00023 
00028 namespace Conexus
00029   {
00030 
00037   class Pipe : public FileDescriptor
00038     {
00039     public:
00040       typedef enum PipeState {
00041         READ=LASTENDPOINTSTATE<<1,           
00042         WRITE=LASTENDPOINTSTATE<<2,            
00043         LASTPIPESTATE=WRITE,
00044       } PipeState;
00045 
00046       typedef boost::shared_ptr<Pipe> pointer;
00047       
00048       Pipe();
00049       
00050       static Pipe::pointer create();
00051 
00052       virtual ~Pipe();
00053 
00054       virtual void open() throw (open_error);
00055 
00056       virtual void close(bool force=false) throw (close_error);
00057 
00058       virtual void close_read(bool force=false) throw (close_error);
00059 
00060       virtual void close_write(bool force=false) throw (close_error);
00061 
00062       virtual ssize_t write(const void* data, size_t size, IOMETHOD block=BLOCK) throw (write_error);
00063 
00064       virtual Data read(size_t s = 0) throw (read_error);
00065 
00066       virtual const std::string& object_type() { static std::string s("Conexus::Pipe"); return s; }
00067 
00068     protected:
00069       int m_write_fd;
00070     };
00071 
00072 }
00073 
00074 #endif

Generated on Sun Aug 6 12:16:57 2006 by  doxygen 1.4.6