1.2.1.23.3 Library Interface

NameDescription
Macros
TCPIP_TFTPS_CLIENT_NUMBERThe number of Clients requests will be processed for the TFTP server stack.
TCPIP_TFTPS_DEFAULT_BLOCK_SIZEThe maximum value for the file name size. Even though the RFC allows blocks of up to 65464 bytes, In practice the limit is set to 1468 bytes: the size of an Ethernet MTU minus the headers of TFTP (4 bytes), UDP (8 bytes) and IP (20 bytes)
TCPIP_TFTPS_DEFAULT_FILESIZEThe maximum size for a file in bytes to be accepted.TFTP Opcode defined by RFC 2347.
TCPIP_TFTPS_DEFAULT_TIMEOUTThis time is used during the TFTP retransmission and TFTP Client wait for these many seconds before retransmitting .
TCPIP_TFTPS_RETRANSMIT_COUNTThe number of attempts to retransmit the previous packet before declaring a TIMEOUT error.
TCPIP_TFTPS_TASK_TICK_RATEThe TFTP server task rate in milliseconds. The default value is 100 milliseconds. The lower the rate (higher the frequency) the higher the module priority and higher module performance can be obtained The value cannot be lower than the TCPIP_STACK_TICK_RATE.
TCPIP_TFTPS_FILENAME_LENThe default length of the file name is defined to 64 bytes.
TCPIP_TFTPS_USER_NOTIFICATIONallow TFTP Server user notification if enabled, the TCPIP_TFTPS_HandlerRegister/TCPIP_TFTPS_HandlerDeRegister functions exist and can be used
Functions
TCPIP_TFTPS_ClientsNumberDetermines the number of clients running for this server.
TCPIP_TFTPS_DisableDisables the TFTP server for the specified interface.
TCPIP_TFTPS_EnableEnables the TFTP server for the specified interface.
TCPIP_TFTPS_HandlerDeRegisterDe-registers a previously registered TFTP Server handler.
TCPIP_TFTPS_HandlerRegisterRegisters a TFTP Server Handler.
TCPIP_TFTPS_IsEnabledDetermines if a TFTP server is active or not.
TCPIP_TFTPS_TaskStandard TCP/IP stack module task function.
Data Types and Constants
TCPIP_TFTPS_EVENT_TYPEList of events for the TFTPS module.
TCPIP_TFTPS_RESULTProvides a list of possible results for the TFTPS module.
TCPIP_TFTPS_MODULE_CONFIGPlaceholder for TFTPS Module Configuration
TCPIP_TFTPS_EVENT_HANDLERNotification handler that can be called when there is a TFTP process for a client.
TCPIP_TFTPS_HANDLETFTP server handle.