Penguin

Differences between current version and predecessor to the previous major change of socket(2).

Other diffs: Previous Revision, Previous Author, or view the Annotated Edit History

Newer page: version 5 Last edited on Sunday, March 16, 2003 7:33:53 pm by PerryLorier
Older page: version 4 Last edited on Tuesday, June 4, 2002 12:23:47 am by perry Revert
@@ -1,262 +1,85 @@
-SOCKET  
-!!!SOCKET  
-NAME  
-SYNOPSIS  
-DESCRIPTION  
-RETURN VALUE  
-ERRORS  
-CONFORMING TO  
-NOTE  
-BUGS  
-SEE ALSO  
-----  
 !!NAME 
+socket - create an endpoint for communication  
  
-  
-socket - create an endpoint for communication  
 !!SYNOPSIS 
+ __#include <sys/types.h>__  
+ __#include <sys/socket.h>__  
  
+ __int socket(int__ ''domain''__, int__ ''type''__, int__ ''protocol''__);__  
  
-__#include __  
-#include __  
-  
-  
-__int socket(int__ ''domain''__, int__  
-''type''__, int__  
-''protocol''__);__  
 !!DESCRIPTION 
+socket(2) creates an endpoint for communication and returns a descriptor.  
  
-  
-__Socket__ creates an endpoint for communication and  
-returns a descriptor.  
-  
-  
- The ''domain'' parameter specifies a communication  
- domain; this selects the protocol family which will be used  
- for communication. These families are defined in  
-____. The currently understood  
- formats include:  
- 
+The ''domain'' parameter specifies a communication domain; this selects the protocol family which will be used for communication. These families are defined in  
+__<sys/socket.h> __. The currently understood formats include:  
+|__Name__|__Purpose__|Man page  
+|PF_UNIX,PF_LOCAL|Local communication|unix(7)  
+|PF_INET|IPv4 Internet protocols|ip(7)  
+|PF_INET6|IPv6 Internet protocols|  
+|PF_IPX|IPX - Novell protocols|  
+|PF_NETLINK|Kernel user interface device|netlink(7)  
+|PF_X25|ITU&#8208;T X.25 / ISO&#8208;8208 protocol|x25(7)  
+|PF_AX25|Amateur radio AX.25 protocol|  
+|PF_ATMPVC|Access to raw ATM PVCs|  
+|PF_APPLETALK|Appletalk|ddp(7)  
+|PF_PACKET|Low level packet interface|packet(7)  
  
 The socket has the indicated ''type'', which specifies the communication semantics. Currently defined types are: 
+;__SOCK_STREAM__: Provides sequenced, reliable, two-way, connection-based byte streams. An out-of-band data transmission mechanism may be supported.  
+;__SOCK_DGRAM__: Supports datagrams (connectionless, unreliable messages of a fixed maximum length).  
+;__SOCK_SEQPACKET__: Provides a sequenced, reliable, two-way connection-based data transmission path for datagrams of fixed maximum length; a consumer is required to read an entire packet with each read system call.  
+;__SOCK_RAW__: Provides raw network protocol access.  
+;__SOCK_RDM__: Provides a reliable datagram layer that does not guarantee ordering.  
+;__SOCK_PACKET__: Obsolete and should not be used in new programs; see packet(7).  
  
+Some socket types may not be implemented by all protocol families; for example, __SOCK_SEQPACKET__ is not implemented for __AF_INET__.  
  
-__SOCK_STREAM__  
-  
-  
-Provides sequenced, reliable, two-way, connection-based byte  
-streams. An out-of-band data transmission mechanism may be  
-supported.  
-  
-  
-__SOCK_DGRAM__  
-  
-  
-Supports datagrams (connectionless, unreliable messages of a  
-fixed maximum length).  
-  
-  
-__SOCK_SEQPACKET__  
-  
-  
-Provides a sequenced, reliable, two-way connection-based  
-data transmission path for datagrams of fixed maximum  
-length; a consumer is required to read an entire packet with  
-each read system call.  
-  
-  
-__SOCK_RAW__  
-  
-  
-Provides raw network protocol access.  
-  
-  
-__SOCK_RDM__  
-  
-  
-Provides a reliable datagram layer that does not guarantee  
-ordering.  
-  
-  
-__SOCK_PACKET__  
-  
-  
-Obsolete and should not be used in new programs; see  
-packet(7).  
-  
-  
-Some socket types may not be implemented by all protocol  
-families; for example, __SOCK_SEQPACKET__ is not  
-implemented for __AF_INET__.  
-  
-  
- The ''protocol'' specifies a particular protocol to be  
- used with the socket. Normally only a single protocol exists  
- to support a particular socket type within a given protocol  
- family. However, it is possible that many protocols may  
- exist, in which case a particular protocol must be specified  
- in this manner. The protocol number to use is specific to  
- the ``communication domain'' in which communication is to  
- take place; see protocols(5). See  
- getprotoent(3) on how to map protocol name strings to 
+The ''protocol'' specifies a particular protocol to be used with the socket. Normally only a single protocol exists to support a particular socket type within a given protocol family. However, it is possible that many protocols may exist, in which case a particular protocol must be specified in this manner. The protocol number to use is specific to the ``communication domain'' in which communication is to take place; see protocols(5). See getprotoent(3) on how to map protocol name strings to 
 protocol numbers. 
  
