Network Component  Version 7.11.0
MDK Middleware for IPv4 and IPv6 Networking
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
NetTFTPc: TFTP Client

Events generated by the Network - TFTP Client functions. More...

Functions

__STATIC_INLINE void EvrNetTFTPc_InitClient (void)
 Event on TFTP client initialize (Op) More...
 
__STATIC_INLINE void EvrNetTFTPc_GetSocketFailed (void)
 Event on TFTP client failed to allocate UDP socket (Error) More...
 
__STATIC_INLINE void EvrNetTFTPc_PutFile (const char *local_fname, uint32_t length)
 Event on TFTP client netTFTPc_Put (API) More...
 
__STATIC_INLINE void EvrNetTFTPc_PutRemoteName (const char *fname, uint32_t length)
 Event on TFTP client netTFTPc_Put remote filename (Op) More...
 
__STATIC_INLINE void EvrNetTFTPc_PutInvalidParameter (void)
 Event on netTFTPc_Put invalid parameter (Error) More...
 
__STATIC_INLINE void EvrNetTFTPc_PutWrongState (uint8_t state)
 Event on netTFTPc_Put wrong client state (Error) More...
 
__STATIC_INLINE void EvrNetTFTPc_ShowServerAddressIp4 (const void *net_addr)
 Event on TFTP client display server IPv4 address (Op) More...
 
__STATIC_INLINE void EvrNetTFTPc_ShowServerAddressIp6 (const void *net_addr)
 Event on TFTP client display server IPv6 address (Op) More...
 
__STATIC_INLINE void EvrNetTFTPc_OpenLocalFile (void)
 Event on TFTP client open local file (Op) More...
 
__STATIC_INLINE void EvrNetTFTPc_OpenLocalFileFailed (void)
 Event on TFTP client open local file failed (Error) More...
 
__STATIC_INLINE void EvrNetTFTPc_GetFile (const char *fname, uint32_t length)
 Event on TFTP client netTFTPc_Get (API) More...
 
__STATIC_INLINE void EvrNetTFTPc_GetLocalName (const char *local_fname, uint32_t length)
 Event on TFTP client netTFTPc_Get local filename (Op) More...
 
__STATIC_INLINE void EvrNetTFTPc_GetInvalidParameter (void)
 Event on netTFTPc_Get invalid parameter (Error) More...
 
__STATIC_INLINE void EvrNetTFTPc_GetWrongState (uint8_t state)
 Event on netTFTPc_Get wrong client state (Error) More...
 
__STATIC_INLINE void EvrNetTFTPc_TimeoutBlockRetransmit (uint32_t block_nr)
 Event on TFTP client block retransmit on timeout (Op) More...
 
__STATIC_INLINE void EvrNetTFTPc_SendBlock (uint32_t block_nr, uint32_t length)
 Event on TFTP client send block (Op) More...
 
__STATIC_INLINE void EvrNetTFTPc_StopClient (void)
 Event on TFTP client stop operation (Op) More...
 
__STATIC_INLINE void EvrNetTFTPc_CloseLocalFile (void)
 Event on TFTP client close local file (Op) More...
 
__STATIC_INLINE void EvrNetTFTPc_WrongServerIp4 (const uint8_t *ip4_addr)
 Event on TFTP client wrong server IPv4 address (Error) More...
 
__STATIC_INLINE void EvrNetTFTPc_WrongServerIp6 (const uint8_t *ip6_addr)
 Event on TFTP client wrong server IPv6 address (Error) More...
 
__STATIC_INLINE void EvrNetTFTPc_WrongServerPort (uint16_t udp_port)
 Event on TFTP client wrong server port (Error) More...
 
__STATIC_INLINE void EvrNetTFTPc_ServerTidAssigned (uint16_t tid)
 Event on TFTP client assigned transfer identifier (TID) of the server (Op) More...
 
__STATIC_INLINE void EvrNetTFTPc_FrameTooShort (uint32_t length, uint32_t min_length)
 Event on TFTP client receive frame too short (Error) More...
 
__STATIC_INLINE void EvrNetTFTPc_ReceiveFrame (uint32_t length)
 Event on TFTP client receive frame (Op) More...
 
__STATIC_INLINE void EvrNetTFTPc_ErrorCodeReceived (uint16_t error_code)
 Event on TFTP client error code received from server (Error) More...
 
__STATIC_INLINE void EvrNetTFTPc_DuplicateBlockAck (uint32_t block_nr)
 Event on TFTP client duplicate block acknowledge received (Op) More...
 
__STATIC_INLINE void EvrNetTFTPc_InvalidBlockAck (uint32_t block_nr)
 Event on TFTP client invalid block acknowledge received (Error) More...
 
__STATIC_INLINE void EvrNetTFTPc_BlockAckReceived (uint32_t block_nr)
 Event on TFTP client block acknowledge received (Op) More...
 
__STATIC_INLINE void EvrNetTFTPc_DuplicateBlockReceived (uint32_t block_nr)
 Event on TFTP client duplicate block received (Op) More...
 
