Pileus Git - ~andy/fetchmail/blob - socket.h

   1 /**
   2  * \file socket.h -- declarations for socket library functions
   3  *
   4  * For license terms, see the file COPYING in this directory.
   5  */
   6
   7 #ifndef SOCKET__
   8 #define SOCKET__
   9
  10 struct addrinfo;
  11
  12 #include <config.h>
  13 #include <sys/socket.h>
  14 #include <netdb.h>
  15
  16 /** Create a new client socket; returns -1 on error */
  17 int SockOpen(const char *host, const char *service, const char *plugin, struct addrinfo **);
  18
  19 /**
  20 Get a string terminated by an '\n' (matches interface of fgets).
  21 Pass it a valid socket, a buffer for the string, and
  22 the length of the buffer (including the trailing \0)
  23 returns length of buffer on success, -1 on failure.
  24 */
  25 int SockRead(int sock, char *buf, int len);
  26
  27 /**
  28  * Peek at the next socket character without actually reading it.
  29  */
  30 int SockPeek(int sock);
  31
  32 /**
  33 Write a chunk of bytes to the socket (matches interface of fwrite).
  34 Returns number of bytes successfully written.
  35 */
  36 int SockWrite(int sock, const char *buf, int size);
  37
  38 /* from /usr/include/sys/cdefs.h */
  39 #if !defined __GNUC__
  40 # define __attribute__(xyz)    /* Ignore. */
  41 #endif
  42
  43 /**
  44 Send formatted output to the socket (matches interface of fprintf).
  45 Returns number of bytes successfully written.
  46 */
  47 int SockPrintf(int sock, const char *format, ...)
  48     __attribute__ ((format (printf, 2, 3)))
  49     ;
  50
  51 /**
  52 Close a socket previously opened by SockOpen.  This allows for some
  53 additional clean-up if necessary.
  54 */
  55 int SockClose(int sock);
  56
  57 /**
  58  \todo document this
  59 */
  60 int UnixOpen(const char *path);
  61
  62 #ifdef SSL_ENABLE
  63 int SSLOpen(int sock, char *mycert, char *mykey, const char *myproto, int certck, char *cacertfile, char *cacertpath,
  64     char *fingerprint, char *servercname, char *label, char **remotename);
  65 #endif /* SSL_ENABLE */
  66
  67 #endif /* SOCKET__ */