LwFTP/LWFTP/lwftp.h

86 lines
2.1 KiB
C

/*
* lwftp_mod.h
*
* Created on: Feb 14, 2024
* Author: SeungJu Lim
*/
#ifndef LWFTP_H
#define LWFTP_H
#include "lwip/opt.h"
#include "lwip/ip.h"
#ifdef __cplusplus
extern "C" {
#endif
enum lwftp_results {
LWFTP_RESULT_OK=0,
LWFTP_RESULT_INPROGRESS,
LWFTP_RESULT_LOGGED,
LWFTP_RESULT_ERR_UNKNOWN, /** Unknown error */
LWFTP_RESULT_ERR_ARGUMENT, /** Wrong argument */
LWFTP_RESULT_ERR_MEMORY, /** Out of memory */
LWFTP_RESULT_ERR_CONNECT, /** Connection to server failed */
LWFTP_RESULT_ERR_HOSTNAME, /** Failed to resolve server hostname */
LWFTP_RESULT_ERR_CLOSED, /** Connection unexpectedly closed by remote server */
LWFTP_RESULT_ERR_TIMEOUT, /** Connection timed out (server didn't respond in time) */
LWFTP_RESULT_ERR_SRVR_RESP, /** Server responded with an unknown response code */
LWFTP_RESULT_ERR_INTERNAL, /** Internal network stack error */
LWFTP_RESULT_ERR_LOCAL, /** Local storage error */
LWFTP_RESULT_ERR_FILENAME /** Remote host could not find file */
};
/** LWFTP control connection state */
typedef enum {
LWFTP_CLOSED=0,
LWFTP_CONNECTED,
LWFTP_USER_SENT,
LWFTP_PASS_SENT,
LWFTP_LOGGED,
LWFTP_TYPE_SENT,
LWFTP_PASV_SENT,
LWFTP_RETR_SENT,
LWFTP_STOR_SENT,
LWFTP_XFERING,
LWFTP_DATAEND,
LWFTP_QUIT,
LWFTP_QUIT_SENT,
LWFTP_CLOSING,
} lwftp_state_t;
/** LWFTP session structure */
typedef struct {
// User interface
ip_addr_t server_ip;
u16_t server_port;
const char *remote_path;
const char *user;
const char *pass;
void *handle;
uint (*data_source)(void*, const char**, uint);
uint (*data_sink)(void*, const char*, uint);
void (*done_fn)(void*, int);
uint timeout;
// Internal data
lwftp_state_t control_state;
lwftp_state_t target_state;
lwftp_state_t data_state;
struct tcp_pcb *control_pcb;
struct tcp_pcb *data_pcb;
} lwftp_session_t;
// LWFTP API
err_t lwftp_connect(lwftp_session_t *s);
err_t lwftp_store(lwftp_session_t *s);
err_t lwftp_retrieve(lwftp_session_t *s);
void lwftp_close(lwftp_session_t *s);
#ifdef __cplusplus
}
#endif
#endif // LWFTP_H