Embedded TCP/IP stack: fnet_tftp_srv.h Source File

FNET

Embedded TCP/IP stack 4.1.0
 /**************************************************************************
 *
 * Copyright 2011-2016 by Andrey Butok. FNET Community.
 * Copyright 2008-2010 by Andrey Butok. Freescale Semiconductor, Inc.
 *
 ***************************************************************************
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 ***************************************************************************
 *
 * TFTP Server API.
 *
 ***************************************************************************/
 
 #ifndef _FNET_TFTP_SRV_H_
 
 #define _FNET_TFTP_SRV_H_
 
 #if FNET_CFG_TFTP_SRV || defined(__DOXYGEN__)
 
 #include "fnet_tftp.h"
 
 /**************************************************************************/ 
 typedef fnet_return_t(*fnet_tftp_srv_request_handler_t)(fnet_tftp_request_t request_type,
  const struct fnet_sockaddr *address,
  fnet_char_t *filename, /* null-terminated.*/
  fnet_char_t *mode, /* null-terminated.*/
  fnet_tftp_error_t *error_code, /* error code [0-7] RFC783, if result==FNET_ERR*/
  fnet_char_t * *error_message, /* optinal, if result==FNET_ERR*/
  void *handler_param);
 
 /**************************************************************************/ 
 typedef fnet_int32_t(*fnet_tftp_srv_data_handler_t)(fnet_tftp_request_t request,
  fnet_uint8_t *data,
  fnet_size_t data_size,
  fnet_tftp_error_t *error_code,
  fnet_char_t * *error_message,
  void *handler_param);
 
 /**************************************************************************/ 
 typedef void(*fnet_tftp_srv_complete_handler_t)(fnet_tftp_request_t request,
  fnet_return_t status,
  void *handler_param);
 
 /**************************************************************************/ 
 struct fnet_tftp_srv_params
 {
  struct fnet_sockaddr address; 
  fnet_tftp_srv_request_handler_t request_handler; 
  fnet_tftp_srv_data_handler_t data_handler; 
  fnet_tftp_srv_complete_handler_t complete_handler; 
  void *handler_param; 
  fnet_time_t timeout; 
  fnet_index_t retransmit_max; 
 };
 
 /**************************************************************************/ 
 typedef long fnet_tftp_srv_desc_t;
 
 /**************************************************************************/ 
 typedef enum
 {
  FNET_TFTP_SRV_STATE_DISABLED = 0, 
  FNET_TFTP_SRV_STATE_WAITING_REQUEST, 
  FNET_TFTP_SRV_STATE_HANDLE_REQUEST, 
  FNET_TFTP_SRV_STATE_CLOSE 
 } fnet_tftp_srv_state_t;
 
 #if defined(__cplusplus)
 extern "C" {
 #endif
 
 /***************************************************************************/ 
 fnet_tftp_srv_desc_t fnet_tftp_srv_init( struct fnet_tftp_srv_params *params );
 
 /***************************************************************************/ 
 void fnet_tftp_srv_release(fnet_tftp_srv_desc_t desc);
 
 /***************************************************************************/ 
 fnet_bool_t fnet_tftp_srv_is_enabled(fnet_tftp_srv_desc_t desc);
 
 #if defined(__cplusplus)
 }
 #endif
 
 #endif /* FNET_CFG_TFTP_SRV */
 
 #endif /* _FNET_TFTP_SRV_H_ */
previous page start next page