Update website for 6.3.24.

[~andy/fetchmail] / socket.h

diff --git a/socket.h b/socket.h
index 4473f0c08ccca99891110f1e685b9b0039b0fec9..0c4ac001d219505555857c736eafdb9e93e0095a 100644 (file)
--- a/socket.h
+++ b/socket.h
@@ -1,7 +1,5 @@
-/*
- * socket.h -- declarations for socket library functions
- *
- * Design and implementation by Carl Harris <ceharris@mal.com>
+/**
+ * \file socket.h -- declarations for socket library functions
  *
  * For license terms, see the file COPYING in this directory.
  */
@@ -9,63 +7,70 @@
 #ifndef SOCKET__
 #define SOCKET__
 
-#ifndef  INADDR_NONE
-#ifdef   INADDR_BROADCAST
-#define  INADDR_NONE   INADDR_BROADCAST
-#else
-#define         INADDR_NONE    -1
-#endif
+struct addrinfo;
+
+#include <config.h>
+#ifdef HAVE_SYS_SOCKET_H
+#include <sys/socket.h>
+#elif HAVE_NET_SOCKET_H
+#include <net/socket.h>
 #endif
+#include <netdb.h>
+
+/** Create a new client socket; returns -1 on error */
+int SockOpen(const char *host, const char *service, const char *plugin, struct addrinfo **);
 
-#if defined(HAVE_PROTOTYPES)
-/*
-Create a new client socket 
-returns < 0 on error 
-*/
-int Socket(char *host, int clientPort);
 
-/* 
-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 SockGets(int socket, char *buf, int len);
+int SockRead(int sock, char *buf, int len);
 
-/*
-Send a nul terminated string to the socket, followed by 
-a CR-LF.  Returns 0 for success.
-*/
-int SockPuts(int socket, char *buf);
+/**
+ * Peek at the next socket character without actually reading it.
+ */
+int SockPeek(int sock);
 
-/*
-Write a chunk of bytes to the socket.
-Returns 0 for success.
+/**
+Write a chunk of bytes to the socket (matches interface of fwrite).
+Returns number of bytes successfully written.
 */
-int SockWrite(int socket, char *buf, int len);
+int SockWrite(int sock, const char *buf, int size);
 
-/*
-Read a chunk of bytes from the socket.
-Returns 0 for success.
-*/
-int SockRead(int socket, char *buf, int len);
+/* from /usr/include/sys/cdefs.h */
+#if !defined __GNUC__ || __GNUC__ < 2
+# define __attribute__(xyz)    /* Ignore. */
+#endif
 
-/* 
-Send formatted output to the socket, followed
-by a CR-LF.
-Returns 0 for success.
+/**
+Send formatted output to the socket (matches interface of fprintf).
+Returns number of bytes successfully written.
 */
 #if defined(HAVE_STDARG_H)
-int SockPrintf(int socket, char *format, ...) ;
+int SockPrintf(int sock, const char *format, ...)
+    __attribute__ ((format (printf, 2, 3)))
+    ;
 #else
 int SockPrintf();
 #endif
-/*
-Check socket for readability.  return 0 for not readable,
->0 for readable.
-*/
-int SockStatus(int socket, int seconds);
  
-#endif /* defined(HAVE_PROTOTYPES) */
+/**
+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__ */