Small documentation fix for TFTP

Apparently the TFTP server now also invokes the error() function in the
tftp_context struct.

Some tftp clients (for example Windows 10 TFTP client) will open the
remote file before checking the local file can be opened - and will then
send an error indication to the server to indicate there was an error
opening the local file. When the happens, the LWIP tftp server will
invoke the error() member of the tftp_context.
This commit is contained in:
Ivan Warren 2018-12-22 12:31:00 +01:00 committed by Simon Goldschmidt
parent 8f2f43f093
commit 9263d44847

View File

@ -85,10 +85,10 @@ struct tftp_context {
*/
int (*write)(void* handle, struct pbuf* p);
/**
* Error response (client mode only)
* @param handle File handle set by tftp_get()/tftp_put()
* @param err error code from server
* @param msg error message from server
* Error indication from client or response from server
* @param handle File handle set by open()/tftp_get()/tftp_put()
* @param err error code from client or server
* @param msg error message from client or server
* @param size size of msg
*/
void (*error)(void* handle, int err, const char* msg, int size);