WebSVN – HelenOS – Blame – /branches/network/uspace/srv/net/include/socket.h

Rev	Author	Line No.	Line
3846	mejdrech	1	/*
3912	mejdrech	2	* Copyright (c) 2009 Lukas Mejdrech
3846	mejdrech	3	* All rights reserved.
		4	*
		5	* Redistribution and use in source and binary forms, with or without
		6	* modification, are permitted provided that the following conditions
		7	* are met:
		8	*
		9	* - Redistributions of source code must retain the above copyright
		10	* notice, this list of conditions and the following disclaimer.
		11	* - Redistributions in binary form must reproduce the above copyright
		12	* notice, this list of conditions and the following disclaimer in the
		13	* documentation and/or other materials provided with the distribution.
		14	* - The name of the author may not be used to endorse or promote products
		15	* derived from this software without specific prior written permission.
		16	*
		17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
		18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
		19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
		20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
		21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
		22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
		23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
		24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
		25	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
		26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
		27	*/
		28
4578	mejdrech	29	/** @addtogroup socket
3846	mejdrech	30	* @{
		31	*/
		32
		33	/** @file
4578	mejdrech	34	* Socket application program interface (API).
		35	* This is a part of the network application library.
4728	mejdrech	36	* Based on the BSD socket interface.
3846	mejdrech	37	*/
		38
		39	#ifndef __NET_SOCKET_H__
		40	#define __NET_SOCKET_H__
		41
4603	mejdrech	42	#include "byteorder.h"
4578	mejdrech	43	#include "in.h"
		44	#include "inet.h"
		45
