tftp_client_misc.h
Go to the documentation of this file.
1 /**
2  * @file tftp_client_misc.h
3  * @brief Helper functions for TFTP client
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2019 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneTCP 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 1.9.6
29  **/
30 
31 #ifndef _TFTP_CLIENT_MISC_H
32 #define _TFTP_CLIENT_MISC_H
33 
34 //Dependencies
35 #include "core/net.h"
36 #include "tftp/tftp_client.h"
37 
38 //C++ guard
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
43 //TFTP client related functions
46 
48 
50  const IpAddr *srcIpAddr, uint16_t srcPort);
51 
53  uint16_t srcPort, const TftpDataPacket *dataPacket, size_t length);
54 
56  uint16_t srcPort, const TftpAckPacket *ackPacket, size_t length);
57 
59  uint16_t srcPort, const TftpErrorPacket *errorPacket, size_t length);
60 
62  const char_t *filename, const char_t *mode);
63 
65  const char_t *filename, const char_t *mode);
66 
69 
71  uint16_t errorCode, const char_t *errorMsg);
72 
74 
75 //C++ guard
76 #ifdef __cplusplus
77 }
78 #endif
79 
80 #endif
char_t errorMsg[]
Definition: tftp_common.h:137
uint8_t length
Definition: dtls_misc.h:149
__start_packed struct @298 TftpAckPacket
Acknowledgment packet (ACK)
IP network address.
Definition: ip.h:71
void tftpClientCloseConnection(TftpClientContext *context)
Close connection with the TFTP server.
error_t tftpClientProcessEvents(TftpClientContext *context)
Process TFTP client events.
void tftpClientProcessPacket(TftpClientContext *context, const IpAddr *srcIpAddr, uint16_t srcPort)
Process incoming packet.
Ipv4Addr srcIpAddr
Definition: ipcp.h:77
uint16_t errorCode
Definition: tftp_common.h:136
__start_packed struct @299 TftpErrorPacket
Error packet (ERROR)
TFTP client context.
Definition: tftp_client.h:123
void tftpClientProcessDataPacket(TftpClientContext *context, uint16_t srcPort, const TftpDataPacket *dataPacket, size_t length)
Process incoming DATA packet.
void tftpClientProcessErrorPacket(TftpClientContext *context, uint16_t srcPort, const TftpErrorPacket *errorPacket, size_t length)
Process incoming ERROR packet.
error_t tftpClientOpenConnection(TftpClientContext *context)
Open connection with the TFTP server.
char_t filename[]
Definition: tftp_common.h:91
error_t
Error codes.
Definition: error.h:42
error_t tftpClientRetransmitPacket(TftpClientContext *context)
Retransmit the last packet.
TFTP client.
char char_t
Definition: compiler_port.h:43
error_t tftpClientSendErrorPacket(TftpClientContext *context, uint16_t errorCode, const char_t *errorMsg)
Send ERROR packet.
error_t tftpClientSendWrqPacket(TftpClientContext *context, const char_t *filename, const char_t *mode)
Send WRQ packet.
void tftpClientProcessAckPacket(TftpClientContext *context, uint16_t srcPort, const TftpAckPacket *ackPacket, size_t length)
Process incoming ACK packet.
uint8_t mode
Definition: ntp_common.h:149
uint16_t srcPort
Definition: tcp.h:302
error_t tftpClientSendDataPacket(TftpClientContext *context)
Send DATA packet.
TCP/IP stack core.
__start_packed struct @297 TftpDataPacket
Data packet (DATA)
error_t tftpClientSendRrqPacket(TftpClientContext *context, const char_t *filename, const char_t *mode)
Send RRQ packet.
error_t tftpClientSendAckPacket(TftpClientContext *context)
Send ACK packet.