X-Git-Url: http://pileus.org/git/?a=blobdiff_plain;f=socket.h;h=0c4ac001d219505555857c736eafdb9e93e0095a;hb=49268a95ee78bc179fd3439b3f06e9a06c993c92;hp=c493daa67067f2222e0f35a2f12e34a94471be3f;hpb=92397efcc624980fdf8467449b69d88d4acc4530;p=~andy%2Ffetchmail diff --git a/socket.h b/socket.h index c493daa6..0c4ac001 100644 --- a/socket.h +++ b/socket.h @@ -1,5 +1,5 @@ -/* - * socket.h -- declarations for socket library functions +/** + * \file socket.h -- declarations for socket library functions * * For license terms, see the file COPYING in this directory. */ @@ -7,16 +7,21 @@ #ifndef SOCKET__ #define SOCKET__ -/* Create a new client socket; returns (FILE *)NULL on error */ -#if INET6 -int SockOpen(const char *host, const char *service, const char *options, - const char *plugin); -#else /* INET6 */ -int SockOpen(const char *host, int clientPort, const char *options, - const char *plugin); -#endif /* INET6 */ +struct addrinfo; -/* +#include +#ifdef HAVE_SYS_SOCKET_H +#include +#elif HAVE_NET_SOCKET_H +#include +#endif +#include + +/** Create a new client socket; returns -1 on error */ +int SockOpen(const char *host, const char *service, const char *plugin, struct addrinfo **); + + +/** Get a string terminated by an '\n' (matches interface of fgets). Pass it a valid socket, a buffer for the string, and the length of the buffer (including the trailing \0) @@ -24,31 +29,48 @@ returns length of buffer on success, -1 on failure. */ int SockRead(int sock, char *buf, int len); -/* +/** * Peek at the next socket character without actually reading it. */ int SockPeek(int sock); -/* +/** Write a chunk of bytes to the socket (matches interface of fwrite). Returns number of bytes successfully written. */ -int SockWrite(int sock, char *buf, int size); +int SockWrite(int sock, const char *buf, int size); -/* +/* from /usr/include/sys/cdefs.h */ +#if !defined __GNUC__ || __GNUC__ < 2 +# define __attribute__(xyz) /* Ignore. */ +#endif + +/** Send formatted output to the socket (matches interface of fprintf). Returns number of bytes successfully written. */ #if defined(HAVE_STDARG_H) -int SockPrintf(int sock, const char *format, ...) ; +int SockPrintf(int sock, const char *format, ...) + __attribute__ ((format (printf, 2, 3))) + ; #else int SockPrintf(); #endif -/* +/** Close a socket previously opened by SockOpen. This allows for some additional clean-up if necessary. */ int SockClose(int sock); +/** + \todo document this +*/ +int UnixOpen(const char *path); + +#ifdef SSL_ENABLE +int SSLOpen(int sock, char *mycert, char *mykey, const char *myproto, int certck, char *cacertfile, char *cacertpath, + char *fingerprint, char *servercname, char *label, char **remotename); +#endif /* SSL_ENABLE */ + #endif /* SOCKET__ */