uIP 1.0 based webserver for LPC1114 + ENC28J60

Dependencies:   mbed TMP102

Embed: (wiki syntax)

« Back to documentation index

Configuration options for uIP

Configuration options for uIP

uIP is configured using the per-project configuration file uipopt.h. More...

Files

file  uipopt.h
 

Configuration options for uIP.


file  uip-conf.h
 

An example uIP configuration file.


Project-specific configuration options

uIP has a number of configuration options that can be overridden for each project.

These are kept in a project-specific uip-conf.h file and all configuration names have the prefix UIP_CONF.


typedef uint8_t u8_t
 8 bit datatype
typedef uint16_t u16_t
 16 bit datatype
typedef unsigned short uip_stats_t
 Statistics datatype.

Application specific configurations

An uIP application is implemented using a single application function that is called by uIP whenever a TCP/IP event occurs.

The name of this function must be registered with uIP at compile time using the UIP_APPCALL definition.

uIP applications can store the application state within the uip_conn structure by specifying the type of the application structure by typedef:ing the type uip_tcp_appstate_t and uip_udp_appstate_t.

The file containing the definitions must be included in the uipopt.h file.

The following example illustrates how this can look.

void httpd_appcall(void);
#define UIP_APPCALL     httpd_appcall

struct httpd_state {
  u8_t state;
  u16_t count;
  char *dataptr;
  char *script;
};
typedef struct httpd_state uip_tcp_appstate_t

typedef struct httpd_state uip_tcp_appstate_t
 The type of the application state that is to be stored in the uip_conn structure.

General configuration options

void uip_log (char *msg)
 Print out a uIP log message.

Detailed Description

uIP is configured using the per-project configuration file uipopt.h.

This file contains all compile-time options for uIP and should be tweaked to match each specific project. The uIP distribution contains a documented example "uipopt.h" that can be copied and modified for each project.

Note:
Most of the configuration options in the uipopt.h should not be changed, but rather the per-project uip-conf.h file.

Typedef Documentation

typedef uint16_t u16_t

16 bit datatype

This typedef defines the 16-bit type used throughout uIP.

Definition at line 76 of file uip-conf.h.

typedef uint8_t u8_t

8 bit datatype

This typedef defines the 8-bit type used throughout uIP.

Definition at line 67 of file uip-conf.h.

typedef unsigned short uip_stats_t

Statistics datatype.

This typedef defines the dataype used for keeping statistics in uIP.

Definition at line 86 of file uip-conf.h.

The type of the application state that is to be stored in the uip_conn structure.

This usually is typedef:ed to a struct holding application state information.

Definition at line 40 of file webserver.h.


Function Documentation

void uip_log ( char *  msg )

Print out a uIP log message.

This function must be implemented by the module that uses uIP, and is called by uIP whenever a log message is generated.

Definition at line 147 of file main.cpp.