Events generated by the Network - TFTP Server functions. More...
Functions | |
__STATIC_INLINE void | EvrNetTFTPs_InitServer (uint32_t num_sessions, uint16_t port, uint8_t firewall_en) |
Event on TFTP server initialize (Op) | |
__STATIC_INLINE void | EvrNetTFTPs_ShowRootFolder (const char *root_folder, uint32_t length) |
Event on TFTP server display root folder (Op) | |
__STATIC_INLINE void | EvrNetTFTPs_GetSocketFailed (uint8_t session) |
Event on TFTP server failed to allocate UDP socket (Error) | |
__STATIC_INLINE void | EvrNetTFTPs_SetRootPath (const char *path, uint32_t length) |
Event on TFTP server netTFTPs_SetRootPath (API) | |
__STATIC_INLINE void | EvrNetTFTPs_StartService (uint16_t port) |
Event on TFTP server start service (Op) | |
__STATIC_INLINE void | EvrNetTFTPs_StopService (void) |
Event on TFTP server stop service (Op) | |
__STATIC_INLINE void | EvrNetTFTPs_TimeoutExpiredAbort (uint8_t session) |
Event on TFTP server session timeout expired, abort transfer (Error) | |
__STATIC_INLINE void | EvrNetTFTPs_SendBlock (uint8_t session, uint32_t block_nr, uint32_t length) |
Event on TFTP server send block (Op) | |
__STATIC_INLINE void | EvrNetTFTPs_ReceiveFrame (int32_t socket, uint32_t length) |
Event on TFTP server receive frame (Op) | |
__STATIC_INLINE void | EvrNetTFTPs_FrameTooShort (uint32_t length, uint32_t min_length) |
Event on TFTP server receive frame too short (Error) | |
__STATIC_INLINE void | EvrNetTFTPs_UserAccessDenied (const void *net_addr) |
Event on TFTP server user denied access (Error) | |
__STATIC_INLINE void | EvrNetTFTPs_AccessDeniedNoResources (void) |
Event on TFTP server denied client access on out of resources (Error) | |
__STATIC_INLINE void | EvrNetTFTPs_ShowClientAddress (const void *net_addr) |
Event on TFTP server display client IP address and port number (Op) | |
__STATIC_INLINE void | EvrNetTFTPs_OperationRequest (uint8_t session, uint16_t tftp_opcode) |
Event on TFTP server process operation request (Op) | |
__STATIC_INLINE void | EvrNetTFTPs_SessionRestart (uint8_t session) |
Event on TFTP server session restart, maybe our response was lost (Op) | |
__STATIC_INLINE void | EvrNetTFTPs_InvalidTransferId (uint8_t session) |
Event on TFTP server invalid transfer id (TID) detected (Error) | |
__STATIC_INLINE void | EvrNetTFTPs_ErrorCodeReceived (uint8_t session, uint16_t error_code) |
Event on TFTP server error code received from the client (Error) | |
__STATIC_INLINE void | EvrNetTFTPs_IllegalOpcodeReceived (uint8_t session, uint16_t tftp_opcode) |
Event on TFTP server illegal operation code received from the client (Error) | |
__STATIC_INLINE void | EvrNetTFTPs_FileRequested (const char *fname, uint32_t length) |
Event on TFTP server received file request from the client (Op) | |
__STATIC_INLINE void | EvrNetTFTPs_TransferBlockSize (uint8_t session, uint16_t block_size) |
Event on TFTP server display transfer block size (Op) | |
__STATIC_INLINE void | EvrNetTFTPs_TransferModeNotBinary (uint8_t session) |
Event on TFTP server transfer mode not set to binary (Error) | |
__STATIC_INLINE void | EvrNetTFTPs_LocalFileNotFound (uint8_t session) |
Event on TFTP server error, requested file not found on server (Error) | |
__STATIC_INLINE void | EvrNetTFTPs_LocalFileCreateFailed (uint8_t session) |
Event on TFTP server local file create failed (Error) | |
__STATIC_INLINE void | EvrNetTFTPs_ReceiveDataFrame (uint8_t session, uint32_t length) |
Event on TFTP server receive data frame (Op) | |
__STATIC_INLINE void | EvrNetTFTPs_DataFrameTooShort (uint8_t session, uint32_t length, uint32_t min_length) |
Event on TFTP server receive data frame too short (Error) | |
__STATIC_INLINE void | EvrNetTFTPs_DuplicateBlockReceived (uint8_t session, uint32_t block_nr) |
Event on TFTP server duplicate block received (Op) | |
__STATIC_INLINE void | EvrNetTFTPs_TooManyRetries (uint8_t session) |
Event on TFTP server too many retransmissions (Error) | |
__STATIC_INLINE void | EvrNetTFTPs_BlockReceived (uint8_t session, uint32_t block_nr) |
Event on TFTP server data block received (Op) | |
__STATIC_INLINE void | EvrNetTFTPs_InvalidBlockReceived (uint8_t session, uint32_t block_nr) |
Event on TFTP server invalid block received (Error) | |
__STATIC_INLINE void | EvrNetTFTPs_WriteErrorDiskFull (uint8_t session, uint32_t length) |
Event on TFTP server write local disk failed, disk full (Error) | |
__STATIC_INLINE void | EvrNetTFTPs_BlockAckReceived (uint8_t session, uint32_t block_nr) |
Event on TFTP server block acknowledge received (Op) | |
__STATIC_INLINE void | EvrNetTFTPs_BlockRetransmit (uint8_t session, uint32_t block_nr) |
Event on TFTP server block retransmit (Op) | |
__STATIC_INLINE void | EvrNetTFTPs_InvalidBlockAck (uint8_t session, uint32_t block_nr) |
Event on TFTP server invalid block acknowledge received (Error) | |
__STATIC_INLINE void | EvrNetTFTPs_ShowRequestMode (const uint8_t *mode, uint32_t length) |
Event on TFTP server display received request mode parameter (Op) | |
__STATIC_INLINE void | EvrNetTFTPs_SendOptionAck (uint8_t session, uint32_t block_size) |
Event on TFTP server send option acknowledgment (Op) | |
__STATIC_INLINE void | EvrNetTFTPs_SendBlockAck (uint8_t session, uint16_t block_nr) |
Event on TFTP server send block acknowledgment (Op) | |
__STATIC_INLINE void | EvrNetTFTPs_SendError (uint8_t session, uint16_t error_nr) |
Event on TFTP server send error code (Op) | |
__STATIC_INLINE void | EvrNetTFTPs_AbortSession (uint8_t session) |
Event on TFTP server abnormal session close on error (Op) | |
__STATIC_INLINE void | EvrNetTFTPs_CloseSession (uint8_t session) |
Event on TFTP server normal session close (Op) | |
__STATIC_INLINE void | EvrNetTFTPs_UninitServer (void) |
Event on TFTP server de-initialize (Op) | |
Events generated by the Network - TFTP Server functions.
The TFTP server functions generate events that make it easier to troubleshoot errors, and allow the user to understand how the TFTP server works.
__STATIC_INLINE void EvrNetTFTPs_AbortSession | ( | uint8_t | session | ) |
Event on TFTP server abnormal session close on error (Op)
session | session number |
The event AbortSession is created when the TFTP server terminates an active user session because an error occurred. The file operation is not complete.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_AccessDeniedNoResources | ( | void | ) |
Event on TFTP server denied client access on out of resources (Error)
The event AccessDeniedNoResources is created when the TFTP server rejects a pending connection request for the client, because the server can not assign a free session to manage the client connection. This means that the maximum number of concurrent user connections is currently active.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_BlockAckReceived | ( | uint8_t | session, |
uint32_t | block_nr | ||
) |
Event on TFTP server block acknowledge received (Op)
session | session number |
block_nr | block number |
The event BlockAckReceived is created when the TFTP server receives an acknowledgement of the sent data block. The server then sends the next data block.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_BlockReceived | ( | uint8_t | session, |
uint32_t | block_nr | ||
) |
Event on TFTP server data block received (Op)
session | session number |
block_nr | block number |
The event BlockReceived is created when the TFTP server receives the data block on the data socket.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_BlockRetransmit | ( | uint8_t | session, |
uint32_t | block_nr | ||
) |
Event on TFTP server block retransmit (Op)
session | session number |
block_nr | block number |
The event BlockRetransmit is created when the TFTP server receives an acknowledgement of a previously sent data block. This means that the last data block has been lost and is being resent.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_CloseSession | ( | uint8_t | session | ) |
Event on TFTP server normal session close (Op)
session | session number |
The event CloseSession is created when the TFTP server closes the active user session, because file operation is completed.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_DataFrameTooShort | ( | uint8_t | session, |
uint32_t | length, | ||
uint32_t | min_length | ||
) |
Event on TFTP server receive data frame too short (Error)
session | session number |
length | frame length in bytes |
min_length | minimum length of the frame |
The event DataFrameTooShort is created when the TFTP server receives the data frame that is too short. The frame is then discarded.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_DuplicateBlockReceived | ( | uint8_t | session, |
uint32_t | block_nr | ||
) |
Event on TFTP server duplicate block received (Op)
session | session number |
block_nr | block number |
The event DuplicateBlockReceived is created when the TFTP server wants to inform that the received data block is a duplicate, ie that it has been received again. The data block is then discarded.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_ErrorCodeReceived | ( | uint8_t | session, |
uint16_t | error_code | ||
) |
Event on TFTP server error code received from the client (Error)
session | session number |
error_code | TFTP error code
|
The event ErrorCodeReceived is created when the TFTP server receives an error code from the client. The server session then terminates.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_FileRequested | ( | const char * | fname, |
uint32_t | length | ||
) |
Event on TFTP server received file request from the client (Op)
fname | name of the requested file |
length | length of the fname string |
The event FileRequested is created when the TFTP server tries to open the requested file for reading or writing on the server.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_FrameTooShort | ( | uint32_t | length, |
uint32_t | min_length | ||
) |
Event on TFTP server receive frame too short (Error)
length | frame length in bytes |
min_length | minimum length of the frame |
The event FrameTooShort is created when the TFTP server receives the frame that is too short. The frame is then discarded.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_GetSocketFailed | ( | uint8_t | session | ) |
Event on TFTP server failed to allocate UDP socket (Error)
session | session number (0= control session) |
The event GetSocketFailed is created when the TFTP server is initialized, that is, when the function netInitialize is executed, and the service could not assign the UDP socket. To resolve this error, you must increase the number of available UDP sockets in the UDP socket configuration.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_IllegalOpcodeReceived | ( | uint8_t | session, |
uint16_t | tftp_opcode | ||
) |
Event on TFTP server illegal operation code received from the client (Error)
session | session number |
tftp_opcode | TFTP operation code
|
The event IllegalOpcodeReceived is created when the TFTP server receives an invalid operation code from the client. The server session then terminates.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_InitServer | ( | uint32_t | num_sessions, |
uint16_t | port, | ||
uint8_t | firewall_en | ||
) |
Event on TFTP server initialize (Op)
num_sessions | number of available TFTP sessions |
port | listening port number |
firewall_en | firewall support enable
|
The event InitServer is created when the TFTP server is initialized, that is, when the function netInitialize is executed.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_InvalidBlockAck | ( | uint8_t | session, |
uint32_t | block_nr | ||
) |
Event on TFTP server invalid block acknowledge received (Error)
session | session number |
block_nr | block number |
The event InvalidBlockAck is created when the TFTP server receives an acknowledgement of an invalid data block, that is, an out of order block. The server session then terminates.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_InvalidBlockReceived | ( | uint8_t | session, |
uint32_t | block_nr | ||
) |
Event on TFTP server invalid block received (Error)
session | session number |
block_nr | block number |
The event InvalidBlockReceived is created when the TFTP server receives the data block with invalid sequence, that is, an out of order block. The server session then terminates.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_InvalidTransferId | ( | uint8_t | session | ) |
Event on TFTP server invalid transfer id (TID) detected (Error)
session | session number |
The event InvalidTransferId is created when the TFTP server receives an invalid transfer identification (TID) data frame. The server session then terminates.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_LocalFileCreateFailed | ( | uint8_t | session | ) |
Event on TFTP server local file create failed (Error)
session | session number |
The event LocalFileCreateFailed is created when the requested file cannot be created on the TFTP server. A possible reason for this may be the write-protected SD card. The server session then terminates.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_LocalFileNotFound | ( | uint8_t | session | ) |
Event on TFTP server error, requested file not found on server (Error)
session | session number |
The event LocalFileNotFound is created when the requested file cannot be found on the TFTP server. The server session then terminates.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_OperationRequest | ( | uint8_t | session, |
uint16_t | tftp_opcode | ||
) |
Event on TFTP server process operation request (Op)
session | session number |
tftp_opcode | TFTP operation code
|
The event OperationRequest is created when the TFTP server wants to display the operation code it receives from the client.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_ReceiveDataFrame | ( | uint8_t | session, |
uint32_t | length | ||
) |
Event on TFTP server receive data frame (Op)
session | session number |
length | frame length in bytes |
The event ReceiveDataFrame is created when the TFTP server receives the data frame on the data socket.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_ReceiveFrame | ( | int32_t | socket, |
uint32_t | length | ||
) |
Event on TFTP server receive frame (Op)
socket | assigned UDP socket |
length | frame length in bytes |
The event ReceiveFrame is created when the TFTP server receives the frame.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_SendBlock | ( | uint8_t | session, |
uint32_t | block_nr, | ||
uint32_t | length | ||
) |
Event on TFTP server send block (Op)
session | session number |
block_nr | block number |
length | length of a block |
The event SendBlock is created when the TFTP header is constructed and the data block is sent to the UDP socket for transmitting.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_SendBlockAck | ( | uint8_t | session, |
uint16_t | block_nr | ||
) |
Event on TFTP server send block acknowledgment (Op)
session | session number |
block_nr | block number |
The event SendBlockAck is created when the TFTP server sends an acknowledgement of the received data block. The transfer then continues with the download of the next block.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_SendError | ( | uint8_t | session, |
uint16_t | error_nr | ||
) |
Event on TFTP server send error code (Op)
session | session number |
error_nr | TFTP error number
|
The event SendError is created when the TFTP server sends an error message to the client. The server session then terminates.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_SendOptionAck | ( | uint8_t | session, |
uint32_t | block_size | ||
) |
Event on TFTP server send option acknowledgment (Op)
session | session number |
block_size | block size |
The event SendOptionAck is created when the TFTP server sends an acknowledgement of the proposed transfer block size option. The size is usually 512 bytes.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_SessionRestart | ( | uint8_t | session | ) |
Event on TFTP server session restart, maybe our response was lost (Op)
session | session number |
The event SessionRestart is created when the TFTP server receives a retransmitted request. This usually means that initial server response was lost. The server session then restarts.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_SetRootPath | ( | const char * | path, |
uint32_t | length | ||
) |
Event on TFTP server netTFTPs_SetRootPath (API)
path | path to server root folder |
length | length of the path string |
The event SetRootPath is created when the TFTP server changes the path to server files. This happens when the netTFTPs_SetRootPath function is executed.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_ShowClientAddress | ( | const void * | net_addr | ) |
Event on TFTP server display client IP address and port number (Op)
net_addr | pointer to NET_ADDR address structure |
The event ShowClientAddress is created when the TFTP server wants to display the contents of the network address structure, that is, the IP address and the port number of the client.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_ShowRequestMode | ( | const uint8_t * | mode, |
uint32_t | length | ||
) |
Event on TFTP server display received request mode parameter (Op)
mode | mode parameter in text format |
length | length of the mode string |
The event ShowRequestMode is created when the TFTP server wants to display the contents of a received mode option.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_ShowRootFolder | ( | const char * | root_folder, |
uint32_t | length | ||
) |
Event on TFTP server display root folder (Op)
root_folder | path to server root folder |
length | length of the root_folder string |
The event ShowRootFolder is created when the network library wants to display the path to the root folder that contains the TFTP server files. This event is generated only if the root folder is enabled in the TFTP server configuration.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_StartService | ( | uint16_t | port | ) |
Event on TFTP server start service (Op)
port | listening port number |
The event StartService is created when the network library starts the TFTP server service. This happens automatically if the auto-start services are enabled, or when the netTFTPs_Start function is executed.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_StopService | ( | void | ) |
Event on TFTP server stop service (Op)
The event StopService is created when the network library stops the TFTP server service. This happens when the netTFTPs_Stop function is executed.
__STATIC_INLINE void EvrNetTFTPs_TimeoutExpiredAbort | ( | uint8_t | session | ) |
Event on TFTP server session timeout expired, abort transfer (Error)
session | session number |
The event TimeoutExpiredAbort is created when the TFTP server session expired due to client inactivity. The session is then aborted.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_TooManyRetries | ( | uint8_t | session | ) |
Event on TFTP server too many retransmissions (Error)
session | session number |
The event TooManyRetries is created when the TFTP server receives or sends too many duplicate blocks. The server session then terminates.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_TransferBlockSize | ( | uint8_t | session, |
uint16_t | block_size | ||
) |
Event on TFTP server display transfer block size (Op)
session | session number |
block_size | size of transfer block |
The event TransferBlockSize is created when the TFTP server wants to display the size of transfer block that is set for the session. The size is usually 512 bytes.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_TransferModeNotBinary | ( | uint8_t | session | ) |
Event on TFTP server transfer mode not set to binary (Error)
session | session number |
The event TransferModeNotBinary is created when the TFTP server receives a request mode that is not "octet" or "netascii", so it is not a binary mode. The server session then terminates.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_UninitServer | ( | void | ) |
Event on TFTP server de-initialize (Op)
The event UninitServer is created when the function netUninitialize is executed.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_UserAccessDenied | ( | const void * | net_addr | ) |
Event on TFTP server user denied access (Error)
net_addr | pointer to NET_ADDR address structure |
The event UserAccessDenied is created when the TFTP server rejects the pending connection request for the client, because the user application has denied connection for this client. This happens when the netTFTPs_AcceptClient function returns false.
Value in the Event Recorder shows:
__STATIC_INLINE void EvrNetTFTPs_WriteErrorDiskFull | ( | uint8_t | session, |
uint32_t | length | ||
) |
Event on TFTP server write local disk failed, disk full (Error)
session | session number |
length | block data length |
The event WriteErrorDiskFull is created when the TFTP server failed to write data to a local file. This usually happens when the storage medium is full or when a write error occurs in netTFTPs_fwrite. The server session then terminates.
Value in the Event Recorder shows: