Jump to main content

##

# 1.2.1.2.3 Library Interface

Name | Description
--- | ---
Macros |
MAX_BSD_SOCKETS | Berkeley API max number of sockets simultaneous supported
Functions |
accept | This function accepts connection requests queued for a listening socket.
bind | This function assigns a name to the socket descriptor.
closesocket | The closesocket function closes an existing socket.
connect | This function connects to the peer communications end point.
gethostname | Returns the standard host name for the system.
listen | The listen function sets the specified socket in a listen mode.
recv | The recv() function is used to receive incoming data that has been queued for a socket.
recvfrom | The recvfrom() function is used to receive incoming data that has been queued for a socket.
send | The send function is used to send outgoing data on an already connected socket.
sendto | This function used to send the data for both connection oriented and connection-less sockets.
socket | This function creates a new Berkeley socket.
getsockopt | Allows setting options to a socket like adjust RX/TX buffer size, etc
setsockopt | Allows setting options to a socket like adjust RX/TX buffer size, etc
gethostbyname | The gethostbyname function returns a structure of type hostent for the given host name.
freeaddrinfo | Frees the memory allocated by getaddrinfo
getaddrinfo | Does an address look up for the provided node name.
getsockname | Returns the current address to which the socket is bound.
TCPIP_BSD_Socket | Returns the native socket number associated with the BSD socket.
TCPIP_BSD_Task | Standard TCP/IP stack module task function.
TCPIP_BSD_PresSocket | Returns the NET_PRES socket number associated with the BSD socket.
Data Types and Constants |
in_addr | in_addr structure
sockaddr | generic address structure for all address families
sockaddr_in | In the Internet address family
SOCKADDR | generic address structure for all address families
SOCKADDR_IN | In the Internet address family
SOCKET | Socket descriptor
AF_INET | Internet Address Family - IPv4, UDP, TCP, etc.
INADDR_ANY | IP address for server binding.
INVALID_TCP_PORT | Invalid TCP port
IP_ADDR_ANY | IP Address for server binding
IPPROTO_IP | Indicates IP pseudo-protocol.
IPPROTO_TCP | Indicates TCP level options
IPPROTO_UDP | Indicates UDP level options
SOCK_DGRAM | Connectionless datagram socket. Use UDP for the Internet address family.
SOCK_STREAM | Connection based byte streams. Use TCP for the Internet address family.
SOCKET_CNXN_IN_PROGRESS | Socket connection state.
SOCKET_DISCONNECTED | Socket disconnected
SOCKET_ERROR | Socket error
ICMP6_FILTER | SEt the IPv6 Filtering options - Not yet supported
IP_ADD_MEMBERSHIP | Join a multicast group - Not yet supported
IP_DROP_MEMBERSHIP | Leave a multicast group - Not yet supported
IP_MULTICAST_IF | Set the Interface that multicast packets should be sent on - Not yet supported
IP_MULTICAST_LOOP | Specify a copy of multicast packets should be delivered to the sending host - Not yet supported
IP_MULTICAST_TTL | Set the Time to Live option for multicast packets - Not yet supported
IP_OPTIONS | IP Header Options - Not yet supported
IP_TOS | Type of Service - Not yet supported
IP_TTL | Time to Live - Not yet supported
IPPROTO_ICMPV6 | Indicates IPv6 ICMP Protocol Options
IPPROTO_IPV6 | Indicates IP v6 Header options
IPV6_CHECKSUM | Sets the IPv6 Checksum options - Not yet supported
IPV6_JOIN_GROUP | Join an IPv6 multicast group - Not yet supported
IPV6_LEAVE_GROUP | Leave an IPv6 multicast group - Not yet supported
IPV6_MULTICAST_HOPS | Set the hop limit for multicast IPv6 packets - Not yet supported
IPV6_MULTICAST_IF | Set the Interface that multicast IPv6 packets should be sent on - Not yet supported
IPV6_MULTICAST_LOOP | Specify a copy of multicast IPv6 packets should be delivered to the sending host - Not yet supported
IPV6_UNICAST_HOPS | Set the hop limit for unicast IPv6 packets - Not yet supported
IPV6_V6ONLY | Sets the socket to IPv6 only - Not yet supported
SO_BROADCAST | Enables the Socket for sending broadcast data
SO_DEBUG | Indicates if low level debut is active - Not yet supported
SO_DONTROUTE | Bypass normal routing - Not yet supported
SO_KEEPALIVE | Keep the connection alive by sending periodic transmissions - Not yet supported
SO_LINGER | Indicates if the system should send any buffered data when a socket is closed
SO_OOBINLINE | Indicates whether or not Out of Band Data should be received inline with normal data - Not yet supported
SO_RCVBUF | Receive Buffer Size (TCP only)
SO_RCVLOWAT | Receive Low Water mark - Not yet supported
SO_RCVTIMEO | Set the Receive Timeout - Not yet supported
SO_REUSEADDR | Indicates if the local socket can be reused immediately after close - Not yet supported
SO_SNDBUF | Send Buffer Size
SO_SNDLOWAT | Send Low Water mark - Not yet supported
SO_SNDTIMEO | Set the Send Timeout - Not yet supported
SOL_SOCKET | Indicates socket level options
TCP_NODELAY | Indicates if TCP is to buffer packets - Not yet supported
linger | This is record linger.
hostent | This is record hostent.
in6_addr | This is record in6_addr.
sockaddr_in6 | In the Internet address family
sockaddr_storage | This is record sockaddr_storage.
addrinfo | This is record addrinfo.
SOCKADDR_IN6 | This is type SOCKADDR_IN6.
AF_INET6 | Internet Address Family - IPv6
HOST_NOT_FOUND | Authoritative Answer host not found
NO_DATA | Valid name, no data record of requested type
NO_RECOVERY | Non recoverable errors,
TRY_AGAIN | Non authoritative host not found or server fail
BERKELEY_MODULE_CONFIG | Berkeley API module configuration structure
__ss_aligntype | Structure large enough to hold any socket address (with the historical exception of AF_UNIX). 128 bytes reserved.
_SS_PADSIZE | This is macro _SS_PADSIZE.
_SS_SIZE | This is macro _SS_SIZE.
EAI_AGAIN | Temporary failure in name resolution.
EAI_BADFLAGS | Invalid value for ai_flags field.
EAI_FAIL | Non-recoverable failure in name res.
EAI_FAMILY | ai_family not supported.
EAI_MEMORY | Memory allocation failure.
EAI_NONAME | NAME or SERVICE is unknown.
EAI_OVERFLOW | Argument buffer overflow.
EAI_SERVICE | SERVICE not supported for ai_socktype.
EAI_SOCKTYPE | ai_socktype not supported.
EAI_SYSTEM | System error returned in errno.
_BERKELEY_API_HEADER_FILE | This is macro _BERKELEY_API_HEADER_FILE.
BERKELEYAPI_CONFIG_H | This is macro BERKELEYAPI_CONFIG_H.