xref: /original-bsd/share/man/man4/tcp.4 (revision 54e6d6c7)
Copyright (c) 1983 The Regents of the University of California.
All rights reserved.

Redistribution and use in source and binary forms are permitted
provided that the above copyright notice and this paragraph are
duplicated in all such forms and that any documentation,
advertising materials, and other materials related to such
distribution and use acknowledge that the software was developed
by the University of California, Berkeley. The name of the
University may not be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

@(#)tcp.4 6.3 (Berkeley) 02/14/89

TCP 4 ""
C 5
NAME
tcp - Internet Transmission Control Protocol
SYNOPSIS
#include <sys/socket.h>

#include <netinet/in.h>

s = socket(AF_INET, SOCK_STREAM, 0);

DESCRIPTION
The TCP protocol provides reliable, flow-controlled, two-way transmission of data. It is a byte-stream protocol used to support the SOCK_STREAM abstraction. TCP uses the standard Internet address format and, in addition, provides a per-host collection of \*(lqport addresses\*(rq. Thus, each address is composed of an Internet address specifying the host and network, with a specific TCP port on the host identifying the peer entity.

Sockets utilizing the tcp protocol are either \*(lqactive\*(rq or \*(lqpassive\*(rq. Active sockets initiate connections to passive sockets. By default TCP sockets are created active; to create a passive socket the listen (2) system call must be used after binding the socket with the bind (2) system call. Only passive sockets may use the accept (2) call to accept incoming connections. Only active sockets may use the connect (2) call to initiate connections.

Passive sockets may \*(lqunderspecify\*(rq their location to match incoming connection requests from multiple networks. This technique, termed \*(lqwildcard addressing\*(rq, allows a single server to provide service to clients on multiple networks. To create a socket which listens on all networks, the Internet address INADDR_ANY must be bound. The TCP port may still be specified at this time; if the port is not specified the system will assign one. Once a connection has been established the socket's address is fixed by the peer entity's location. The address assigned the socket is the address associated with the network interface through which packets are being transmitted and received. Normally this address corresponds to the peer entity's network.

TCP supports one socket option which is set with setsockopt (2) and tested with getsockopt (2). Under most circumstances, TCP sends data when it is presented; when outstanding data has not yet been acknowledged, it gathers small amounts of output to be sent in a single packet once an acknowledgement is received. For a small number of clients, such as window systems that send a stream of mouse events which receive no replies, this packetization may cause significant delays. Therefore, TCP provides a boolean option, TCP_NODELAY (from <netinet/tcp.h> , to defeat this algorithm. The option level for the setsockopt call is the protocol number for TCP, available from getprotobyname (3).

Options at the IP transport level may be used with TCP; see ip (4). Incoming connection requests that are source-routed are noted, and the reverse source route is used in responding.

DIAGNOSTICS
A socket operation may fail with one of the following errors returned:

20 [EISCONN] when trying to establish a connection on a socket which already has one;

20 [ENOBUFS] when the system runs out of memory for an internal data structure;

20 [ETIMEDOUT] when a connection was dropped due to excessive retransmissions;

20 [ECONNRESET] when the remote peer forces the connection to be closed;

20 [ECONNREFUSED] when the remote peer actively refuses connection establishment (usually because no process is listening to the port);

20 [EADDRINUSE] when an attempt is made to create a socket with a port which has already been allocated;

20 [EADDRNOTAVAIL] when an attempt is made to create a socket with a network address for which no network interface exists.

SEE ALSO
getsockopt(2), socket(2), intro(4), inet(4), ip(4)