[89] | 1 | /*
|
---|
| 2 | * Licensed to the Apache Software Foundation (ASF) under one or more
|
---|
| 3 | * contributor license agreements. See the NOTICE file distributed with
|
---|
| 4 | * this work for additional information regarding copyright ownership.
|
---|
| 5 | * The ASF licenses this file to You under the Apache License, Version 2.0
|
---|
| 6 | * (the "License"); you may not use this file except in compliance with
|
---|
| 7 | * the License. You may obtain a copy of the License at
|
---|
| 8 | *
|
---|
| 9 | * http://www.apache.org/licenses/LICENSE-2.0
|
---|
| 10 | *
|
---|
| 11 | * Unless required by applicable law or agreed to in writing, software
|
---|
| 12 | * distributed under the License is distributed on an "AS IS" BASIS,
|
---|
| 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
---|
| 14 | * See the License for the specific language governing permissions and
|
---|
| 15 | * limitations under the License.
|
---|
| 16 | */
|
---|
| 17 |
|
---|
| 18 | #ifndef _LOG4CXX_HELPERS_INPUTSTREAM_H
|
---|
| 19 | #define _LOG4CXX_HELPERS_INPUTSTREAM_H
|
---|
| 20 |
|
---|
| 21 | #include <log4cxx/helpers/objectimpl.h>
|
---|
| 22 |
|
---|
| 23 | namespace log4cxx
|
---|
| 24 | {
|
---|
| 25 |
|
---|
| 26 | namespace helpers {
|
---|
| 27 | class ByteBuffer;
|
---|
| 28 |
|
---|
| 29 | /**
|
---|
| 30 | * Abstract class for reading from character streams.
|
---|
| 31 | *
|
---|
| 32 | */
|
---|
| 33 | class LOG4CXX_EXPORT InputStream : public ObjectImpl
|
---|
| 34 | {
|
---|
| 35 | public:
|
---|
| 36 | DECLARE_ABSTRACT_LOG4CXX_OBJECT(InputStream)
|
---|
| 37 | BEGIN_LOG4CXX_CAST_MAP()
|
---|
| 38 | LOG4CXX_CAST_ENTRY(InputStream)
|
---|
| 39 | END_LOG4CXX_CAST_MAP()
|
---|
| 40 |
|
---|
| 41 | protected:
|
---|
| 42 | InputStream();
|
---|
| 43 |
|
---|
| 44 | virtual ~InputStream();
|
---|
| 45 |
|
---|
| 46 | public:
|
---|
| 47 | /**
|
---|
| 48 | * Reads a sequence of bytes into the given buffer.
|
---|
| 49 | *
|
---|
| 50 | * @param dst The buffer into which bytes are to be transferred.
|
---|
| 51 | * @return the total number of bytes read into the buffer, or -1 if there
|
---|
| 52 | * is no more data because the end of the stream has been reached.
|
---|
| 53 | */
|
---|
| 54 | virtual int read(ByteBuffer& dst) = 0;
|
---|
| 55 |
|
---|
| 56 | /**
|
---|
| 57 | * Closes this input stream and releases any system
|
---|
| 58 | * resources associated with the stream.
|
---|
| 59 | */
|
---|
| 60 | virtual void close() = 0;
|
---|
| 61 |
|
---|
| 62 | private:
|
---|
| 63 | InputStream(const InputStream&);
|
---|
| 64 | InputStream& operator=(const InputStream&);
|
---|
| 65 | };
|
---|
| 66 |
|
---|
| 67 | LOG4CXX_PTR_DEF(InputStream);
|
---|
| 68 | } // namespace helpers
|
---|
| 69 |
|
---|
| 70 | } //namespace log4cxx
|
---|
| 71 |
|
---|
| 72 | #endif //_LOG4CXX_HELPERS_INPUTSTREAM_H
|
---|