__STATIC_INLINE void EvrNetTFTPc_InvalidBlockReceived (uint32_t block_nr)
 Event on TFTP client invalid block received (Error) More...
 
__STATIC_INLINE void EvrNetTFTPc_BlockReceived (uint32_t block_nr)
 Event on TFTP client block data received (Op) More...
 
__STATIC_INLINE void EvrNetTFTPc_WriteErrorDiskFull (uint32_t length)
 Event on TFTP client write local disk failed, disk full (Error) More...
 
__STATIC_INLINE void EvrNetTFTPc_IllegalServerOperation (void)
 Event on TFTP client deteced illegal server operation (Error) More...
 
__STATIC_INLINE void EvrNetTFTPc_SendRequest (uint16_t tftp_opcode)
 Event on TFTP client send operation request (Op) More...
 
__STATIC_INLINE void EvrNetTFTPc_OptionBlockSize (uint16_t block_size)
 Event on TFTP client add block size option (Op) More...
 
__STATIC_INLINE void EvrNetTFTPc_SendAck (uint16_t block_nr)
 Event on TFTP client send acknowledgment (Op) More...
 
__STATIC_INLINE void EvrNetTFTPc_SendError (uint16_t error_nr)
 Event on TFTP client send error code (Op) More...
 
__STATIC_INLINE void EvrNetTFTPc_OptionAckReceived (void)
 Event on TFTP client option acknowledgment received (Op) More...
 
__STATIC_INLINE void EvrNetTFTPc_UninitClient (void)
 Event on TFTP client de-initialize (Op) More...
 

Description

Events generated by the Network - TFTP Client functions.

Function Documentation

__STATIC_INLINE void EvrNetTFTPc_BlockAckReceived ( uint32_t  block_nr)

Event on TFTP client block acknowledge received (Op)

Parameters
block_nrblock number
__STATIC_INLINE void EvrNetTFTPc_BlockReceived ( uint32_t  block_nr)

Event on TFTP client block data received (Op)

Parameters
block_nrblock number
__STATIC_INLINE void EvrNetTFTPc_CloseLocalFile ( void  )

Event on TFTP client close local file (Op)

__STATIC_INLINE void EvrNetTFTPc_DuplicateBlockAck ( uint32_t  block_nr)

Event on TFTP client duplicate block acknowledge received (Op)

Parameters
block_nrblock number
__STATIC_INLINE void EvrNetTFTPc_DuplicateBlockReceived ( uint32_t  block_nr)

Event on TFTP client duplicate block received (Op)

Parameters
block_nrblock number
__STATIC_INLINE void EvrNetTFTPc_ErrorCodeReceived ( uint16_t  error_code)

Event on TFTP client error code received from server (Error)

Parameters
error_codeTFTP error code
  • 0: not defined error
  • 1: file not found error
  • 2: access violation error
  • 3: disk full error
  • 4: illegal opcode error
  • 5: unknown TID error
  • 6: file already exists error
  • 7: no such user error
__STATIC_INLINE void EvrNetTFTPc_FrameTooShort ( uint32_t  length,
uint32_t  min_length 
)

Event on TFTP client receive frame too short (Error)

Parameters
lengthframe length in bytes
min_lengthminimum length of the frame
__STATIC_INLINE void EvrNetTFTPc_GetFile ( const char *  fname,
uint32_t  length 
)

Event on TFTP client netTFTPc_Get (API)

Parameters
fnamename of the remote file
lengthlength of the fname string
__STATIC_INLINE void EvrNetTFTPc_GetInvalidParameter ( void  )

Event on netTFTPc_Get invalid parameter (Error)

__STATIC_INLINE void EvrNetTFTPc_GetLocalName ( const char *  local_fname,
uint32_t  length 
)

Event on TFTP client netTFTPc_Get local filename (Op)

Parameters
local_fnamename of the local file
lengthlength of the fname string
__STATIC_INLINE void EvrNetTFTPc_GetSocketFailed ( void  )

Event on TFTP client failed to allocate UDP socket (Error)

__STATIC_INLINE void EvrNetTFTPc_GetWrongState ( uint8_t  state)

Event on netTFTPc_Get wrong client state (Error)

Parameters
stateclient state
  • 0: idle
  • 1: put file
  • 2: get file
  • 3: stop client
__STATIC_INLINE void EvrNetTFTPc_IllegalServerOperation ( void  )

Event on TFTP client deteced illegal server operation (Error)

__STATIC_INLINE void EvrNetTFTPc_InitClient ( void  )

Event on TFTP client initialize (Op)

__STATIC_INLINE void EvrNetTFTPc_InvalidBlockAck ( uint32_t  block_nr)

Event on TFTP client invalid block acknowledge received (Error)

Parameters
block_nrblock number
__STATIC_INLINE void EvrNetTFTPc_InvalidBlockReceived ( uint32_t  block_nr)

Event on TFTP client invalid block received (Error)

Parameters
block_nrblock number
__STATIC_INLINE void EvrNetTFTPc_OpenLocalFile ( void  )

