scp_server_file.h
Go to the documentation of this file.
1 /**
2  * @file scp_server_file.h
3  * @brief File operations
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2019-2024 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneSSH Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @author Oryx Embedded SARL (www.oryx-embedded.com)
28  * @version 2.4.4
29  **/
30 
31 #ifndef _SCP_SERVER_FILE_H
32 #define _SCP_SERVER_FILE_H
33 
34 //Dependencies
35 #include "scp/scp_server.h"
36 
37 //C++ guard
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
42 //SCP server related functions
44  const char_t *filename, uint32_t mode, uint64_t size);
45 
47 
50 
51 //C++ guard
52 #ifdef __cplusplus
53 }
54 #endif
55 
56 #endif
error_t scpServerOpenFileForReading(ScpServerSession *session)
Open a file for reading.
error_t scpServerWriteData(ScpServerSession *session)
Write data to the specified file.
#define ScpServerSession
Definition: scp_server.h:113
error_t scpServerOpenFileForWriting(ScpServerSession *session, const char_t *filename, uint32_t mode, uint64_t size)
Open a file for writing.
error_t
Error codes.
Definition: error.h:43
char_t filename[]
Definition: tftp_common.h:93
SCP server.
char char_t
Definition: compiler_port.h:48
error_t scpServerReadData(ScpServerSession *session)
Read data from the specified file.