X-Git-Url: http://pileus.org/git/?a=blobdiff_plain;f=socket.h;h=0c4ac001d219505555857c736eafdb9e93e0095a;hb=da989f7b8294e342572ec5f27f1a6f3f2b1fe56f;hp=a89685bccfc1f631fcaafa0ba5b8f1e10c71f802;hpb=75b1a90747d6fa2d0d2962856c2875b92ebcfe7b;p=~andy%2Ffetchmail diff --git a/socket.h b/socket.h index a89685bc..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,23 +7,21 @@ #ifndef SOCKET__ #define SOCKET__ -/* Create a new client socket; returns (FILE *)NULL on error */ -#if INET6_ENABLE -int SockOpen(const char *host, const char *service, const char *options, - const char *plugin); -#else /* INET6_ENABLE */ -int SockOpen(const char *host, int clientPort, const char *options, - const char *plugin); -#endif /* INET6_ENABLE */ +struct addrinfo; -/* Returns 1 if this socket is OK, 0 if it isn't select()able - * on - probably because it's been closed. You should - * always check this function before passing stuff to the - * select()-based waiter, as otherwise it may loop. - */ -int SockCheckOpen(int fd); +#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) @@ -31,41 +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); -/* -FIXME: document this +/** + \todo document this */ int UnixOpen(const char *path); -#if SSL_ENABLE -int SSLOpen(int sock, char *mycert, char *mykey, char *myproto, int certck, char *certpath, - char *fingerprint, char *servercname, char *label); +#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__ */