-/* Copyright (C) 1996,1997,1998 Free Software Foundation, Inc.
+/* Copyright (C) 1996,1997,1998, 2000 Free Software Foundation, Inc.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
#include <stdio.h>
-#include "_scm.h"
-#include "unif.h"
-#include "feature.h"
-#include "fports.h"
+#include "libguile/_scm.h"
+#include "libguile/unif.h"
+#include "libguile/feature.h"
+#include "libguile/fports.h"
+#include "libguile/strings.h"
+#include "libguile/vectors.h"
-#include "scm_validate.h"
-#include "socket.h"
+#include "libguile/validate.h"
+#include "libguile/socket.h"
#ifdef HAVE_STRING_H
#include <string.h>
\f
-GUILE_PROC (scm_htons, "htons", 1, 0, 0,
+SCM_DEFINE (scm_htons, "htons", 1, 0, 0,
(SCM in),
-"")
+ "Returns a new integer from @var{value} by converting from host to\n"
+ "network order. @var{value} must be within the range of a C unsigned\n"
+ "short integer.")
#define FUNC_NAME s_scm_htons
{
unsigned short c_in;
- SCM_VALIDATE_INT_COPY(1,in,c_in);
+ SCM_VALIDATE_INUM_COPY (1,in,c_in);
if (c_in != SCM_INUM (in))
SCM_OUT_OF_RANGE (1,in);
}
#undef FUNC_NAME
-GUILE_PROC (scm_ntohs, "ntohs", 1, 0, 0,
+SCM_DEFINE (scm_ntohs, "ntohs", 1, 0, 0,
(SCM in),
-"")
+ "Returns a new integer from @var{value} by converting from network to\n"
+ "host order. @var{value} must be within the range of a C unsigned short\n"
+ "integer.")
#define FUNC_NAME s_scm_ntohs
{
unsigned short c_in;
- SCM_VALIDATE_INT_COPY(1,in,c_in);
+ SCM_VALIDATE_INUM_COPY (1,in,c_in);
if (c_in != SCM_INUM (in))
SCM_OUT_OF_RANGE (1,in);
}
#undef FUNC_NAME
-GUILE_PROC (scm_htonl, "htonl", 1, 0, 0,
+SCM_DEFINE (scm_htonl, "htonl", 1, 0, 0,
(SCM in),
-"")
+ "Returns a new integer from @var{value} by converting from host to\n"
+ "network order. @var{value} must be within the range of a C unsigned\n"
+ "long integer.")
#define FUNC_NAME s_scm_htonl
{
unsigned long c_in = SCM_NUM2ULONG (1,in);
}
#undef FUNC_NAME
-GUILE_PROC (scm_ntohl, "ntohl", 1, 0, 0,
+SCM_DEFINE (scm_ntohl, "ntohl", 1, 0, 0,
(SCM in),
-"")
+ "Returns a new integer from @var{value} by converting from network to\n"
+ "host order. @var{value} must be within the range of a C unsigned\n"
+ "long integer.")
#define FUNC_NAME s_scm_ntohl
{
unsigned long c_in = SCM_NUM2ULONG (1,in);
#define SCM_SOCK_FD_TO_PORT(fd) (scm_sock_fd_to_port((fd),FUNC_NAME))
-GUILE_PROC (scm_socket, "socket", 3, 0, 0,
+SCM_DEFINE (scm_socket, "socket", 3, 0, 0,
(SCM family, SCM style, SCM proto),
-"")
+ "Returns a new socket port of the type specified by @var{family}, @var{style}\n"
+ "and @var{protocol}. All three parameters are integers. Typical values\n"
+ "for @var{family} are the values of @code{AF_UNIX}\n"
+ "and @code{AF_INET}. Typical values for @var{style} are\n"
+ "the values of @code{SOCK_STREAM}, @code{SOCK_DGRAM} and @code{SOCK_RAW}.\n\n"
+ "@var{protocol} can be obtained from a protocol name using\n"
+ "@code{getprotobyname}. A value of\n"
+ "zero specifies the default protocol, which is usually right.\n\n"
+ "A single socket port cannot by used for communication until\n"
+ "it has been connected to another socket.")
#define FUNC_NAME s_scm_socket
{
int fd;
SCM result;
- SCM_VALIDATE_INT(1,family);
- SCM_VALIDATE_INT(2,style);
- SCM_VALIDATE_INT(3,proto);
+ SCM_VALIDATE_INUM (1,family);
+ SCM_VALIDATE_INUM (2,style);
+ SCM_VALIDATE_INUM (3,proto);
fd = socket (SCM_INUM (family), SCM_INUM (style), SCM_INUM (proto));
result = SCM_SOCK_FD_TO_PORT (fd);
return result;
#ifdef HAVE_SOCKETPAIR
-GUILE_PROC (scm_socketpair, "socketpair", 3, 0, 0,
+SCM_DEFINE (scm_socketpair, "socketpair", 3, 0, 0,
(SCM family, SCM style, SCM proto),
-"")
+ "Returns a pair of connected (but unnamed) socket ports of the type specified\n"
+ "by @var{family}, @var{style} and @var{protocol}.\n"
+ "Many systems support only\n"
+ "socket pairs of the @code{AF_UNIX} family. Zero is likely to be\n"
+ "the only meaningful value for @var{protocol}.")
#define FUNC_NAME s_scm_socketpair
{
int fam;
SCM a;
SCM b;
- SCM_VALIDATE_INT(1,family);
- SCM_VALIDATE_INT(2,style);
- SCM_VALIDATE_INT(3,proto);
+ SCM_VALIDATE_INUM (1,family);
+ SCM_VALIDATE_INUM (2,style);
+ SCM_VALIDATE_INUM (3,proto);
fam = SCM_INUM (family);
#undef FUNC_NAME
#endif
-GUILE_PROC (scm_getsockopt, "getsockopt", 3, 0, 0,
+SCM_DEFINE (scm_getsockopt, "getsockopt", 3, 0, 0,
(SCM sock, SCM level, SCM optname),
-"")
+ "Returns the value of a particular socket option for the socket\n"
+ "port @var{socket}. @var{level} is an integer code for type of option\n"
+ "being requested, e.g., @code{SOL_SOCKET} for socket-level options.\n"
+ "@var{optname} is an\n"
+ "integer code for the option required and should be specified using one of\n"
+ "the symbols @code{SO_DEBUG}, @code{SO_REUSEADDR} etc.\n\n"
+ "The returned value is typically an integer but @code{SO_LINGER} returns a\n"
+ "pair of integers.")
#define FUNC_NAME s_scm_getsockopt
{
int fd;
- int optlen;
+ size_t optlen;
#ifdef HAVE_STRUCT_LINGER
char optval[sizeof (struct linger)];
#else
int ioptname;
#ifdef HAVE_STRUCT_LINGER
- optlen = (int) sizeof (struct linger);
+ optlen = sizeof (struct linger);
#else
- optlen = (int) sizeof (scm_sizet);
+ optlen = sizeof (size_t);
#endif
sock = SCM_COERCE_OUTPORT (sock);
- SCM_VALIDATE_OPFPORT(1,sock);
- SCM_VALIDATE_INT_COPY(2,level,ilevel);
- SCM_VALIDATE_INT_COPY(3,optname,ioptname);
+ SCM_VALIDATE_OPFPORT (1, sock);
+ SCM_VALIDATE_INUM_COPY (2, level, ilevel);
+ SCM_VALIDATE_INUM_COPY (3, optname, ioptname);
fd = SCM_FPORT_FDES (sock);
if (getsockopt (fd, ilevel, ioptname, (void *) optval, &optlen) == -1)
}
#undef FUNC_NAME
-GUILE_PROC (scm_setsockopt, "setsockopt", 4, 0, 0,
+SCM_DEFINE (scm_setsockopt, "setsockopt", 4, 0, 0,
(SCM sock, SCM level, SCM optname, SCM value),
-"")
+ "Sets the value of a particular socket option for the socket\n"
+ "port @var{socket}. @var{level} is an integer code for type of option\n"
+ "being set, e.g., @code{SOL_SOCKET} for socket-level options.\n"
+ "@var{optname} is an\n"
+ "integer code for the option to set and should be specified using one of\n"
+ "the symbols @code{SO_DEBUG}, @code{SO_REUSEADDR} etc.\n"
+ "@var{value} is the value to which the option should be set. For\n"
+ "most options this must be an integer, but for @code{SO_LINGER} it must\n"
+ "be a pair.\n\n"
+ "The return value is unspecified.")
#define FUNC_NAME s_scm_setsockopt
{
int fd;
#endif
int ilevel, ioptname;
sock = SCM_COERCE_OUTPORT (sock);
- SCM_VALIDATE_OPFPORT(1,sock);
- SCM_VALIDATE_INT_COPY(2,level,ilevel);
- SCM_VALIDATE_INT_COPY(3,optname,ioptname);
+ SCM_VALIDATE_OPFPORT (1,sock);
+ SCM_VALIDATE_INUM_COPY (2,level,ilevel);
+ SCM_VALIDATE_INUM_COPY (3,optname,ioptname);
fd = SCM_FPORT_FDES (sock);
if (0);
#ifdef SO_LINGER
{
#ifdef HAVE_STRUCT_LINGER
struct linger ling;
- SCM_ASSERT (SCM_NIMP (value) && SCM_CONSP (value)
+ SCM_ASSERT (SCM_CONSP (value)
&& SCM_INUMP (SCM_CAR (value))
&& SCM_INUMP (SCM_CDR (value)),
value, SCM_ARG4, FUNC_NAME);
memcpy (optval, (void *) &ling, optlen);
#else
scm_sizet ling;
- SCM_ASSERT (SCM_NIMP (value) && SCM_CONSP (value)
+ SCM_ASSERT (SCM_CONSP (value)
&& SCM_INUMP (SCM_CAR (value))
&& SCM_INUMP (SCM_CDR (value)),
value, SCM_ARG4, FUNC_NAME);
#ifdef SO_SNDBUF
else if (ilevel == SOL_SOCKET && ioptname == SO_SNDBUF)
{
- SCM_VALIDATE_INT(4,value);
+ SCM_VALIDATE_INUM (4,value);
optlen = (int) sizeof (scm_sizet);
(*(scm_sizet *) optval) = (scm_sizet) SCM_INUM (value);
}
#ifdef SO_RCVBUF
else if (ilevel == SOL_SOCKET && ioptname == SO_RCVBUF)
{
- SCM_VALIDATE_INT(4,value);
+ SCM_VALIDATE_INUM (4,value);
optlen = (int) sizeof (scm_sizet);
(*(scm_sizet *) optval) = (scm_sizet) SCM_INUM (value);
}
else
{
/* Most options just take an int. */
- SCM_VALIDATE_INT(4,value);
+ SCM_VALIDATE_INUM (4,value);
optlen = (int) sizeof (int);
(*(int *) optval) = (int) SCM_INUM (value);
}
}
#undef FUNC_NAME
-GUILE_PROC (scm_shutdown, "shutdown", 2, 0, 0,
+SCM_DEFINE (scm_shutdown, "shutdown", 2, 0, 0,
(SCM sock, SCM how),
-"")
+ "Sockets can be closed simply by using @code{close-port}. The\n"
+ "@code{shutdown} procedure allows reception or tranmission on a\n"
+ "connection to be shut down individually, according to the parameter\n"
+ "@var{how}:\n\n"
+ "@table @asis\n"
+ "@item 0\n"
+ "Stop receiving data for this socket. If further data arrives, reject it.\n"
+ "@item 1\n"
+ "Stop trying to transmit data from this socket. Discard any\n"
+ "data waiting to be sent. Stop looking for acknowledgement of\n"
+ "data already sent; don't retransmit it if it is lost.\n"
+ "@item 2\n"
+ "Stop both reception and transmission.\n"
+ "@end table\n\n"
+ "The return value is unspecified.")
#define FUNC_NAME s_scm_shutdown
{
int fd;
sock = SCM_COERCE_OUTPORT (sock);
- SCM_VALIDATE_OPFPORT(1,sock);
- SCM_VALIDATE_INT(2,how);
+ SCM_VALIDATE_OPFPORT (1,sock);
+ SCM_VALIDATE_INUM (2,how);
SCM_ASSERT_RANGE(2,how,0 <= SCM_INUM (how) && 2 >= SCM_INUM (how));
fd = SCM_FPORT_FDES (sock);
if (shutdown (fd, SCM_INUM (how)) == -1)
soka->sin_family = AF_INET;
soka->sin_addr.s_addr =
htonl (scm_num2ulong (address, (char *) which_arg, proc));
- SCM_ASSERT (SCM_NIMP (*args) && SCM_CONSP (*args), *args,
+ SCM_ASSERT (SCM_CONSP (*args), *args,
which_arg + 1, proc);
isport = SCM_CAR (*args);
*args = SCM_CDR (*args);
scm_must_malloc (sizeof (struct sockaddr_un), proc);
memset (soka, 0, sizeof (struct sockaddr_un));
soka->sun_family = AF_UNIX;
- SCM_ASSERT (SCM_NIMP (address) && SCM_ROSTRINGP (address), address,
+ SCM_ASSERT (SCM_ROSTRINGP (address), address,
which_arg, proc);
memcpy (soka->sun_path, SCM_ROCHARS (address),
1 + SCM_ROLENGTH (address));
}
}
-GUILE_PROC (scm_connect, "connect", 3, 0, 1,
+SCM_DEFINE (scm_connect, "connect", 3, 0, 1,
(SCM sock, SCM fam, SCM address, SCM args),
-"")
+ "Initiates a connection from @var{socket} to the address\n"
+ "specified by @var{address} and possibly @var{arg @dots{}}. The format\n"
+ "required for @var{address}\n"
+ "and @var{arg} @dots{} depends on the family of the socket.\n\n"
+ "For a socket of family @code{AF_UNIX},\n"
+ "only @code{address} is specified and must be a string with the\n"
+ "filename where the socket is to be created.\n\n"
+ "For a socket of family @code{AF_INET},\n"
+ "@code{address} must be an integer Internet host address and @var{arg} @dots{}\n"
+ "must be a single integer port number.\n\n"
+ "The return value is unspecified.")
#define FUNC_NAME s_scm_connect
{
int fd;
scm_sizet size;
sock = SCM_COERCE_OUTPORT (sock);
- SCM_VALIDATE_OPFPORT(1,sock);
- SCM_VALIDATE_INT(2,fam);
+ SCM_VALIDATE_OPFPORT (1,sock);
+ SCM_VALIDATE_INUM (2,fam);
fd = SCM_FPORT_FDES (sock);
soka = scm_fill_sockaddr (SCM_INUM (fam), address, &args, 3, FUNC_NAME, &size);
if (connect (fd, soka, size) == -1)
}
#undef FUNC_NAME
-GUILE_PROC (scm_bind, "bind", 3, 0, 1,
+SCM_DEFINE (scm_bind, "bind", 3, 0, 1,
(SCM sock, SCM fam, SCM address, SCM args),
-"")
+ "Assigns an address to the socket port @var{socket}.\n"
+ "Generally this only needs to be done for server sockets,\n"
+ "so they know where to look for incoming connections. A socket\n"
+ "without an address will be assigned one automatically when it\n"
+ "starts communicating.\n\n"
+ "The format of @var{address} and @var{ARG} @dots{} depends on the family\n"
+ "of the socket.\n\n"
+ "For a socket of family @code{AF_UNIX}, only @var{address}\n"
+ "is specified and must \n"
+ "be a string with the filename where the socket is to be created.\n\n"
+ "For a socket of family @code{AF_INET}, @var{address} must be an integer\n"
+ "Internet host address and @var{arg} @dots{} must be a single integer\n"
+ "port number.\n\n"
+ "The values of the following variables can also be used for @var{address}:\n\n"
+ "@defvar INADDR_ANY\n"
+ "Allow connections from any address.\n"
+ "@end defvar\n\n"
+ "@defvar INADDR_LOOPBACK\n"
+ "The address of the local host using the loopback device.\n"
+ "@end defvar\n\n"
+ "@defvar INADDR_BROADCAST\n"
+ "The broadcast address on the local network.\n"
+ "@end defvar\n\n"
+ "@defvar INADDR_NONE\n"
+ "No address.\n"
+ "@end defvar\n\n"
+ "The return value is unspecified.")
#define FUNC_NAME s_scm_bind
{
int rv;
int fd;
sock = SCM_COERCE_OUTPORT (sock);
- SCM_VALIDATE_OPFPORT(1,sock);
- SCM_VALIDATE_INT(2,fam);
+ SCM_VALIDATE_OPFPORT (1,sock);
+ SCM_VALIDATE_INUM (2,fam);
soka = scm_fill_sockaddr (SCM_INUM (fam), address, &args, 3, FUNC_NAME, &size);
fd = SCM_FPORT_FDES (sock);
rv = bind (fd, soka, size);
}
#undef FUNC_NAME
-GUILE_PROC (scm_listen, "listen", 2, 0, 0,
+SCM_DEFINE (scm_listen, "listen", 2, 0, 0,
(SCM sock, SCM backlog),
-"")
+ "This procedure enables @var{socket} to accept connection\n"
+ "requests. @var{backlog} is an integer specifying\n"
+ "the maximum length of the queue for pending connections.\n"
+ "If the queue fills, new clients will fail to connect until the\n"
+ "server calls @code{accept} to accept a connection from the queue.\n\n"
+ "The return value is unspecified.")
#define FUNC_NAME s_scm_listen
{
int fd;
sock = SCM_COERCE_OUTPORT (sock);
- SCM_VALIDATE_OPFPORT(1,sock);
- SCM_VALIDATE_INT(2,backlog);
+ SCM_VALIDATE_OPFPORT (1,sock);
+ SCM_VALIDATE_INUM (2,backlog);
fd = SCM_FPORT_FDES (sock);
if (listen (fd, SCM_INUM (backlog)) == -1)
SCM_SYSERROR;
ve[2] = scm_ulong2num ((unsigned long) ntohs (nad->sin_port));
}
else
- scm_misc_error (proc, "Unrecognised address family: %s",
+ scm_misc_error (proc, "Unrecognised address family: ~A",
scm_listify (SCM_MAKINUM (fam), SCM_UNDEFINED));
return result;
/* Allocate a buffer large enough to hold any sockaddr type. */
static char *scm_addr_buffer;
-static int scm_addr_buffer_size;
+static size_t scm_addr_buffer_size;
static void
scm_init_addr_buffer (void)
{
scm_addr_buffer_size =
#ifdef HAVE_UNIX_DOMAIN_SOCKETS
- (int) sizeof (struct sockaddr_un)
+ sizeof (struct sockaddr_un)
#else
0
#endif
;
if (sizeof (struct sockaddr_in) > scm_addr_buffer_size)
- scm_addr_buffer_size = (int) sizeof (struct sockaddr_in);
+ scm_addr_buffer_size = sizeof (struct sockaddr_in);
scm_addr_buffer = scm_must_malloc (scm_addr_buffer_size, "address buffer");
}
-GUILE_PROC (scm_accept, "accept", 1, 0, 0,
+SCM_DEFINE (scm_accept, "accept", 1, 0, 0,
(SCM sock),
-"")
+ "Accepts a connection on a bound, listening socket @var{socket}. If there\n"
+ "are no pending connections in the queue, it waits until\n"
+ "one is available unless the non-blocking option has been set on the\n"
+ "socket.\n\n"
+ "The return value is a\n"
+ "pair in which the CAR is a new socket port for the connection and\n"
+ "the CDR is an object with address information about the client which\n"
+ "initiated the connection.\n\n"
+ "If the address is not available then the CDR will be an empty vector.\n\n"
+ "@var{socket} does not become part of the\n"
+ "connection and will continue to accept new requests.")
#define FUNC_NAME s_scm_accept
{
int fd;
SCM address;
SCM newsock;
- int tmp_size;
+ size_t tmp_size;
sock = SCM_COERCE_OUTPORT (sock);
- SCM_VALIDATE_OPFPORT(1,sock);
+ SCM_VALIDATE_OPFPORT (1,sock);
fd = SCM_FPORT_FDES (sock);
tmp_size = scm_addr_buffer_size;
newfd = accept (fd, (struct sockaddr *) scm_addr_buffer, &tmp_size);
}
#undef FUNC_NAME
-GUILE_PROC (scm_getsockname, "getsockname", 1, 0, 0,
+SCM_DEFINE (scm_getsockname, "getsockname", 1, 0, 0,
(SCM sock),
-"")
+ "Returns the address of @var{socket}, in the same form as the object\n"
+ "returned by @code{accept}. On many systems the address of a socket\n"
+ "in the @code{AF_FILE} namespace cannot be read.")
#define FUNC_NAME s_scm_getsockname
{
- int tmp_size;
+ size_t tmp_size;
int fd;
SCM result;
sock = SCM_COERCE_OUTPORT (sock);
- SCM_VALIDATE_OPFPORT(1,sock);
+ SCM_VALIDATE_OPFPORT (1,sock);
fd = SCM_FPORT_FDES (sock);
tmp_size = scm_addr_buffer_size;
if (getsockname (fd, (struct sockaddr *) scm_addr_buffer, &tmp_size) == -1)
}
#undef FUNC_NAME
-GUILE_PROC (scm_getpeername, "getpeername", 1, 0, 0,
+SCM_DEFINE (scm_getpeername, "getpeername", 1, 0, 0,
(SCM sock),
-"")
+ "Returns the address of the socket that the socket @var{socket} is connected to,\n"
+ "in the same form as the object\n"
+ "returned by @code{accept}. On many systems the address of a socket\n"
+ "in the @code{AF_FILE} namespace cannot be read.")
#define FUNC_NAME s_scm_getpeername
{
- int tmp_size;
+ size_t tmp_size;
int fd;
SCM result;
sock = SCM_COERCE_OUTPORT (sock);
- SCM_VALIDATE_OPFPORT(1,sock);
+ SCM_VALIDATE_OPFPORT (1,sock);
fd = SCM_FPORT_FDES (sock);
tmp_size = scm_addr_buffer_size;
if (getpeername (fd, (struct sockaddr *) scm_addr_buffer, &tmp_size) == -1)
}
#undef FUNC_NAME
-GUILE_PROC (scm_recv, "recv!", 2, 1, 0,
+SCM_DEFINE (scm_recv, "recv!", 2, 1, 0,
(SCM sock, SCM buf, SCM flags),
-"")
+ "Receives data from the socket port @var{socket}. @var{socket} must already\n"
+ "be bound to the address from which data is to be received.\n"
+ "@var{buf} is a string into which\n"
+ "the data will be written. The size of @var{buf} limits the amount of\n"
+ "data which can be received: in the case of packet\n"
+ "protocols, if a packet larger than this limit is encountered then some data\n"
+ "will be irrevocably lost.\n\n"
+ "The optional @var{flags} argument is a value or\n"
+ "bitwise OR of MSG_OOB, MSG_PEEK, MSG_DONTROUTE etc.\n\n"
+ "The value returned is the number of bytes read from the socket.\n\n"
+ "Note that the data is read directly from the socket file descriptor:\n"
+ "any unread buffered port data is ignored.")
#define FUNC_NAME s_scm_recv
{
int rv;
int fd;
int flg;
- SCM_VALIDATE_OPFPORT(1,sock);
- SCM_VALIDATE_STRING(2,buf);
- SCM_VALIDATE_INT_DEF_COPY(3,flags,0,flg);
+ SCM_VALIDATE_OPFPORT (1,sock);
+ SCM_VALIDATE_STRING (2,buf);
+ SCM_VALIDATE_INUM_DEF_COPY (3,flags,0,flg);
fd = SCM_FPORT_FDES (sock);
SCM_SYSCALL (rv = recv (fd, SCM_CHARS (buf), SCM_LENGTH (buf), flg));
}
#undef FUNC_NAME
-GUILE_PROC (scm_send, "send", 2, 1, 0,
+SCM_DEFINE (scm_send, "send", 2, 1, 0,
(SCM sock, SCM message, SCM flags),
-"")
+ "Transmits the string @var{message} on the socket port @var{socket}. \n"
+ "@var{socket} must already be bound to a destination address. The\n"
+ "value returned is the number of bytes transmitted -- it's possible for\n"
+ "this to be less than the length of @var{message} if the socket is\n"
+ "set to be non-blocking. The optional @var{flags} argument is a value or\n"
+ "bitwise OR of MSG_OOB, MSG_PEEK, MSG_DONTROUTE etc.\n\n"
+ "Note that the data is written directly to the socket file descriptor:\n"
+ "any unflushed buffered port data is ignored.")
#define FUNC_NAME s_scm_send
{
int rv;
int flg;
sock = SCM_COERCE_OUTPORT (sock);
- SCM_VALIDATE_OPFPORT(1,sock);
- SCM_VALIDATE_ROSTRING(2,message);
- SCM_VALIDATE_INT_DEF_COPY(3,flags,0,flg);
+ SCM_VALIDATE_OPFPORT (1,sock);
+ SCM_VALIDATE_ROSTRING (2,message);
+ SCM_VALIDATE_INUM_DEF_COPY (3,flags,0,flg);
fd = SCM_FPORT_FDES (sock);
SCM_SYSCALL (rv = send (fd, SCM_ROCHARS (message), SCM_ROLENGTH (message), flg));
}
#undef FUNC_NAME
-GUILE_PROC (scm_recvfrom, "recvfrom!", 2, 3, 0,
+SCM_DEFINE (scm_recvfrom, "recvfrom!", 2, 3, 0,
(SCM sock, SCM buf, SCM flags, SCM start, SCM end),
-"")
+ "Returns data from the socket port @var{socket} and also information about\n"
+ "where the data was received from. @var{socket} must already\n"
+ "be bound to the address from which data is to be received.\n"
+ "@code{buf}, is a string into which\n"
+ "the data will be written. The size of @var{buf} limits the amount of\n"
+ "data which can be received: in the case of packet\n"
+ "protocols, if a packet larger than this limit is encountered then some data\n"
+ "will be irrevocably lost.\n\n"
+ "The optional @var{flags} argument is a value or\n"
+ "bitwise OR of MSG_OOB, MSG_PEEK, MSG_DONTROUTE etc.\n\n"
+ "The value returned is a pair: the CAR is the number of bytes read from\n"
+ "the socket and the CDR an address object in the same form as returned by\n"
+ "@code{accept}.\n\n"
+ "The @var{start} and @var{end} arguments specify a substring of @var{buf}\n"
+ "to which the data should be written.\n\n"
+ "Note that the data is read directly from the socket file descriptor:\n"
+ "any unread buffered port data is ignored.")
#define FUNC_NAME s_scm_recvfrom
{
int rv;
int flg;
int offset = 0;
int cend;
- int tmp_size;
+ size_t tmp_size;
SCM address;
- SCM_VALIDATE_OPFPORT(1,sock);
- SCM_VALIDATE_STRING(2,buf);
+ SCM_VALIDATE_OPFPORT (1,sock);
+ SCM_VALIDATE_STRING (2,buf);
cend = SCM_LENGTH (buf);
if (SCM_UNBNDP (flags))
}
#undef FUNC_NAME
-GUILE_PROC (scm_sendto, "sendto", 4, 0, 1,
+SCM_DEFINE (scm_sendto, "sendto", 4, 0, 1,
(SCM sock, SCM message, SCM fam, SCM address, SCM args_and_flags),
-"")
+ "Transmits the string @var{message} on the socket port @var{socket}. The\n"
+ "destination address is specified using the @var{family}, @var{address} and\n"
+ "@var{arg} arguments, in a similar way to the @code{connect}\n"
+ "procedure. The\n"
+ "value returned is the number of bytes transmitted -- it's possible for\n"
+ "this to be less than the length of @var{message} if the socket is\n"
+ "set to be non-blocking. The optional @var{flags} argument is a value or\n"
+ "bitwise OR of MSG_OOB, MSG_PEEK, MSG_DONTROUTE etc.\n\n"
+ "Note that the data is written directly to the socket file descriptor:\n"
+ "any unflushed buffered port data is ignored.")
#define FUNC_NAME s_scm_sendto
{
int rv;
int save_err;
sock = SCM_COERCE_OUTPORT (sock);
- SCM_VALIDATE_FPORT(1,sock);
- SCM_VALIDATE_ROSTRING(2,message);
- SCM_VALIDATE_INT(3,fam);
+ SCM_VALIDATE_FPORT (1,sock);
+ SCM_VALIDATE_ROSTRING (2,message);
+ SCM_VALIDATE_INUM (3,fam);
fd = SCM_FPORT_FDES (sock);
soka = scm_fill_sockaddr (SCM_INUM (fam), address, &args_and_flags, 4,
FUNC_NAME, &size);
flg = 0;
else
{
- SCM_VALIDATE_NIMCONS(5,args_and_flags);
+ SCM_VALIDATE_CONS (5,args_and_flags);
flg = SCM_NUM2ULONG (5,SCM_CAR (args_and_flags));
}
SCM_SYSCALL (rv = sendto (fd, SCM_ROCHARS (message), SCM_ROLENGTH (message),
scm_add_feature ("socket");
scm_init_addr_buffer ();
-#include "socket.x"
+#include "libguile/socket.x"
}
+
+/*
+ Local Variables:
+ c-file-style: "gnu"
+ End:
+*/
HCoop / bpt / guile.git / blobdiff