Embedded TCP/IP stack: fnet_tftp_cln.h Source File

FNET

previous page next page
fnet_tftp_cln.h
1 /**************************************************************************
2 *
3 * Copyright 2011-2017 by Andrey Butok. FNET Community.
4 * Copyright 2008-2010 by Andrey Butok. Freescale Semiconductor, Inc.
5 *
6 ***************************************************************************
7 *
8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
9 * not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
19 *
20 ***************************************************************************
21 *
22 * TFTP Client API.
23 *
24 ***************************************************************************/
25 
26 #ifndef _FNET_TFTP_CLN_H_
27 
28 #define _FNET_TFTP_CLN_H_
29 
30 #if FNET_CFG_TFTP_CLN || defined(__DOXYGEN__)
31 
32 #include "fnet_tftp.h"
33 
55 /**************************************************************************/
114 typedef fnet_int32_t(*fnet_tftp_cln_handler_t)(fnet_tftp_request_t request_type, fnet_uint8_t *data, fnet_size_t data_size, fnet_return_t tftp_result, void *handler_param);
115 
116 
117 /**************************************************************************/
120 struct fnet_tftp_cln_params
121 {
122  fnet_tftp_request_t request_type;
124  struct fnet_sockaddr server_addr;
127  fnet_char_t *file_name;
130  fnet_tftp_cln_handler_t handler;
133  void *handler_param;
138  fnet_time_t timeout;
147 };
148 
149 /**************************************************************************/
153 typedef enum
154 {
155  FNET_TFTP_CLN_STATE_DISABLED = 0,
158  FNET_TFTP_CLN_STATE_SEND_REQUEST,
161  FNET_TFTP_CLN_STATE_HANDLE_REQUEST,
163  FNET_TFTP_CLN_STATE_RELEASE
167 } fnet_tftp_cln_state_t;
168 
169 #if defined(__cplusplus)
170 extern "C" {
171 #endif
172 
173 /***************************************************************************/
194 fnet_return_t fnet_tftp_cln_init( struct fnet_tftp_cln_params *params );
195 
196 /***************************************************************************/
211 void fnet_tftp_cln_release(void);
212 
213 /***************************************************************************/
227 fnet_tftp_cln_state_t fnet_tftp_cln_state( void );
228 
229 #if defined(__cplusplus)
230 }
231 #endif
232 
235 #endif /* FNET_CFG_TFTP_CLN */
236 
237 #endif /* _FNET_TFTP_CLN_H_ */
fnet_time_t
fnet_uint32_t fnet_time_t
Unsigned integer type representing time uinits. It can be ticks, seconds or milliseconds.
Definition: fnet_timer.h:66
fnet_tftp_cln_state_t
fnet_tftp_cln_state_t
TFTP-client states. Used mainly for debugging purposes.
Definition: fnet_tftp_cln.h:153
fnet_tftp_cln_params::handler_param
void * handler_param
Optional application-specific parameter. It is passed to the handler callback function as an input p...
Definition: fnet_tftp_cln.h:133
fnet_tftp_cln_params::server_addr
struct fnet_sockaddr server_addr
Socket address of the remote TFTP server to connect to.
Definition: fnet_tftp_cln.h:124
fnet_return_t
fnet_return_t
General return codes, used by most of API functions.
Definition: fnet_stdlib.h:90
FNET_TFTP_CLN_STATE_DISABLED
The TFTP-client service is not initialized or released.
Definition: fnet_tftp_cln.h:155
fnet_tftp_cln_release
void fnet_tftp_cln_release(void)
Aborts the transfer and releases the TFTP-client service.
fnet_size_t
unsigned long fnet_size_t
Unsigned integer type representing the size in bytes.
Definition: fnet_stdlib.h:56
fnet_tftp_cln_params
Input parameters for the fnet_tftp_cln_init() function.
Definition: fnet_tftp_cln.h:120
FNET_TFTP_CLN_STATE_HANDLE_REQUEST
Receives or sends DATA packets from/to the remote server.
Definition: fnet_tftp_cln.h:161
FNET_TFTP_CLN_STATE_SEND_REQUEST
The TFTP-client service is initialized. Sends Read/Write request (PRQ).
Definition: fnet_tftp_cln.h:158
fnet_tftp_cln_params::file_name
fnet_char_t * file_name
Name of the file to retrieve or create on the remote TFTP server.
Definition: fnet_tftp_cln.h:127
fnet_tftp_cln_params::request_type
fnet_tftp_request_t request_type
Request type (read or write) defined by fnet_tftp_request_t.
Definition: fnet_tftp_cln.h:122
FNET_TFTP_CLN_STATE_RELEASE
The DATA transfer is completed, or received error, or terminated by the application. Frees the allocated resources.
Definition: fnet_tftp_cln.h:163
fnet_tftp_cln_handler_t
fnet_int32_t(* fnet_tftp_cln_handler_t)(fnet_tftp_request_t request_type, fnet_uint8_t *data, fnet_size_t data_size, fnet_return_t tftp_result, void *handler_param)
TFTP-client event handler callback function prototype, that is called when the TFTP client has receiv...
Definition: fnet_tftp_cln.h:114
fnet_tftp_cln_init
fnet_return_t fnet_tftp_cln_init(struct fnet_tftp_cln_params *params)
Initializes the file transfer with the TFTP-client service.
fnet_tftp_cln_params::timeout
fnet_time_t timeout
Timeout for the TFTP server response in seconds. If no response from a TFTP server is received durin...
Definition: fnet_tftp_cln.h:138
fnet_tftp_cln_state
fnet_tftp_cln_state_t fnet_tftp_cln_state(void)
Retrieves the current state of the TFTP-client service.
fnet_char_t
char fnet_char_t
Type representing the charecter.
Definition: fnet_stdlib.h:76
fnet_tftp_request_t
fnet_tftp_request_t
The TFTP request type. It defines a TFTP service behavior, if it will read or write a file from/to a ...
Definition: fnet_tftp.h:52
fnet_tftp_cln_params::handler
fnet_tftp_cln_handler_t handler
Pointer to the callback function defined by fnet_tftp_cln_handler_t().
Definition: fnet_tftp_cln.h:130
fnet_sockaddr
Socket address structure.
Definition: fnet_socket.h:270
© 2005-2018 by Andrey Butok. http://fnet.sourceforge.net
previous page start next page