BufferedIO.h

Go to the documentation of this file.
00001 /*
00002  * IMPORTANT: READ BEFORE DOWNLOADING, COPYING, INSTALLING OR USING. By
00003  * downloading, copying, installing or using the software you agree to
00004  * this license. If you do not agree to this license, do not download,
00005  * install, copy or use the software.
00006  * 
00007  * Intel Open Source License 
00008  * 
00009  * Copyright (c) 2004 Intel Corporation. All rights reserved. 
00010  * 
00011  * Redistribution and use in source and binary forms, with or without
00012  * modification, are permitted provided that the following conditions are
00013  * met:
00014  * 
00015  *   Redistributions of source code must retain the above copyright
00016  *   notice, this list of conditions and the following disclaimer.
00017  * 
00018  *   Redistributions in binary form must reproduce the above copyright
00019  *   notice, this list of conditions and the following disclaimer in the
00020  *   documentation and/or other materials provided with the distribution.
00021  * 
00022  *   Neither the name of the Intel Corporation nor the names of its
00023  *   contributors may be used to endorse or promote products derived from
00024  *   this software without specific prior written permission.
00025  *  
00026  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00027  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00028  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
00029  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE INTEL OR
00030  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00031  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00032  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
00033  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
00034  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00035  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00036  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037  */
00038 #ifndef _OASYS_BUFFERED_IO_H_
00039 #define _OASYS_BUFFERED_IO_H_
00040 
00041 #include "../debug/Logger.h"
00042 #include "../io/IOClient.h"
00043 #include "../util/StreamBuffer.h"
00044 
00045 namespace oasys {
00046 
00051 class BufferedInput : public Logger {
00052 public:
00053     BufferedInput(IOClient* client, const char* logbase = "/BufferedInput");
00054     ~BufferedInput();
00055     
00067     int read_line(const char* nl, char** buf, int timeout = -1);
00068 
00082     int read_bytes(size_t len, char** buf, int timeout = -1);
00083 
00084 
00093     int read_some_bytes(char** buf, int timeout = -1);
00094 
00099     char get_char(int timeout = -1);
00100 
00104     bool eof();
00105 
00106 private:    
00115     int internal_read(size_t len = 0, int timeout_ms = -1);
00116 
00121     int find_nl(const char* nl);
00122     
00123     IOClient*    client_;
00124     StreamBuffer buf_;
00125 
00126     bool seen_eof_;
00127 
00128     static const size_t READ_AHEAD = 256;  
00129     static const size_t MAX_LINE   = 4096; 
00130 };
00131 
00132 class BufferedOutput : public Logger {
00133 public:
00134     BufferedOutput(IOClient* client, const char* logbase = "/BufferedOutput");
00135 
00142     int write(const char* bp, size_t len = 0);
00143 
00147     void clear_buf();
00148 
00153     int format_buf(const char* format, ...) PRINTFLIKE(2, 3);
00154     int vformat_buf(const char* format, va_list args);
00155         
00160     int flush();
00161     
00167     void set_flush_limit(size_t limit);
00168     
00172     int printf(const char* format, ...) PRINTFLIKE(2, 3);
00173 
00174 private:
00175     IOClient*    client_;
00176     StreamBuffer buf_;
00177 
00178     size_t flush_limit_;
00179 
00180     static const size_t DEFAULT_FLUSH_LIMIT = 256;
00181 };
00182 
00183 } // namespace oasys
00184 
00185 #endif /* _OASYS_BUFFERED_IO_H_ */

Generated on Fri Dec 22 14:47:57 2006 for DTN Reference Implementation by  doxygen 1.5.1