ns_file_system.h

00001 /*
00002  * Copyright (c) 2017, Arm Limited and affiliates.
00003  * SPDX-License-Identifier: Apache-2.0
00004  *
00005  * Licensed under the Apache License, Version 2.0 (the "License");
00006  * you may not use this file except in compliance with the License.
00007  * You may obtain a copy of the License at
00008  *
00009  *     http://www.apache.org/licenses/LICENSE-2.0
00010  *
00011  * Unless required by applicable law or agreed to in writing, software
00012  * distributed under the License is distributed on an "AS IS" BASIS,
00013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00014  * See the License for the specific language governing permissions and
00015  * limitations under the License.
00016  */
00017 
00018 #ifndef _NS_FILE_SYSTEM_H_
00019 #define _NS_FILE_SYSTEM_H_
00020 
00021 #ifdef __cplusplus
00022 extern "C" {
00023 #endif
00024 
00025 /**
00026  * \file ns_file_system.h
00027  * \brief Nanostack file system API.
00028  */
00029 
00030 /**
00031  * \brief Set file system root path.
00032  *
00033  *  Allow stack to store information to the location provided.
00034  *  Setting root path to NULL will prevent file system usage.
00035  *
00036  * \param root_path Path to location where networking files can be stored. Path must exists in the file system
00037  *   and path must end to "/" character. Path can be NULL to disable file system usage.
00038  *
00039  * \return 0 in success, negative value in case of error.
00040  *
00041  */
00042 
00043 int ns_file_system_set_root_path(const char *root_path);
00044 
00045 /**
00046  * \brief Get file system root path.
00047  *
00048  * \return Root path to stack storage location.
00049  *
00050  */
00051 char *ns_file_system_get_root_path(void);
00052 
00053 #ifdef __cplusplus
00054 }
00055 #endif
00056 
00057 #endif /* _NS_FILE_SYSTEM_H_ */