X-Git-Url: http://pileus.org/git/?a=blobdiff_plain;f=socket.h;h=9d9406d958c4eae21dfe3d901807dce816bcf4bf;hb=f16d8d23439b5569f0c2e1af22494708b507f277;hp=42f5c512c25b43d16fd8c6fb4a2eb8b8968b8a28;hpb=75e4877cbd430ea55299d6b2ef676a6a377d1e86;p=~andy%2Ffetchmail diff --git a/socket.h b/socket.h index 42f5c512..9d9406d9 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,36 +7,61 @@ #ifndef SOCKET__ #define SOCKET__ -/* Create a new client socket; returns (FILE *)NULL on error */ -int SockOpen(const char *host, int clientPort); +struct addrinfo; -/* +#include +#include +#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) -returns buffer on success, NULL on failure. +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__ +# 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, char *format, ...) ; -#else -int SockPrintf(); -#endif +int SockPrintf(int sock, const char *format, ...) + __attribute__ ((format (printf, 2, 3))) + ; +/** +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__ */