X-Git-Url: http://pileus.org/git/?a=blobdiff_plain;f=socket.h;h=0c4ac001d219505555857c736eafdb9e93e0095a;hb=91644ff0b2e6eb3b26c5544a4a769ca4aaf08a14;hp=bdc58ca0e9a980de745769b41e6c8fa8dadfa671;hpb=5d4881b59094559c426e3b4d6d0205393b89f392;p=~andy%2Ffetchmail diff --git a/socket.h b/socket.h index bdc58ca0..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,27 +7,70 @@ #ifndef SOCKET__ #define SOCKET__ -/* -Create a new client socket -returns (FILE *)NULL on error -*/ -FILE *Socket(char *host, int clientPort); +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', delete any '\r' and the '\n'. + +/** +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) -returns 0 for success. +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 SockGets(char *buf, int len, FILE *sockfp); +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 -/* Ship a character array to the socket */ -#define SockWrite(buf, len, sockfp) fwrite(buf, 1, len, sockfp) +/** +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, ...) + __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); -/* -Send formatted output to the socket, followed -by a CR-LF. Returns 0 for success. +/** + \todo document this */ -#define SockPrintf fprintf +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__ */