+Sockets of type __SOCK_STREAM__ are full-duplex byte streams, similar to pipes. They do not preserve record boundaries. A stream socket must be in a ''connected''  
+state before any data may be sent or received on it. A connection to another socket is created with a connect(2) call. Once connected, data may be transferred using read(2) and write(2) calls or some variant of the send(2) and recv(2) calls. When a session has been completed a close(2) may be performed. Out-of-band data may also be transmitted as described in send(2) and received as described in recv(2).  
  
-Sockets of type __SOCK_STREAM__ are full-duplex byte  
-streams, similar to pipes. They do not preserve record  
-boundaries. A stream socket must be in a ''connected''  
-state before any data may be sent or received on it. A  
-connection to another socket is created with a  
-connect(2) call. Once connected, data may be  
-transferred using read(2) and write(2) calls  
-or some variant of the send(2) and recv(2)  
-calls. When a session has been completed a close(2)  
-may be performed. Out-of-band data may also be transmitted  
-as described in send(2) and received as described in  
-recv(2).  
-  
-  
- The communications protocols which implement a  
- __SOCK_STREAM__ ensure that data is not lost or  
- duplicated. If a piece of data for which the peer protocol  
- has buffer space cannot be successfully transmitted within a  
- reasonable length of time, then the connection is considered  
- to be dead. When __SO_KEEPALIVE__ is enabled on the  
- socket the protocol checks in a protocol-specific manner if  
- the other end is still alive. A __ SIGPIPE__ signal is  
- raised if a process sends or receives on a broken stream;  
-this causes naive processes, which do not handle the signal,  
- to exit. __SOCK_SEQPACKET__ sockets employ the same  
- system calls as __SOCK_STREAM__ sockets. The only  
-difference is that read(2) calls will return only the  
- amount of data requested, and any remaining in the arriving  
- packet will be discarded. Also all message boundaries in 
+The communications protocols which implement a __SOCK_STREAM__ ensure that data is not lost or duplicated. If a piece of data for which the peer protocol has buffer space cannot be successfully transmitted within a reasonable length of time, then the connection is considered to be dead. When __SO_KEEPALIVE__ is enabled on the socket the protocol checks in a protocol-specific manner if the other end is still alive. A [ SIGPIPE] signal is raised if a process sends or receives on a broken stream;  
+this causes naive processes, which do not handle the signal, to exit. __SOCK_SEQPACKET__ sockets employ the same system calls as __SOCK_STREAM__ sockets. The only  
+difference is that read(2) calls will return only the amount of data requested, and any remaining in the arriving packet will be discarded. Also all message boundaries in 
 incoming datagrams are preserved. 
  
+__SOCK_DGRAM__ and __SOCK_RAW__ sockets allow sending of datagrams to correspondents named in send(2) calls. Datagrams are generally received with recvfrom(2), which returns the next datagram with its return address.  
  
-__SOCK_DGRAM __ and __SOCK_RAW__ sockets allow sending  
-of datagrams to correspondents named in send(2)  
-calls . Datagrams are generally received with  
-recvfrom (2 ), which returns the next datagram with its  
-return address
+__SOCK_PACKET __ is an obsolete socket type to receive raw packets directly from the device driver . Use packet (7 ) instead
  
+An fcntl(2) call with the the __F_SETOWN__ argument can be used to specify a process group to receive a [SIGURG] signal when the out-of-band data arrives or [SIGPIPE] signal when a __SOCK_STREAM__ connection breaks unexpectedly. It may also be used to set the process or process group that receives the I/O and asynchronous notification of I/O events via [SIGIO]. Using __F_SETOWN__ is equivalent to an ioctl(2) call with the SIOSETOWN argument.  
  
-__SOCK _PACKET __ is an obsolete socket type to receive raw  
-packets directly from the device driver. Use  
-packet (7) instead
+When the network signals an error condition to the protocol module (e.g. using a ICMP message for IP) the pending error flag is set for the socket. The next operation on this socket will return the error code of the pending error. For some protocols it is possible to enable a per-socket error queue to retrieve detailed information about the error; see __IP _RECVERR __ in ip (7). 
  
+The operation of sockets is controlled by socket level ''options''. These options are defined in __<sys/socket.h>__. Setsockopt(2) and getsockopt(2) are used to set and get options, respectively.  
  