Event on TFTP client open local file (Op)

__STATIC_INLINE void EvrNetTFTPc_OpenLocalFileFailed ( void  )

Event on TFTP client open local file failed (Error)

__STATIC_INLINE void EvrNetTFTPc_OptionAckReceived ( void  )

Event on TFTP client option acknowledgment received (Op)

__STATIC_INLINE void EvrNetTFTPc_OptionBlockSize ( uint16_t  block_size)

Event on TFTP client add block size option (Op)

Parameters
block_sizesize of transfer block
__STATIC_INLINE void EvrNetTFTPc_PutFile ( const char *  local_fname,
uint32_t  length 
)

Event on TFTP client netTFTPc_Put (API)

Parameters
local_fnamename of the local file
lengthlength of the local_fname string
__STATIC_INLINE void EvrNetTFTPc_PutInvalidParameter ( void  )

Event on netTFTPc_Put invalid parameter (Error)

__STATIC_INLINE void EvrNetTFTPc_PutRemoteName ( const char *  fname,
uint32_t  length 
)

Event on TFTP client netTFTPc_Put remote filename (Op)

Parameters
fnamename of the remote file
lengthlength of the fname string
__STATIC_INLINE void EvrNetTFTPc_PutWrongState ( uint8_t  state)

Event on netTFTPc_Put wrong client state (Error)

Parameters
stateclient state
  • 0: idle
  • 1: put file
  • 2: get file
  • 3: stop client
__STATIC_INLINE void EvrNetTFTPc_ReceiveFrame ( uint32_t  length)

Event on TFTP client receive frame (Op)

Parameters
lengthframe length in bytes
__STATIC_INLINE void EvrNetTFTPc_SendAck ( uint16_t  block_nr)

Event on TFTP client send acknowledgment (Op)

Parameters
block_nrblock number
__STATIC_INLINE void EvrNetTFTPc_SendBlock ( uint32_t  block_nr,
uint32_t  length 
)

Event on TFTP client send block (Op)

Parameters
block_nrblock number
lengthlength of a block
__STATIC_INLINE void EvrNetTFTPc_SendError ( uint16_t  error_nr)

Event on TFTP client send error code (Op)

Parameters
error_nrTFTP error number
  • 0: not defined error
  • 1: file not found error
  • 2: access violation error
  • 3: disk full error
  • 4: illegal opcode error
  • 5: unknown TID error
  • 6: file already exists error
  • 7: no such user error
__STATIC_INLINE void EvrNetTFTPc_SendRequest ( uint16_t  tftp_opcode)

Event on TFTP client send operation request (Op)

Parameters
tftp_opcodeTFTP operation code
  • 1: read request
  • 2: write request
  • 3: data
  • 4: acknowledgment
  • 5: error
  • 6: option acknowledgment
__STATIC_INLINE void EvrNetTFTPc_ServerTidAssigned ( uint16_t  tid)

Event on TFTP client assigned transfer identifier (TID) of the server (Op)

Parameters
tidserver transfer identifier
Remarks
Transfer identifier is used as UDP port number.
__STATIC_INLINE void EvrNetTFTPc_ShowServerAddressIp4 ( const void *  net_addr)

Event on TFTP client display server IPv4 address (Op)

Parameters
net_addrpointer to NET_ADDR4 server address structure (8 bytes)
Remarks
Sends reduced size of net address structure with IPv4 address only.
__STATIC_INLINE void EvrNetTFTPc_ShowServerAddressIp6 ( const void *  net_addr)

Event on TFTP client display server IPv6 address (Op)

Parameters
net_addrpointer to NET_ADDR server address structure (20 bytes)
Remarks
Sends full size of net address structure with IPv6 address only.
__STATIC_INLINE void EvrNetTFTPc_StopClient ( void  )

Event on TFTP client stop operation (Op)

__STATIC_INLINE void EvrNetTFTPc_TimeoutBlockRetransmit ( uint32_t  block_nr)

Event on TFTP client block retransmit on timeout (Op)

Parameters
block_nrblock number
__STATIC_INLINE void EvrNetTFTPc_UninitClient ( void  )

Event on TFTP client de-initialize (Op)

__STATIC_INLINE void EvrNetTFTPc_WriteErrorDiskFull ( uint32_t  length)

Event on TFTP client write local disk failed, disk full (Error)

Parameters
lengthblock data length
__STATIC_INLINE void EvrNetTFTPc_WrongServerIp4 ( const uint8_t *  ip4_addr)

Event on TFTP client wrong server IPv4 address (Error)

Parameters
ip4_addrpointer to IPv4 address of TFTP server
__STATIC_INLINE void EvrNetTFTPc_WrongServerIp6 ( const uint8_t *  ip6_addr)

Event on TFTP client wrong server IPv6 address (Error)

Parameters
ip6_addrpointer to IPv6 address of TFTP server
__STATIC_INLINE void EvrNetTFTPc_WrongServerPort ( uint16_t  udp_port)

Event on TFTP client wrong server port (Error)

Parameters
udp_portwrong UDP port number