weAut_01 / weAutSys    R 2.2.1
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines
Defines | Functions
uIP application functions
+ + uIP -- Adam Dunkels' TCP/IP stack + +

Overview

Functions used by an application running of top of uIP.

These functions do the opening and closing of connections, sending and receiving data, etc.

Defines

#define uip_abort()
 Abort the current connection.
#define uip_aborted()
 Has the connection been aborted by the other end.
#define uip_acked()
 Has previously sent data been acknowledged?
#define uip_close()
 Close the current connection.
#define uip_closed()
 Has the connection been closed by the other end?
#define uip_connected()
 Has the connection just been connected?
#define uip_datalen()
 The length of any incoming data that is currently available (if available) in the uip_appdata buffer.
#define uip_initialmss()
 Get the initial maximum segment size (MSS) of the current connection.
#define uip_mss()
 Current maximum segment size that can be sent on the current connection.
#define uip_newdata()
 Is new incoming data available?
#define uip_poll()
 Is the connection being polled by uIP?
#define uip_restart()
 Restart the current connection, if is has previously been stopped with uip_stop()
#define uip_rexmit()
 Do we need to retransmit previously data?
#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_timedout()
 Has the connection timed out?
#define uip_udp_bind(conn, port)
 Bind a UDP connection to a local port.
#define uip_udp_remove(conn)
 Remove / give up an UDP connection.
#define uip_udp_send(len)
 Send a UDP datagram of length len on the current connection.
#define uip_udpconnection()
 Is the current connection a UDP connection?

Functions

struct uipConn_tuip_connect (uip_ipaddr_t *ripaddr, uint16_t port)
 Connect to a remote host using TCP.
void uip_listen (uint16_t port)
 Start listening on the specified port.
void uip_send (const void *data, int len)
 Send data on the current connection.
struct uip_udp_conn * uip_udp_new (uip_ipaddr_t *ripaddr, uint16_t rport)
 Set up a new UDP connection.
void uip_unlisten (uint16_t port)
 Stop listening on the specified port.

Define Documentation

#define uip_datalen ( )

The length of any incoming data that is currently available (if available) in the uip_appdata buffer.

This returns the length of any incoming data that is currently available in the uip_appdata buffer.
If works only if there is any data available at all: the test function uip_newdata() must first be used to check this condition.

Examples:
main.c.
#define uip_close ( )

Close the current connection.

This function will close the current connection in a nice way.

#define uip_abort ( )

Abort the current connection.

This function will abort (reset) the current connection, and is usually used when an error has occurred that prevents using the uip_close() function.

#define uip_stop ( )

Tell the sending host to stop sending data.

This function will close our receiver's window so that we stop receiving data for the current connection.

#define uip_restart ( )

Restart the current connection, if is has previously been stopped with uip_stop()

This function will open the receiver's window again so that we start receiving data for the current connection.

#define uip_udpconnection ( )

Is the current connection a UDP connection?

This function checks whether the current connection is a UDP connection.

#define uip_newdata ( )

Is new incoming data available?

Will return non-zero resp. true if there is new data for the application present at the uip_appdata pointer. The size of the data is available through the uip_len variable.

Examples:
main.c.
#define uip_acked ( )

Has previously sent data been acknowledged?

Will return non-zero if the previously sent data has been acknowledged by the remote host. This means that the application can send new data.

Examples:
main.c.
#define uip_connected ( )

Has the connection just been connected?

Will return non-zero if the current connection has been connected to a remote host. This will happen both if the connection has been actively opened (with uip_connect()) or passively opened (with uip_listen()).

#define uip_closed ( )

Has the connection been closed by the other end?

Is non-zero if the connection has been closed by the remote host. The application may then do the necessary clean-ups.

#define uip_aborted ( )

Has the connection been aborted by the other end.

Non-zero if the current connection has been aborted (reset) by the remote host.

#define uip_timedout ( )

Has the connection timed out?

Non-zero if the current connection has been aborted due to too many retransmissions.

#define uip_rexmit ( )

Do we need to retransmit previously data?

Returns non-zero if the previously sent data has been lost in the network, and the application should retransmit it. The application should send exactly the same data as it did the last time, using the uip_send() function.

Examples:
main.c.
#define uip_poll ( )

Is the connection being polled by uIP?