-An fcntl(2) call with the the __F_SETOWN__  
-argument can be used to specify a process group to receive a  
-__SIGURG__ signal when the out-of-band data arrives or  
-__SIGPIPE__ signal when a __SOCK_STREAM__ connection  
-breaks unexpectedly. It may also be used to set the process  
-or process group that receives the I/O and asynchronous  
-notification of I/O events via __SIGIO.__ Using  
-__F_SETOWN__ is equivalent to an ioctl(2) call  
-with the SIOSETOWN argument.  
-  
-  
-When the network signals an error condition to the protocol  
-module (e.g. using a ICMP message for IP) the pending error  
-flag is set for the socket. The next operation on this  
-socket will return the error code of the pending error. For  
-some protocols it is possible to enable a per-socket error  
-queue to retrieve detailed information about the error; see  
-__IP_RECVERR__ in ip(7)__.__  
-  
-  
-The operation of sockets is controlled by socket level  
-''options''. These options are defined in  
-____. Setsockopt(2) and  
-getsockopt(2) are used to set and get options,  
-respectively.  
 !!RETURN VALUE 
+-1 is returned if an error occurs; otherwise the return value is a descriptor referencing the socket.  
  
-  
--1 is returned if an error occurs; otherwise the return  
-value is a descriptor referencing the socket.  
 !!ERRORS 
+;[EPROTONOSUPPORT]: The protocol type or the specified protocol is not supported within this domain.  
+;[ENFILE]: Not enough kernel memory to allocate a new socket structure.  
+;[EMFILE]: Process file table overflow.  
+;[EACCES]: Permission to create a socket of the specified type and/or protocol is denied.  
+;[ENOBUFS] or [ENOMEM]: Insufficient memory is available. The socket cannot be created until sufficient resources are freed.  
+;[EINVAL]: Unknown protocol, or protocol family not available.  
  
+Other errors may be generated by the underlying protocol modules.  
  
-__EPROTONOSUPPORT__  
-  
-  
-The protocol type or the specified protocol is not supported  
-within this domain.  
-  
-  
-__ENFILE__  
-  
-  
-Not enough kernel memory to allocate a new socket  
-structure.  
-  
-  
-__EMFILE__  
-  
-  
-Process file table overflow.  
-  
-  
-__EACCES__  
-  
-  
-Permission to create a socket of the specified type and/or  
-protocol is denied.  
-  
-  
-__ENOBUFS__ or __ENOMEM__  
-  
-  
-Insufficient memory is available. The socket cannot be  
-created until sufficient resources are freed.  
-  
-  
-__EINVAL__  
-  
-  
-Unknown protocol, or protocol family not  
-available.  
-  
-  
-Other errors may be generated by the underlying protocol  
-modules.  
 !!CONFORMING TO 
+4.4BSD (the __socket__ function call appeared in 4.2BSD). Generally portable to/from non-BSD systems supporting clones of the BSD socket layer (including System V variants).  
  
-  
-4.4BSD (the __socket__ function call appeared in 4.2BSD).  
-Generally portable to/from non-BSD systems supporting clones  
-of the BSD socket layer (including System V  
-variants).  
 !!NOTE 
+The manifest constants used under BSD 4.* for protocol families are PF_UNIX, PF_INET, etc., while AF_UNIX etc. are used for address families. However, already the BSD man page promises:  
  
-  
-The manifest constants used under BSD 4.* for protocol  
-families are PF_UNIX, PF_INET, etc., while AF_UNIX etc. are  
-used for address families. However, already the BSD man page  
-promises:  
 !!BUGS 
+__SOCK_UUCP__ is not implemented yet.  
  
-  
-__SOCK_UUCP__ is not implemented yet.  
 !!SEE ALSO 
+accept(2), bind(2), connect(2), getprotoent(3), getsockname(2), getsockopt(2), ioctl(2), listen(2), read(2), recv(2), select(2), send(2), shutdown(2), socketpair(2), write(2)  
  
+``An Introductory 4.3 BSD Interprocess Communication Tutorial'' is reprinted in ''UNIX Programmer's Supplementary Documents Volume 1.''  
  
-accept(2), bind(2), connect(2),  
-getprotoent(3), getsockname(2),  
-getsockopt(2), ioctl(2), listen(2),  
-read(2), recv(2), select(2),  
-send(2), shutdown(2), socketpair(2),  
-write(2)  
-  
-  
-``An Introductory 4.3 BSD Interprocess Communication  
-Tutorial'' is reprinted in ''UNIX Programmer's  
-Supplementary Documents Volume 1.''  
-  
-  
- ``BSD Interprocess Communication Tutorial'' is reprinted in  
- ''UNIX Programmer's Supplementary Documents Volume  
- 1.''  
-----  
+``BSD Interprocess Communication Tutorial'' is reprinted in ''UNIX Programmer's Supplementary Documents Volume 1.'' 
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.