sftp_client_misc.h

Go to the documentation of this file.

/**
 * @file sftp_client_misc.h
 * @brief Helper functions for SFTP client
 *
 * @section License
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 *
 * Copyright (C) 2019-2024 Oryx Embedded SARL. All rights reserved.
 *
 * This file is part of CycloneSSH Open.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 * @author Oryx Embedded SARL (www.oryx-embedded.com)
 * @version 2.4.0
 **/
 
#ifndef _SFTP_CLIENT_MISC_H
#define _SFTP_CLIENT_MISC_H
 
//Dependencies
#include "sftp/sftp_client.h"
 
//C++ guard
#ifdef __cplusplus
extern "C" {
#endif
 
//SFTP client related functions
void sftpClientChangeState(SftpClientContext *context,
   SftpClientState newState);
 
error_t sftpClientOpenConnection(SftpClientContext *context);
error_t sftpClientEstablishConnection(SftpClientContext *context);
void sftpClientCloseConnection(SftpClientContext *context);
 
error_t sftpClientSendCommand(SftpClientContext *context);
error_t sftpClientProcessEvents(SftpClientContext *context);
 
error_t sftpClientParsePacketLength(SftpClientContext *context,
   const uint8_t *packet);
 
error_t sftpClientParsePacket(SftpClientContext *context, const uint8_t *packet,
   size_t fragLen, size_t totalLen);
 
error_t sftpClientCheckTimeout(SftpClientContext *context);
 
error_t sftpFormatPath(SftpClientContext *context, const char_t *path,
   uint8_t *p, size_t *written);
 
void sftpGetAbsolutePath(SftpClientContext *context, const char_t *path,
   char_t *fullPath);
 
//C++ guard
#ifdef __cplusplus
}
#endif
 
#endif