TCP/IP Defines

Macros
#define	HOSTNAME_MAX_SIZE   64
#define	SOCKET_BUFFER_MAX_LENGTH   1400
#define	AF_INET   2
#define	SOCK_STREAM   1
#define	SOCK_DGRAM   2
#define	SOCKET_FLAGS_SSL   0x01
#define	TCP_SOCK_MAX   (7)
#define	UDP_SOCK_MAX   4
#define	MAX_SOCKET   (TCP_SOCK_MAX + UDP_SOCK_MAX)
#define	SOL_SOCKET   1
#define	SOL_SSL_SOCKET   2
#define	SO_SET_UDP_SEND_CALLBACK   0x00
#define	IP_ADD_MEMBERSHIP   0x01
#define	IP_DROP_MEMBERSHIP   0x02

Detailed Description

The following list of macros are used to define constants used throughout the socket layer.

Macro Definition Documentation

HOSTNAME_MAX_SIZE

#define HOSTNAME_MAX_SIZE   64

Maximum allowed size for a host domain name passed to the function gethostbyname gethostbyname. command value. Used with the setsockopt function.

SOCKET_BUFFER_MAX_LENGTH

#define SOCKET_BUFFER_MAX_LENGTH   1400

Maximum allowed size for a socket data buffer. Used with send socket function to ensure that the buffer sent is within the allowed range.

AF_INET

#define AF_INET   2

The AF_INET is the address family used for IPv4. An IPv4 transport address is specified with the sockaddr_in structure. (It is the only supported type for the current implementation.)

SOCK_STREAM

#define SOCK_STREAM   1

One of the IPv4 supported socket types for reliable connection-oriented stream connection. Passed to the socket function for the socket creation operation.

SOCK_DGRAM

#define SOCK_DGRAM   2

One of the IPv4 supported socket types for unreliable connectionless datagram connection. Passed to the socket function for the socket creation operation.

SOCKET_FLAGS_SSL

#define SOCKET_FLAGS_SSL   0x01

This flag shall be passed to the socket API for SSL session.

TCP_SOCK_MAX

#define TCP_SOCK_MAX   (7)

Maximum number of simultaneous TCP sockets.

UDP_SOCK_MAX

#define UDP_SOCK_MAX   4

Maximum number of simultaneous UDP sockets.

MAX_SOCKET

#define MAX_SOCKET   (TCP_SOCK_MAX + UDP_SOCK_MAX)

Maximum number of Sockets.

SOL_SOCKET

#define SOL_SOCKET   1

Socket option. Used with the setsockopt function

SOL_SSL_SOCKET

#define SOL_SSL_SOCKET   2

SSL Socket option level. Used with the setsockopt function

SO_SET_UDP_SEND_CALLBACK

#define SO_SET_UDP_SEND_CALLBACK   0x00

Socket option used by the application to enable/disable the use of UDP send callbacks. Used with the setsockopt function.

IP_ADD_MEMBERSHIP

#define IP_ADD_MEMBERSHIP   0x01

Set Socket Option Add Membership command value (to join a multicast group). Used with the setsockopt function.

IP_DROP_MEMBERSHIP

#define IP_DROP_MEMBERSHIP   0x02

Set Socket Option Drop Membership command value (to leave a multicast group). Used with the setsockopt function.