Some documentation fixes.
[paraslash.git] / net.h
1 /*
2 * Copyright (C) 2006-2007 Andre Noll <maan@systemlinux.org>
3 *
4 * Licensed under the GPL v2. For licencing details see COPYING.
5 */
6
7 /** \file net.h exported symbols from net.c */
8
9 /**
10 * the buffer size of the sun_path component of struct sockaddr_un
11 *
12 * While glibc doesn't define \p UNIX_PATH_MAX, it
13 * documents it has being limited to 108 bytes.
14 */
15 #ifndef UNIX_PATH_MAX
16 #define UNIX_PATH_MAX 108
17 #endif
18
19 /** used to crypt the communication between para_server and para_client */
20 typedef void crypt_function(unsigned long len,
21 const unsigned char *indata, unsigned char *outdata, void *private_data);
22
23 #include <netdb.h> /* hostent */
24 int get_host_info(char *host, struct hostent **ret);
25 int get_stream_socket(int domain);
26 void init_sockaddr(struct sockaddr_in*, int, const struct hostent*);
27 int send_buffer(int, const char *);
28 int send_bin_buffer(int, const char *, size_t);
29 __printf_2_3 int send_va_buffer(int fd, const char *fmt, ...);
30 int recv_buffer(int fd, char *buf, size_t size);
31 int recv_bin_buffer(int fd, char *buf, size_t size);
32 int para_accept(int, void *addr, socklen_t size);
33 int create_local_socket(const char *name, struct sockaddr_un *unix_addr,
34 mode_t mode);
35 int init_unix_addr(struct sockaddr_un *, const char *);
36 int recv_cred_buffer(int, char *, size_t);
37 ssize_t send_cred_buffer(int, char*);
38 int recv_pattern(int fd, const char *pattern, size_t bufsize);
39 int init_tcp_socket(int port);
40 void enable_crypt(int fd, crypt_function *recv_f, crypt_function *send_f,
41 void *private_data);
42 void disable_crypt(int fd);
43
44 /**
45 * A wrapper around connect(2).
46 *
47 * \param fd The file descriptor.
48 * \param addr The address to connect.
49 * \param len The size of \a addr.
50 *
51 * This should not be called directly. Always use the PARA_CONNECT macro.
52 *
53 * \return \p -E_CONNECT on errors, 1 on success.
54 *
55 * \sa connect(2), PARA_CONNECT.
56 */
57 static inline int _para_connect(int fd, void *addr, socklen_t len)
58 {
59 if (connect(fd, (struct sockaddr *)addr, len) == -1)
60 return -E_CONNECT;
61 return 1;
62 }
63
64 /** A macro for connect() which does not need a \a len parameter. */
65 #define PARA_CONNECT(fd, addr) _para_connect(fd, addr, sizeof(*(addr)))