Contiki 2.6

uip.h File Reference

Header file for the uIP TCP/IP stack. More...

#include "net/uipopt.h"
#include "net/tcpip.h"

Go to the source code of this file.

Data Structures

union  uip_ip4addr_t
 Representation of an IP address. More...
struct  uip_802154_shortaddr
 16 bit 802.15.4 address More...
struct  uip_802154_longaddr
 64 bit 802.15.4 address More...
struct  uip_80211_addr
 802.11 address More...
struct  uip_eth_addr
 802.3 address More...
union  uip_buf_t
 The uIP packet buffer. More...
struct  uip_conn
 Representation of a uIP TCP connection. More...
struct  uip_udp_conn
 Representation of a uIP UDP connection. More...
struct  uip_stats
 The structure holding the TCP/IP statistics that are gathered if UIP_STATISTICS is set to 1. More...

Defines

#define uip_sethostaddr(addr)
 Set the IP address of this host.
#define uip_gethostaddr(addr)
 Get the IP address of this host.
#define uip_setdraddr(addr)
 Set the default router's IP address.
#define uip_setnetmask(addr)
 Set the netmask.
#define uip_getdraddr(addr)
 Get the default router's IP address.
#define uip_getnetmask(addr)
 Get the netmask.
#define uip_input()
 Process an incoming packet.
#define uip_udp_periodic(conn)
 Periodic processing for a connection identified by its number.
#define uip_udp_periodic_conn(conn)
 Periodic processing for a UDP connection identified by a pointer to its structure.
#define uip_datalen()
 The length of any incoming data that is currently available (if available) in the uip_appdata buffer.
#define uip_urgdatalen()
 The length of any out-of-band data (urgent data) that has arrived on the connection.
#define uip_close()
 Close the current connection.
#define uip_abort()
 Abort the current connection.
#define uip_stop()
 Tell the sending host to stop sending data.
#define uip_stopped(conn)
 Find out if the current connection has been previously stopped with uip_stop().
#define uip_restart()
 Restart the current connection, if is has previously been stopped with uip_stop().
#define uip_udpconnection()
 Is the current connection a UDP connection?
#define uip_newdata()
 Is new incoming data available?
#define uip_acked()
 Has previously sent data been acknowledged?
#define uip_connected()
 Has the connection just been connected?
#define uip_closed()
 Has the connection been closed by the other end?
#define uip_aborted()
 Has the connection been aborted by the other end?
#define uip_timedout()
 Has the connection timed out?
#define uip_rexmit()
 Do we need to retransmit previously data?
#define uip_poll()
 Is the connection being polled by uIP?
#define uip_initialmss()
 Get the initial maximum segment size (MSS) of the current connection.
#define uip_mss()
 Get the current maximum segment size that can be sent on the current connection.
#define uip_udp_remove(conn)
 Remove a UDP connection.
#define uip_udp_bind(conn, port)
 Bind a UDP connection to a local port.
#define uip_udp_send(len)
 Send a UDP datagram of length len on the current connection.
#define uip_ipaddr_to_quad(a)
 Convert an IP address to four bytes separated by commas.
#define uip_ipaddr(addr, addr0, addr1, addr2, addr3)
 Construct an IP address from four bytes.
#define uip_ip6addr(addr, addr0, addr1, addr2, addr3, addr4, addr5, addr6, addr7)
 Construct an IPv6 address from eight 16-bit words.
#define uip_ip6addr_u8(addr, addr0, addr1, addr2, addr3, addr4, addr5, addr6, addr7, addr8, addr9, addr10, addr11, addr12, addr13, addr14, addr15)
 Construct an IPv6 address from sixteen 8-bit words.
#define uip_ipaddr_copy(dest, src)   (*(dest) = *(src))
 Copy an IP address from one place to another.
#define uip_ipaddr_cmp(addr1, addr2)
 Compare two IP addresses.
