conexus logo

pipe.h

Go to the documentation of this file.
00001 /***************************************************************************
00002  *   Copyright (C) 2001 by Rick L. Vinyard, Jr.                            *
00003  *   rvinyard@cs.nmsu.edu                                                  *
00004  *                                                                         *
00005  *   This file is part of the conexus library.                             *
00006  *                                                                         *
00007  *   The conexus library is free software; you can redistribute it and/or  *
00008  *   modify it under the terms of the GNU General Public License           *
00009  *   version 3 as published by the Free Software Foundation.               *
00010  *                                                                         *
00011  *   The conexus library is distributed in the hope that it will be        *
00012  *   useful, but WITHOUT ANY WARRANTY; without even the implied warranty   *
00013  *   of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU   *
00014  *   General Public License for more details.                              *
00015  *                                                                         *
00016  *   You should have received a copy of the GNU General Public License     *
00017  *   along with this software. If not see <http://www.gnu.org/licenses/>.  *
00018  ***************************************************************************/
00019 #ifndef CONEXUSPIPE_H
00020 #define CONEXUSPIPE_H
00021 
00022 #include <conexus/filedescriptor.h>
00023 
00032 namespace Conexus
00033 {
00034 
00042   class Pipe : public FileDescriptor
00043   {
00044     protected:
00045 
00046       Pipe( );
00047 
00048     public:
00049 
00050       typedef ConexusPointer<Pipe> pointer;
00051 
00052       CONEXUS_ENDPOINT_GENERIC_CREATE();
00053 
00054       static Pipe::pointer create( );
00055 
00056       virtual ~Pipe();
00057 
00058       virtual void open() throw ( open_exception );
00059 
00060       virtual void close( bool force = false ) throw ( close_exception );
00061 
00062       virtual void close_read( bool force = false ) throw ( close_exception );
00063 
00064       virtual void close_write( bool force = false ) throw ( close_exception );
00065 
00066       virtual size_t input_available() throw();
00067 
00068     protected:
00069       int m_write_fd;
00070 
00071       virtual size_t write_data( const Data data, Timeout timeout ) throw ( write_exception );
00072 
00079       virtual Data read_data( size_t size, Timeout timeout ) throw ( read_exception );
00080   };
00081 
00082 }
00083 
00084 #endif

Generated on Wed Jul 8 15:50:08 2009 for conexus by doxygen 1.5.8