Is non-zero if the reason the application is invoked is that the current connection has been idle for a while and should be polled.

The polling event can be used for sending data without having to wait for the remote host to send data.

#define uip_mss ( )

Current maximum segment size that can be sent on the current connection.

The current maximum segment size that can be sent on the connection is computed from the receiver's window and the MSS of the connection (which also is available by calling uip_initialmss()).

#define uip_udp_remove (   conn)

Remove / give up an UDP connection.

Parameters:
connpointer to the uip_udp_conn structure for the connection
#define uip_udp_bind (   conn,
  port 
)

Bind a UDP connection to a local port.

Parameters:
connpointer to the uip_udp_conn structure for the connection
portThe local port number, in network byte order
#define uip_udp_send (   len)

Send a UDP datagram of length len on the current connection.

This function can only be called in response to a UDP event (poll or newdata). The data must be present in the uip_buf buffer, at the place pointed to by the uip_appdata pointer.

Parameters:
lenThe length of the data in the uip_buf buffer

Function Documentation

void uip_listen ( uint16_t  port)

Start listening on the specified port.

Note:
Since this function expects the port number in network byte order, a conversion using HTONS() or htons() is necessary.
Parameters:
portA 16-bit port number in network byte order.
Examples:
main.c.
void uip_unlisten ( uint16_t  port)

Stop listening on the specified port.

Note:
Since this function expects the port number in network byte order, a conversion using HTONS() or htons() is necessary.
Parameters:
portA 16-bit port number in network byte order.
struct uipConn_t* uip_connect ( uip_ipaddr_t ripaddr,
uint16_t  port 
) [read]

Connect to a remote host using TCP.

This function is used to start a new connection to the specified port on the specified host. It allocates a new connection identifier, sets the connection to the SYN_SENT state and sets the retransmission timer to 0. This will cause a TCP SYN segment to be sent out the next time this connection is periodically processed, which usually is done within 0.5 seconds after the call to uip_connect().

Note:
This function is available only if support for active open has been configured by defining UIP_ACTIVE_OPEN to 1 in uipopt.h.
Since this function requires the port number to be in network byte order, a conversion using HTONS() or htons() is necessary.
 uip_ipaddr_t ipaddr;

 uip_ipaddr(&ipaddr, 192,168,1,2);
 uip_connect(&ipaddr, HTONS(80));
Parameters:
ripaddrthe IP address of the remote hot.
porta 16-bit port number in network byte order.
Returns:
a pointer to the uIP connection identifier for the new connection, or NULL if no connection could be allocated.
void uip_send ( const void *  data,
int  len 
)

Send data on the current connection.

This function is used to send out a single segment of TCP data. Only applications that have been invoked by uIP for event processing can send data.

The amount of data that actually is sent out after a call to this function is determined by the maximum amount of data TCP allows. uIP will automatically crop the data so that only the appropriate amount of data is sent. The function uip_mss() can be used to query uIP for the amount of data that actually will be sent.

Note:
This function does not guarantee that the sent data will arrive at the destination. If the data is lost in the network, the application will be invoked with the uip_rexmit() event being set. The application will then have to re-send the data using this function.
Parameters:
dataA pointer to the data which is to be sent
Using the buffer pointed to by uip_appdata to prepare the send data (and then use as this parameter) is strongly recommended.
lenThe maximum amount of data bytes to be sent.
Due to internal buffer limits this must not be more than UIP_APPDATA_SIZE
Examples:
main.c.
struct uip_udp_conn* uip_udp_new ( uip_ipaddr_t ripaddr,
uint16_t  rport 
) [read]

Set up a new UDP connection.

This function sets up a new UDP connection. The function will automatically allocate an unused local port for the new connection. However, another port can be chosen by using the uip_udp_bind() call, after the uip_udp_new() function has been called.

Example:

 uip_ipaddr_t addr;
 struct uip_udp_conn *c;
 
 uip_ipaddr(&addr, 192,168,2,1);
 c = uip_udp_new(&addr, HTONS(12345));
 if(c != NULL) {
   uip_udp_bind(c, HTONS(12344));
 }
Parameters:
ripaddrthe IP address of the remote host
rportthe remote port number in network byte order
Returns:
the uip_udp_conn structure for the new connection or NULL if no connection could be allocated.