debian man page for roar_socket_listen

roar_socket_listen(3)					System Manager's Manual: RoarAudio				     roar_socket_listen(3)

NAME
       roar_socket_listen - Opens a new listen socket

SYNOPSIS
       #include <roaraudio.h>

       int roar_socket_listen(int type, char * host, int port);

DESCRIPTION
       Opens a new listening socket for network clients to connect to.	You may accept new connections via accept(2).

PARAMETERS
       type   The type of the Socket. See the list below.

       host   The  host  or  path  name  to  listen  on.  This depends on the type argument.  For TCP/IP to listen on any interface use a value of
	      "0.0.0.0".

       port   The port number to listen on.  This may be ignored by types not supporting port numbers.

SOCKET TYPES
       ROAR_SOCKET_TYPE_UNKNOWN
	      The type will be auto detected. Don't use this if you know the type. Only use this to support user given addresses and  enable  auto
	      detection.

       ROAR_SOCKET_TYPE_TCP
	      Use  a TCP/IP connection. This is standard mode for networking.  host is the hostname or IP to listen on and port is the port number
	      to use.

       ROAR_SOCKET_TYPE_INET
	      Same as above but deprecated. Use ROAR_SOCKET_TYPE_TCP.

       ROAR_SOCKET_TYPE_UNIX
	      UNIX Domain Socket. This should be default for local connections.  host is the filename of the socket.

       ROAR_SOCKET_TYPE_DECNET
	      DECnet socket.

       ROAR_SOCKET_TYPE_FORK
	      This is to fork a roard to communicate with. Can't be use to listen on, just to connect to.  host and port is ignored at the moment.

       ROAR_SOCKET_TYPE_FILE
	      This is used to open a plain file. Can't be use to listen on, just to connect to.  host is the filename to connect to.

RETURN VALUE
       On success these calls return filehandle.  On error, -1 is returned.

BUGS
       Listening on UDP sockets is not supported at the moment.

EXAMPLES
       FIXME

SEE ALSO
       accept(2), libroar(7), RoarAudio(7).

RoarAudio							     May 2011						     roar_socket_listen(3)