* Licensed under the GPL v2. For licencing details see COPYING.
*/
-/** \file net.c networking-related helper functions */
+/** \file net.c Networking-related helper functions. */
#include "para.h"
#include "error.h"
static unsigned cda_size = 0;
/**
- * activate encryption for one file descriptor
+ * Activate encryption for one file descriptor.
*
- * \param fd the file descriptor
- * \param recv_f the function used for decrypting received data
- * \param send_f the function used for encrypting before sending
- * \param private_data user data supplied by the caller
+ * \param fd The file descriptor.
+ * \param recv_f The function used for decrypting received data.
+ * \param send_f The function used for encrypting before sending.
+ * \param private_data User data supplied by the caller.
*/
void enable_crypt(int fd, crypt_function *recv_f, crypt_function *send_f,
void *private_data)
}
/**
- * deactivate encryption for a given fd
+ * Deactivate encryption for a given fd.
*
- * \param fd the file descriptor
+ * \param fd The file descriptor.
*
* This must be called if and only if \p fd was activated via enable_crypt().
*/
/**
- * initialize a struct sockaddr_in
+ * Initialize a struct sockaddr_in.
*
- * \param addr A pointer to the struct to be initialized
- * \param port The port number to use
- * \param he The address to use
+ * \param addr A pointer to the struct to be initialized.
+ * \param port The port number to use.
+ * \param he The address to use.
*
* If \a he is null (server mode), \a addr->sin_addr is initialized with \p
* INADDR_ANY. Otherwise, the address given by \a he is copied to addr.
}
/*
- * send out a buffer, resend on short writes
- *
- * \param fd the file descriptor
- * \param buf The buffer to be sent
- * \param len The length of \a buf
+ * Send out a buffer, resend on short writes.
*
- * Due to circumstances beyond your control, the kernel might not send all the
- * data out in one chunk, and now, my friend, it's up to us to get the data out
- * there (Beej's Guide to Network Programming).
+ * \param fd The file descriptor.
+ * \param buf The buffer to be sent.
+ * \param len The length of \a buf.
*
- * \return This function returns 1 on success and \a -E_SEND on errors. The
- * number of bytes actually sent is stored upon successful return in \a len.
+ * \return Standard. In any case, the number of bytes actually sent is stored
+ * in \a len.
*/
static int sendall(int fd, const char *buf, size_t *len)
{
- size_t total = 0, bytesleft = *len; /* how many we have left to send */
- int n = -1;
-
- while (total < *len) {
- n = send(fd, buf + total, bytesleft, 0);
- if (n == -1)
- break;
- total += n;
- bytesleft -= n;
- if (total < *len)
- PARA_DEBUG_LOG("short write (%zd byte(s) left)\n",
- *len - total);
+ size_t total = *len;
+
+ assert(total);
+ *len = 0;
+ while (*len < total) {
+ int ret = send(fd, buf + *len, total - *len, 0);
+ if (ret == -1)
+ return -ERRNO_TO_PARA_ERROR(errno);
+ *len += ret;
}
- *len = total; /* return number actually sent here */
- return n == -1? -E_SEND : 1; /* return 1 on success */
+ return 1;
}
/**
* out the buffer, encrypted or not, and try to resend the remaing part in case
* of short writes.
*
- * \return Positive on success, \p -E_SEND on errors.
+ * \return Standard.
*/
int send_bin_buffer(int fd, const char *buf, size_t len)
{
}
/**
- * encrypt and send null terminated buffer.
+ * Encrypt and send null terminated buffer.
*
- * \param fd the file descriptor
- * \param buf the null-terminated buffer to be send
+ * \param fd The file descriptor.
+ * \param buf The null-terminated buffer to be send.
*
* This is equivalent to send_bin_buffer(fd, buf, strlen(buf)).
*
- * \return Positive on success, \p -E_SEND on errors.
+ * \return Standard.
*/
int send_buffer(int fd, const char *buf)
{
/**
- * send and encrypt a buffer given by a format string
+ * Send and encrypt a buffer given by a format string.
*
- * \param fd the file descriptor
- * \param fmt a format string
+ * \param fd The file descriptor.
+ * \param fmt A format string.
*
- * \return Positive on success, \p -E_SEND on errors.
+ * \return Standard.
*/
__printf_2_3 int send_va_buffer(int fd, const char *fmt, ...)
{
}
/**
- * receive and decrypt.
+ * Receive and decrypt.
*
- * \param fd the file descriptor
- * \param buf the buffer to write the decrypted data to
- * \param size the size of \a buf
+ * \param fd The file descriptor.
+ * \param buf The buffer to write the decrypted data to.
+ * \param size The size of \a buf.
*
- * Receive at most \a size bytes from filedescriptor fd. If encryption is
+ * Receive at most \a size bytes from file descriptor \a fd. If encryption is
* available, decrypt the received buffer.
*
- * \return The number of bytes received on success. On receive errors, -E_RECV
- * is returned. On crypt errors, the corresponding crypt error number is
- * returned.
+ * \return The number of bytes received on success, negative on errors.
*
* \sa recv(2)
*/
}
/**
- * receive, decrypt and write terminating NULL byte
+ * Receive, decrypt and write terminating NULL byte.
*
- * \param fd the file descriptor
- * \param buf the buffer to write the decrypted data to
- * \param size the size of \a buf
+ * \param fd The file descriptor.
+ * \param buf The buffer to write the decrypted data to.
+ * \param size The size of \a buf.
*
* Read and decrypt at most \a size - 1 bytes from file descriptor \a fd and
* write a NULL byte at the end of the received data.
*
- * \return: The return value of the underlying call to \a recv_bin_buffer().
+ * \return The return value of the underlying call to \a recv_bin_buffer().
*
* \sa recv_bin_buffer()
*/
{
int n;
- if (!size)
- return -E_RECV;
+ assert(size);
n = recv_bin_buffer(fd, buf, size - 1);
if (n >= 0)
buf[n] = '\0';
}
/**
- * paraslash's wrapper around the accept system call
+ * Wrapper around the accept system call.
*
- * \param fd the listening socket
- * \param addr structure which is filled in with the address of the peer socket
- * \param size should contain the size of the structure pointed to by \a addr
+ * \param fd The listening socket.
+ * \param addr Structure which is filled in with the address of the peer socket.
+ * \param size Should contain the size of the structure pointed to by \a addr.
*
* Accept incoming connections on \a addr. Retry if interrupted.
*
- * \return The new file descriptor on success, \a -E_ACCEPT on errors.
+ * \return The new file descriptor on success, negative on errors.
*
* \sa accept(2).
*/
do
new_fd = accept(fd, (struct sockaddr *) addr, &size);
while (new_fd < 0 && errno == EINTR);
- return new_fd < 0? -E_ACCEPT : new_fd;
+ return new_fd < 0? -ERRNO_TO_PARA_ERROR(errno) : new_fd;
}
static int setserversockopts(int socket_fd)
* \param buf the buffer to be sent
*
* \return On success, this call returns the number of characters sent. On
- * error, \p -E_SENDMSG ist returned.
+ * error, \p -E_SENDMSG is returned.
*
* \sa okir's Black Hats Manual
* \sa sendmsg(2)
projects / paraslash.git / blobdiff