Main Page   Modules   Data Structures   File List   Data Fields   Globals   Related Pages   Examples  

ucb Struct Reference


Detailed Description

This structure holds various fields used to keep track of UDP socket states, settings and event listener function.

Definition at line 506 of file tcp_ip.h.

Data Fields

UINT8 state
 State of socket entry.

UINT8 tos
 Type of service allocated for a socket.

UINT16 locport
UINT8 opts
 Socket options.

 INT8
 UDP socket application event listener.

 UINT8
 UDP socket application event listener.

 UINT32
 UDP socket application event listener.

 UINT16
 UDP socket application event listener.


Field Documentation

UINT8 ucb::state
 

This variable holds state of a particular UDP socket entry in the UDP socket table. Following values are possible:

  • UDP_STATE_FREE
  • UDP_STATE_CLOSED
  • UDP_STATE_OPENED

Definition at line 516 of file tcp_ip.h.

Referenced by process_udp_in(), udp_close(), udp_getfreeport(), udp_getsocket(), udp_init(), udp_open(), udp_releasesocket(), and udp_send().

UINT8 ucb::tos
 

For now no services implemented so this value is not important.

Definition at line 523 of file tcp_ip.h.

Referenced by udp_getsocket(), udp_init(), udp_releasesocket(), and udp_send().

UINT16 ucb::locport
 

Local UDP port of Socket

Definition at line 525 of file tcp_ip.h.

Referenced by process_udp_in(), udp_getfreeport(), udp_getsocket(), udp_init(), udp_open(), udp_releasesocket(), and udp_send().

UINT8 ucb::opts
 

Currently, this holds information about checksum calculation options. Can be one of the following:

  • UDP_OPT_NONE - cheksum calculation not performed
  • UDP_OPT_SEND_CS - checksum is calculated for outgoing UDP packets
  • UDP_OPT_CHECK_CS - checksum is checked for incoming UDP packets
  • UDP_OPT_SEND_CS | UDP_OPT_CHECK_CS - both checksum calculations are enabled

Definition at line 539 of file tcp_ip.h.

Referenced by process_udp_in(), udp_getsocket(), udp_init(), udp_releasesocket(), and udp_send().

ucb::INT8
 

Pointer to a event listener - a callback function used by TCP/IP stack to notify application about certain events.

Definition at line 547 of file tcp_ip.h.

ucb::UINT8
 

Pointer to a event listener - a callback function used by TCP/IP stack to notify application about certain events.

Definition at line 547 of file tcp_ip.h.

ucb::UINT32
 

Pointer to a event listener - a callback function used by TCP/IP stack to notify application about certain events.

Definition at line 547 of file tcp_ip.h.

ucb::UINT16
 

Pointer to a event listener - a callback function used by TCP/IP stack to notify application about certain events.

Definition at line 547 of file tcp_ip.h.


The documentation for this struct was generated from the following file:
Generated on Sun Aug 3 20:33:01 2003 for OpenTCP by doxygen1.2.18