/src/logging-log4cxx/src/main/include/log4cxx/helpers/fileinputstream.h
Line | Count | Source |
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_FILEINPUTSTREAM_H |
19 | | #define _LOG4CXX_HELPERS_FILEINPUTSTREAM_H |
20 | | |
21 | | #include <log4cxx/helpers/inputstream.h> |
22 | | #include <log4cxx/file.h> |
23 | | #include <memory> |
24 | | |
25 | | namespace LOG4CXX_NS |
26 | | { |
27 | | |
28 | | namespace helpers |
29 | | { |
30 | | |
31 | | /** |
32 | | * InputStream implemented on top of APR file IO. |
33 | | * |
34 | | */ |
35 | | class LOG4CXX_EXPORT FileInputStream : public InputStream |
36 | | { |
37 | | private: |
38 | | LOG4CXX_DECLARE_PRIVATE_MEMBER_PTR(FileInputStreamPrivate, m_priv) |
39 | | |
40 | | public: |
41 | | DECLARE_ABSTRACT_LOG4CXX_OBJECT(FileInputStream) |
42 | 0 | BEGIN_LOG4CXX_CAST_MAP() |
43 | 0 | LOG4CXX_CAST_ENTRY(FileInputStream) |
44 | 0 | LOG4CXX_CAST_ENTRY_CHAIN(InputStream) |
45 | 0 | END_LOG4CXX_CAST_MAP() |
46 | | |
47 | | /** |
48 | | * Creates a FileInputStream by opening a connection to an actual |
49 | | * file, the file named by the path name name in the file system. |
50 | | * |
51 | | * @param filename The system-dependent file name. |
52 | | */ |
53 | | FileInputStream(const LogString& filename); |
54 | | FileInputStream(const logchar* filename); |
55 | | |
56 | | /** |
57 | | * Creates a FileInputStream by opening a connection to an actual |
58 | | * file, the file named by the File object file in the file system. |
59 | | * |
60 | | * @param aFile The file to be opened for reading. |
61 | | */ |
62 | | FileInputStream(const File& aFile); |
63 | | |
64 | | virtual ~FileInputStream(); |
65 | | |
66 | | /** |
67 | | * Closes this file input stream and releases any system |
68 | | * resources associated with the stream. |
69 | | */ |
70 | | void close() override; |
71 | | |
72 | | /** |
73 | | * Reads a sequence of bytes into the given buffer. |
74 | | * |
75 | | * @param buf The buffer into which bytes are to be transferred. |
76 | | * @return the total number of bytes read into the buffer, or -1 if there |
77 | | * is no more data because the end of the stream has been reached. |
78 | | */ |
79 | | int read(ByteBuffer& buf) override; |
80 | | |
81 | | private: |
82 | | |
83 | | FileInputStream(const FileInputStream&) = delete; |
84 | | FileInputStream(FileInputStream&&) = delete; |
85 | | |
86 | | FileInputStream& operator=(const FileInputStream&) = delete; |
87 | | void open(const LogString&); |
88 | | |
89 | | }; |
90 | | |
91 | | LOG4CXX_PTR_DEF(FileInputStream); |
92 | | } // namespace helpers |
93 | | |
94 | | } //namespace log4cxx |
95 | | |
96 | | #endif //_LOG4CXX_HELPERS_FILEINPUTSTREAM_H |