update
FileLike.h@0:bfff72fb3650, 2021-04-08 (annotated)
- Committer:
- kwengryn3
- Date:
- Thu Apr 08 16:43:07 2021 +0000
- Revision:
- 0:bfff72fb3650
update;
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
kwengryn3 | 0:bfff72fb3650 | 1 | /* mbed Microcontroller Library |
kwengryn3 | 0:bfff72fb3650 | 2 | * Copyright (c) 2006-2013 ARM Limited |
kwengryn3 | 0:bfff72fb3650 | 3 | * SPDX-License-Identifier: Apache-2.0 |
kwengryn3 | 0:bfff72fb3650 | 4 | * |
kwengryn3 | 0:bfff72fb3650 | 5 | * Licensed under the Apache License, Version 2.0 (the "License"); |
kwengryn3 | 0:bfff72fb3650 | 6 | * you may not use this file except in compliance with the License. |
kwengryn3 | 0:bfff72fb3650 | 7 | * You may obtain a copy of the License at |
kwengryn3 | 0:bfff72fb3650 | 8 | * |
kwengryn3 | 0:bfff72fb3650 | 9 | * http://www.apache.org/licenses/LICENSE-2.0 |
kwengryn3 | 0:bfff72fb3650 | 10 | * |
kwengryn3 | 0:bfff72fb3650 | 11 | * Unless required by applicable law or agreed to in writing, software |
kwengryn3 | 0:bfff72fb3650 | 12 | * distributed under the License is distributed on an "AS IS" BASIS, |
kwengryn3 | 0:bfff72fb3650 | 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
kwengryn3 | 0:bfff72fb3650 | 14 | * See the License for the specific language governing permissions and |
kwengryn3 | 0:bfff72fb3650 | 15 | * limitations under the License. |
kwengryn3 | 0:bfff72fb3650 | 16 | */ |
kwengryn3 | 0:bfff72fb3650 | 17 | #ifndef MBED_FILELIKE_H |
kwengryn3 | 0:bfff72fb3650 | 18 | #define MBED_FILELIKE_H |
kwengryn3 | 0:bfff72fb3650 | 19 | |
kwengryn3 | 0:bfff72fb3650 | 20 | #include "platform/mbed_toolchain.h" |
kwengryn3 | 0:bfff72fb3650 | 21 | #include "platform/FileBase.h" |
kwengryn3 | 0:bfff72fb3650 | 22 | #include "platform/FileHandle.h" |
kwengryn3 | 0:bfff72fb3650 | 23 | #include "platform/NonCopyable.h" |
kwengryn3 | 0:bfff72fb3650 | 24 | |
kwengryn3 | 0:bfff72fb3650 | 25 | namespace mbed { |
kwengryn3 | 0:bfff72fb3650 | 26 | /** \addtogroup platform */ |
kwengryn3 | 0:bfff72fb3650 | 27 | /** @{*/ |
kwengryn3 | 0:bfff72fb3650 | 28 | /** |
kwengryn3 | 0:bfff72fb3650 | 29 | * \defgroup platform_FileLike FileLike class |
kwengryn3 | 0:bfff72fb3650 | 30 | * @{ |
kwengryn3 | 0:bfff72fb3650 | 31 | */ |
kwengryn3 | 0:bfff72fb3650 | 32 | /** Class FileLike |
kwengryn3 | 0:bfff72fb3650 | 33 | * |
kwengryn3 | 0:bfff72fb3650 | 34 | * A file-like object is one that can be opened with fopen by |
kwengryn3 | 0:bfff72fb3650 | 35 | * fopen("/name", mode). |
kwengryn3 | 0:bfff72fb3650 | 36 | * |
kwengryn3 | 0:bfff72fb3650 | 37 | * @note Synchronization level: Set by subclass |
kwengryn3 | 0:bfff72fb3650 | 38 | */ |
kwengryn3 | 0:bfff72fb3650 | 39 | class FileLike : public FileHandle, public FileBase, private NonCopyable<FileLike> { |
kwengryn3 | 0:bfff72fb3650 | 40 | public: |
kwengryn3 | 0:bfff72fb3650 | 41 | /** Constructor FileLike |
kwengryn3 | 0:bfff72fb3650 | 42 | * |
kwengryn3 | 0:bfff72fb3650 | 43 | * @param name The name to use to open the file. |
kwengryn3 | 0:bfff72fb3650 | 44 | */ |
kwengryn3 | 0:bfff72fb3650 | 45 | FileLike(const char *name = NULL) : FileBase(name, FilePathType) {} |
kwengryn3 | 0:bfff72fb3650 | 46 | virtual ~FileLike() {} |
kwengryn3 | 0:bfff72fb3650 | 47 | }; |
kwengryn3 | 0:bfff72fb3650 | 48 | |
kwengryn3 | 0:bfff72fb3650 | 49 | /**@}*/ |
kwengryn3 | 0:bfff72fb3650 | 50 | |
kwengryn3 | 0:bfff72fb3650 | 51 | /**@}*/ |
kwengryn3 | 0:bfff72fb3650 | 52 | |
kwengryn3 | 0:bfff72fb3650 | 53 | } // namespace mbed |
kwengryn3 | 0:bfff72fb3650 | 54 | |
kwengryn3 | 0:bfff72fb3650 | 55 | #endif |