Mikroelektronika MIKROE-738 Datenbogen

Seite von 682
mikroC PRO for PIC32
MikroElektronika
451
SPI_Ethernet_UserUDP
Prototype
unsigned int SPI_Ethernet_UserUDP(unsigned char *remoteHost, unsigned int 
remotePort,  unsigned  int  localPort,  unsigned  int  reqLength,  TEthPktFlags 
*flags);
Description This is UDP module routine. It is internally called by the library. The user accesses to the UDP request 
by using some of the SPI_Ethernet_get routines. The user puts data in the transmit buffer by using 
some of the SPI_Ethernet_put routines. The function must return the length in bytes of the UDP reply, 
or 0 if nothing to transmit. If you don’t need to reply to the UDP requests, just define this function with 
a return(0) as single statement.
Parameters 
remoteHost
: client’s IP address. 
remotePort
: client’s port. 
localPort
: port to which the request is sent. 
reqLength
: UDP request data field length. 
flags
: structure consisted of two bit fields :  
Copy Code To Clipboard 
typedef struct {
  unsigned canCloseTCP: 1;  // flag which closes TCP socket (not relevant 
to UDP)
  unsigned isBroadcast: 1;  // flag which denotes that the IP package has 
been received via subnet broadcast address
} TEthPktFlags;
Returns
0
 - there should not be a reply to the request. 
- Length of UDP reply data field - otherwise. 
Requires
Ethernet module has to be initialized. See SPI_Ethernet_Init.
Example
This function is internally called by the library and should not be called by the user’s code.
Notes
The function source code is provided with appropriate example projects. The code should be adjusted 
by the user to achieve desired reply.