arrow/io/type_fwd.h

0001 // Licensed to the Apache Software Foundation (ASF) under one
0002 // or more contributor license agreements.  See the NOTICE file
0003 // distributed with this work for additional information
0004 // regarding copyright ownership.  The ASF licenses this file
0005 // to you under the Apache License, Version 2.0 (the
0006 // "License"); you may not use this file except in compliance
0007 // with the License.  You may obtain a copy of the License at
0008 //
0009 //   http://www.apache.org/licenses/LICENSE-2.0
0010 //
0011 // Unless required by applicable law or agreed to in writing,
0012 // software distributed under the License is distributed on an
0013 // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
0014 // KIND, either express or implied.  See the License for the
0015 // specific language governing permissions and limitations
0016 // under the License.
0017
0018 #pragma once
0019
0020 #include "arrow/type_fwd.h"
0021 #include "arrow/util/visibility.h"
0022
0023 namespace arrow {
0024 namespace io {
0025
0026 struct FileMode {
0027   enum type { READ, WRITE, READWRITE };
0028 };
0029
0030 struct IOContext;
0031 struct CacheOptions;
0032
0033 /// EXPERIMENTAL: convenience global singleton for default IOContext settings
0034 ARROW_EXPORT
0035 const IOContext& default_io_context();
0036
0037 /// \brief Get the capacity of the global I/O thread pool
0038 ///
0039 /// Return the number of worker threads in the thread pool to which
0040 /// Arrow dispatches various I/O-bound tasks.  This is an ideal number,
0041 /// not necessarily the exact number of threads at a given point in time.
0042 ///
0043 /// You can change this number using SetIOThreadPoolCapacity().
0044 ARROW_EXPORT int GetIOThreadPoolCapacity();
0045
0046 /// \brief Set the capacity of the global I/O thread pool
0047 ///
0048 /// Set the number of worker threads in the thread pool to which
0049 /// Arrow dispatches various I/O-bound tasks.
0050 ///
0051 /// The current number is returned by GetIOThreadPoolCapacity().
0052 ARROW_EXPORT Status SetIOThreadPoolCapacity(int threads);
0053
0054 class FileInterface;
0055 class Seekable;
0056 class Writable;
0057 class Readable;
0058 class OutputStream;
0059 class FileOutputStream;
0060 class InputStream;
0061 class ReadableFile;
0062 class RandomAccessFile;
0063 class MemoryMappedFile;
0064 class WritableFile;
0065 class ReadWriteFileInterface;
0066
0067 class LatencyGenerator;
0068
0069 class BufferOutputStream;
0070 class BufferReader;
0071 class CompressedInputStream;
0072 class CompressedOutputStream;
0073 class BufferedInputStream;
0074 class BufferedOutputStream;
0075
0076 }  // namespace io
0077 }  // namespace arrow