Jump to main content

##

# 1.2.1.23.3 Library Interface

Name | Description
--- | ---
Macros |
TCPIP_TFTPS_CLIENT_NUMBER | The number of Clients requests will be processed for the TFTP server stack.
TCPIP_TFTPS_DEFAULT_BLOCK_SIZE | The 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_FILESIZE | The maximum size for a file in bytes to be accepted.TFTP Opcode defined by RFC 2347.
TCPIP_TFTPS_DEFAULT_TIMEOUT | This time is used during the TFTP retransmission and TFTP Client wait for these many seconds before retransmitting .
TCPIP_TFTPS_RETRANSMIT_COUNT | The number of attempts to retransmit the previous packet before declaring a TIMEOUT error.
TCPIP_TFTPS_TASK_TICK_RATE | The 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_LEN | The default length of the file name is defined to 64 bytes.
TCPIP_TFTPS_USER_NOTIFICATION | allow TFTP Server user notification if enabled, the TCPIP_TFTPS_HandlerRegister/TCPIP_TFTPS_HandlerDeRegister functions exist and can be used
Functions |
TCPIP_TFTPS_ClientsNumber | Determines the number of clients running for this server.
TCPIP_TFTPS_Disable | Disables the TFTP server for the specified interface.
TCPIP_TFTPS_Enable | Enables the TFTP server for the specified interface.
TCPIP_TFTPS_HandlerDeRegister | De-registers a previously registered TFTP Server handler.
TCPIP_TFTPS_HandlerRegister | Registers a TFTP Server Handler.
TCPIP_TFTPS_IsEnabled | Determines if a TFTP server is active or not.
TCPIP_TFTPS_Task | Standard TCP/IP stack module task function.
Data Types and Constants |
TCPIP_TFTPS_EVENT_TYPE | List of events for the TFTPS module.
TCPIP_TFTPS_RESULT | Provides a list of possible results for the TFTPS module.
TCPIP_TFTPS_MODULE_CONFIG | Placeholder for TFTPS Module Configuration
TCPIP_TFTPS_EVENT_HANDLER | Notification handler that can be called when there is a TFTP process for a client.
TCPIP_TFTPS_HANDLE | TFTP server handle.