4712	mejdrech	46	#include "socket_codes.h"
4720	mejdrech	47	#include "socket_errno.h"
3846	mejdrech	48
4701	mejdrech	49	/** @name Socket application programming interface
		50	*/
		51	/@{/
		52
		53	/** Creates a new socket.
		54	* @param domain The socket protocol family. Input parameter.
		55	* @param type Socket type. Input parameter.
		56	* @param protocol Socket protocol. Input parameter.
		57	* @returns The socket identifier on success.
		58	* @returns EPFNOTSUPPORT if the protocol family is not supported.
		59	* @returns ESOCKNOTSUPPORT if the socket type is not supported.
		60	* @returns EPROTONOSUPPORT if the protocol is not supported.
		61	* @returns ENOMEM if there is not enough memory left.
		62	* @returns Other error codes as defined for the NET_SOCKET message.
		63	*/
4578	mejdrech	64	int socket( int domain, int type, int protocol );
4701	mejdrech	65
		66	/** Binds the socket to a port address.
		67	* @param socket_id Socket identifier. Input parameter.
		68	* @param my_addr The port address. Input parameter.
		69	* @param addrlen The address length. Input parameter.
		70	* @returns EOK on success.
		71	* @returns ENOTSOCK if the socket is not found.
		72	* @returns EBADMEM if the my_addr parameter is NULL.
		73	* @returns NO_DATA if the addlen parameter is zero (0).
		74	* @returns Other error codes as defined for the NET_SOCKET_BIND message.
		75	*/
4578	mejdrech	76	int bind( int socket_id, const struct sockaddr * my_addr, socklen_t addrlen );
4701	mejdrech	77
		78	/** Sets the number of connections waiting to be accepted.
		79	* @param socket_id Socket identifier. Input parameter.
		80	* @param backlog The maximum number of waiting sockets to be accepted. Input parameter.
		81	* @returns EOK on success.
		82	* @returns EINVAL if the backlog parameter is not positive (<=0).
		83	* @returns ENOTSOCK if the socket is not found.
		84	* @returns Other error codes as defined for the NET_SOCKET_LISTEN message.
		85	*/
4578	mejdrech	86	int listen( int socket_id, int backlog );
4701	mejdrech	87
		88	/** Accepts waiting socket.
		89	* Blocks until such a socket exists.
		90	* @param socket_id Socket identifier. Input parameter.
		91	* @param cliaddr The remote client address. Output parameter.
		92	* @param addrlen The address length. Input parameter.
		93	* @returns EOK on success.
		94	* @returns EBADMEM if the cliaddr or addrlen parameter is NULL.
		95	* @returns EINVAL if the backlog parameter is not positive (<=0).
		96	* @returns ENOTSOCK if the socket is not found.
		97	* @returns Other error codes as defined for the NET_SOCKET_ACCEPT message.
		98	*/
4578	mejdrech	99	int accept( int socket_id, struct sockaddr * cliaddr, socklen_t * addrlen );
4701	mejdrech	100
		101	/** Connects socket to the remote server.
		102	* @param socket_id Socket identifier. Input parameter.
		103	* @param serv_addr The remote server address. Input parameter.
		104	* @param addrlen The address length. Input parameter.
		105	* @returns EOK on success.
		106	* @returns EBADMEM if the serv_addr parameter is NULL.
		107	* @returns NO_DATA if the addlen parameter is zero (0).
		108	* @returns ENOTSOCK if the socket is not found.
		109	* @returns Other error codes as defined for the NET_SOCKET_CONNECT message.
		110	*/
4578	mejdrech	111	int connect( int socket_id, const struct sockaddr * serv_addr, socklen_t addrlen );
		112
4701	mejdrech	113	/** Closes the socket.
		114	* @param socket_id Socket identifier. Input parameter.
		115	* @returns EOK on success.
		116	* @returns ENOTSOCK if the socket is not found.
4726	mejdrech	117	* @returns EINPROGRESS if there is another blocking function in progress.
4701	mejdrech	118	* @returns Other error codes as defined for the NET_SOCKET_CLOSE message.
		119	*/
4578	mejdrech	120	int closesocket( int socket_id );
		121
4701	mejdrech	122	/** Sends data via the socket.
		123	* @param socket_id Socket identifier. Input parameter.
		124	* @param data The data to be sent. Input parameter.
		125	* @param datalength The data length. Input parameter.
		126	* @param flags Various send flags. Input parameter.
		127	* @returns EOK on success.
		128	* @returns ENOTSOCK if the socket is not found.
		129	* @returns EBADMEM if the data parameter is NULL.
		130	* @returns NO_DATA if the datalength parameter is zero (0).
		131	* @returns Other error codes as defined for the NET_SOCKET_SEND message.
		132	*/
4578	mejdrech	133	int send( int socket_id, void * data, size_t datalength, int flags );
4701	mejdrech	134
		135	/** Sends data via the socket to the remote address.
		136	* Binds the socket to a free port if not already connected/bound.
		137	* @param socket_id Socket identifier. Input parameter.
		138	* @param data The data to be sent. Input parameter.
		139	* @param datalength The data length. Input parameter.
		140	* @param flags Various send flags. Input parameter.
		141	* @param toaddr The destination address. Input parameter.
		142	* @param addrlen The address length. Input parameter.
		143	* @returns EOK on success.
		144	* @returns ENOTSOCK if the socket is not found.
		145	* @returns EBADMEM if the data or toaddr parameter is NULL.
		146	* @returns NO_DATA if the datalength or the addrlen parameter is zero (0).
		147	* @returns Other error codes as defined for the NET_SOCKET_SENDTO message.
		148	*/
4578	mejdrech	149	int sendto( int socket_id, const void * data, size_t datalength, int flags, const struct sockaddr * toaddr, socklen_t addrlen );
		150
4701	mejdrech	151	/** Receives data via the socket.
		152	* @param socket_id Socket identifier. Input parameter.
		153	* @param data The data buffer to be filled. Output parameter.
		154	* @param datalength The data length. Input parameter.
		155	* @param flags Various receive flags. Input parameter.
		156	* @returns EOK on success.
		157	* @returns ENOTSOCK if the socket is not found.
		158	* @returns EBADMEM if the data parameter is NULL.
		159	* @returns NO_DATA if the datalength parameter is zero (0).
		160	* @returns Other error codes as defined for the NET_SOCKET_RECV message.
		161	*/
4578	mejdrech	162	int recv( int socket_id, void * data, size_t datalength, int flags );
4701	mejdrech	163
		164	/** Receives data via the socket.
		165	* @param socket_id Socket identifier. Input parameter.
		166	* @param data The data buffer to be filled. Output parameter.
		167	* @param datalength The data length. Input parameter.
		168	* @param flags Various receive flags. Input parameter.
		169	* @param fromaddr The source address. Output parameter.
		170	* @param addrlen The address length. The maximum address length is read. The actual address length is set. Input/output parameter.
		171	* @returns EOK on success.
		172	* @returns ENOTSOCK if the socket is not found.
		173	* @returns EBADMEM if the data or fromaddr parameter is NULL.
		174	* @returns NO_DATA if the datalength or addrlen parameter is zero (0).
		175	* @returns Other error codes as defined for the NET_SOCKET_RECVFROM message.
		176	*/
4578	mejdrech	177	int recvfrom( int socket_id, void * data, size_t datalength, int flags, struct sockaddr * fromaddr, socklen_t * addrlen );
		178
4701	mejdrech	179	/** Gets socket option.
		180	* @param socket_id Socket identifier. Input parameter.
		181	* @param level The socket options level. Input parameter.
		182	* @param optname The socket option to be get. Input parameter.
		183	* @param value The value buffer to be filled. Output parameter.
		184	* @param optlen The value buffer length. The maximum length is read. The actual length is set. Input/output parameter.
		185	* @returns EOK on success.
		186	* @returns ENOTSOCK if the socket is not found.
		187	* @returns EBADMEM if the value or optlen parameter is NULL.
		188	* @returns NO_DATA if the optlen parameter is zero (0).
		189	* @returns Other error codes as defined for the NET_SOCKET_GETSOCKOPT message.
		190	*/
4578	mejdrech	191	int getsockopt( int socket_id, int level, int optname, void * value, size_t * optlen );
4701	mejdrech	192
		193	/** Sets socket option.
		194	* @param socket_id Socket identifier. Input parameter.
		195	* @param level The socket options level. Input parameter.
		196	* @param optname The socket option to be set. Input parameter.
		197	* @param value The value to be set. Input parameter.
		198	* @param optlen The value length. Input parameter.
		199	* @returns EOK on success.
		200	* @returns ENOTSOCK if the socket is not found.
		201	* @returns EBADMEM if the value parameter is NULL.
		202	* @returns NO_DATA if the optlen parameter is zero (0).
		203	* @returns Other error codes as defined for the NET_SOCKET_SETSOCKOPT message.
		204	*/
4578	mejdrech	205	int setsockopt( int socket_id, int level, int optname, const void * value, size_t optlen );
		206
4701	mejdrech	207	/@}/
		208
3846	mejdrech	209	#endif
		210
		211	/** @}
		212	*/

Subversion Repositories HelenOS

(root)/branches/network/uspace/srv/net/include/socket.h @ 4243 – Rev 4728