NetServices

This documentation is for the Segundo Equipo version of the NetServices library.

This library is based on Donatien's source V1.04 (5 August 2010).

The following improvements and bug fixes are made:

#pragma diag_remark directives are added to the following files to turn compiler warnings into remarks (which are not normally displayed)

• EthernetNetIf.cpp
• lwipNetUdpSocket.cpp
• igmp.c
• mem.c
• RPCHandler.cpp
• MySQLClient.cpp
• NTPClient.cpp

base64.h

• fixed bug that prevented Base64::encode from working with a string with embedded null characters
• required for authentication in SMTPClient

EmailMessage.cpp / .h

• renamed from emailMessage.cpp / .h
• updated from non-compiling sample
• bug fixes and additional methods
• changed recipients list from queue to vector for non-destructive send
• to be used with SMTPClient (see further down)

  » Import this library into a program

  NetServices - EmailMessage Class Reference

  Public Member Functions
  	EmailMessage ()
  	Instantiates the email message.
  	~EmailMessage ()
  	Destructor for the email message.
  void	setFrom (const char *from)
  	Set FROM address.
  void	addTo (const char *to)
  	Add TO address to list of recipient addresses.
  void	clearTo ()
  	Clear TO addresses.
  int	printf (const char *format,...)
  	Append text to content of message using printf.
  void	clearContent ()
  	Clear content previously appended by printf.
  Friends
  class	SMTPClient

eth_drv.cpp / .h

• only creates Ethernet object if required (init may be called without previous call to eth_free)
• add method to allow access to Ethernet object pointer (may be null if not initialised)

Ethernet* eth_interface();

EthernetNetIf.cpp / .h

• implemented getHwAddr() method to return array containing hardware address
• turn off debug (uncomment line 34 in .cpp if required), IP address can be printed instead using getIp() method and hardware address using getHwAddr()

IpAddr ethIp = eth.getIp();
printf("Connected ok, IP : %d.%d.%d.%d\n", ethIp[0], ethIp[1], ethIp[2], ethIp[3]);
const char* hwAddr = eth.getHwAddr();
printf("HW address : %02x:%02x:%02x:%02x:%02x:%02x\n",
   hwAddr[0], hwAddr[1], hwAddr[2],
   hwAddr[3], hwAddr[4], hwAddr[5]);

• optional hostname in DHCP constructor

// set hostname ready for DHCP
EthernetNetIf eth("mbedSE");

• allow setup to be called multiple times by deleting and recreating network objects if previously setup
  • dhcp structure creation is moved to EthernetNetIf (to avoid memory leak) and passed to netif using dhcp_set_struct()
  • designed to be used so that setup can be called until successful as in the code sample below
  • note that behaviour when calling setup after a previous successful call is undefined

#define HOSTNAME "mbedSE"
EthernetNetIf eth(HOSTNAME);
EthernetErr ethErr;
do {
    printf("Setting up...\n");
    ethErr = eth.setup();
    if (ethErr) printf("Timeout\n", ethErr);
} while (ethErr != ETH_OK);

mem.c

• added MEM_POSITION to ram_heap

memp.c

• added MEM_POSITION to memp
• added MEM_POSITION to memp_bases
• added MEM_POSITION to memp_memory

lwipopts.h

• turned off SIO_FIFO_DEBUG and TCPDUMP_DEBUG
• defined LWIP_NETIF_HOSTNAME in DHCP options section

lwipopts2.h

• deleted (not used)

netCfg.h

• disabled all options apart from NET_ETH and NET_LWIP_STACK

NTPClient.cpp

• modified code (line 150) so that time is adjusted to limit offset range only if necessary (otherwise unconditional adjustment to end of July 2010 is undesirable since NTP could subsequently fail)

if ((int)time(NULL) < 1280000000) set_time( 1280000000 ); //End of July 2010... just there to limit offset range

RPCHandler.cpp

• modified cleanReq method to decode URLs (not just space and +) using url_decode already available in url.h

#include "url.h"
...
void RPCHandler::cleanReq(char* data)
{
    char* decoded = url_decode(data);
    strcpy(data, decoded);
    free(decoded);
/*    
  char* p;
  static const char* lGarbage[2] = {"%20", "+"};
  for(int i = 0; i < 2; i++)
  {
    while( p = strstr(data, lGarbage[i]) )
    {
      memset((void*) p, ' ', strlen(lGarbage[i]));
    }
  }
*/  
}

SMTPClient.cpp / .h

• updated from non-compiling sample
• bug fixes and additional methods
• non-destructive send message
• update to follow HTTPClient design pattern for blocking and non-blocking calls
• added plain authentication and dot stuffing
• to be used with EmailMessage (see further up)

  » Import this library into a program

  NetServices - SMTPClient Class Reference

  Public Member Functions
  	SMTPClient ()
  	Instantiates the SMTP client.
  virtual	~SMTPClient ()
  	Destructor for the SMTP client.
  	SMTPClient (const Host &host, const char *heloDomain, const char *user, const char *password, SMTPAuth auth)
  	Full constructor for the SMTP client.
  void	setServer (const Host &host)
  	Set server host.
  void	setAuth (const char *user, const char *password)
  	Provides a plain authentication feature (Base64 encoded username and password)
  void	clearAuth ()
  	Turns off authentication.
  void	setHeloDomain (const char *heloDomain)
  	Set HELO domain (defaults to localhost if not set)
  SMTPResult	send ( EmailMessage *pMessage)
  	Sends the message (blocking)
  SMTPResult	send ( EmailMessage *pMessage, void(*pMethod)( SMTPResult ))
  	Sends the message (non blocking)
  template<class T >
  SMTPResult	send ( EmailMessage *pMessage, T *pItem, void(T::*pMethod)( SMTPResult ))
  	Sends the message (non blocking)
  void	doSend ( EmailMessage *pMessage)
  	Sends the message (non blocking)
  void	setOnResult (void(*pMethod)( SMTPResult ))
  	Setup the result callback.
  void	setTimeout (int ms)
  	Setup timeout.
  string &	getLastResponse ()
  	Gets the last response from the server.
  virtual void	poll ()
  	This method can be inherited so that it is called on each Net::poll() call.
  Protected Member Functions
  void	close ()
  	This flags the service as to be destructed if owned by the pool.

timers.c

• reset next_timeout pointer on initialise (allows EthernetNetIf::setup to be called more than once)

void sys_timeouts_init(void)
{
  next_timeout = NULL;
...