#define uip_ipaddr_maskcmp(addr1, addr2, mask)
 Compare two IP addresses with netmasks.
#define uip_ipaddr_mask(dest, src, mask)
 Check if an address is a broadcast address for a network.
#define uip_ipaddr1(addr)
 Pick the first octet of an IP address.
#define uip_ipaddr2(addr)
 Pick the second octet of an IP address.
#define uip_ipaddr3(addr)
 Pick the third octet of an IP address.
#define uip_ipaddr4(addr)
 Pick the fourth octet of an IP address.
#define UIP_HTONS(n)
 Convert 16-bit quantity from host byte order to network byte order.
#define UIP_STAT(s)
 The uIP TCP/IP statistics.
#define UIP_APPDATA_SIZE
 The buffer size available for user data in the uip_buf buffer.

Typedefs

typedef union uip_ip4addr_t uip_ip4addr_t
 Representation of an IP address.
typedef struct uip_802154_shortaddr uip_802154_shortaddr
 16 bit 802.15.4 address
typedef struct uip_802154_longaddr uip_802154_longaddr
 64 bit 802.15.4 address
typedef struct uip_80211_addr uip_80211_addr
 802.11 address
typedef struct uip_eth_addr uip_eth_addr
 802.3 address
typedef uip_eth_addr uip_lladdr_t
 Ethernet address.

Functions

void uip_init (void)
 uIP initialization function.
void uip_setipid (uint16_t id)
 uIP initialization function.
void uip_reass_over (void)
 Abandon the reassembly of the current packet.
void uip_listen (uint16_t port)
 Start listening to the specified port.
void uip_unlisten (uint16_t port)
 Stop listening to the specified port.
struct uip_connuip_connect (uip_ipaddr_t *ripaddr, uint16_t port)
 Connect to a remote host using TCP.
CCIF void uip_send (const void *data, int len)
 Send data on the current connection.
struct uip_udp_connuip_udp_new (const uip_ipaddr_t *ripaddr, uint16_t rport)
 Set up a new UDP connection.
CCIF uint16_t uip_htons (uint16_t val)
 Convert a 16-bit quantity from host byte order to network byte order.
void uip_process (uint8_t flag)
 process the options within a hop by hop or destination option header
uint16_t uip_chksum (uint16_t *buf, uint16_t len)
 Calculate the Internet checksum over a buffer.
uint16_t uip_ipchksum (void)
 Calculate the IP header checksum of the packet header in uip_buf.
uint16_t uip_tcpchksum (void)
 Calculate the TCP checksum of the packet in uip_buf and uip_appdata.
uint16_t uip_udpchksum (void)
 Calculate the UDP checksum of the packet in uip_buf and uip_appdata.
uint16_t uip_icmp6chksum (void)
 Calculate the ICMP checksum of the packet in uip_buf.

Variables

CCIF uip_buf_t uip_aligned_buf
 Packet buffer for incoming and outgoing packets.
CCIF void * uip_appdata
 Pointer to the application data in the packet buffer.
CCIF uint16_t uip_len
 The length of the packet in the uip_buf buffer.
uint8_t uip_ext_len
 The length of the extension headers.
CCIF struct uip_connuip_conn
 Pointer to the current TCP connection.
uint8_t uip_acc32 [4]
 4-byte array used for the 32-bit sequence number calculations.
struct uip_udp_connuip_udp_conn
 The current UDP connection.
CCIF uip_lladdr_t uip_lladdr
 Host L2 address.

Detailed Description

Header file for the uIP TCP/IP stack.

Author:
Adam Dunkels <adam@dunkels.com>
Julien Abeille <jabeille@cisco.com> (IPv6 related code)
Mathilde Durvy <mdurvy@cisco.com> (IPv6 related code)

The uIP TCP/IP stack header file contains definitions for a number of C macros that are used by uIP programs as well as internal uIP structures, TCP/IP header structures and function declarations.

Definition in file uip.h.