1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
|
/**
* \file socket.h -- declarations for socket library functions
*
* For license terms, see the file COPYING in this directory.
*/
#ifndef SOCKET__
#define SOCKET__
struct addrinfo;
#include "config.h"
#include <sys/socket.h>
#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 **);
/**
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 length of buffer on success, -1 on failure.
*/
ssize_t SockRead(int sock, char *buf, size_t len);
/**
* Peek at the next socket character without actually reading it.
*/
int SockPeek(int sock);
/** Clear and free the internal buffer used for SockPrintf*().
* Safe to call if none was allocated. */
void SockFreeFbuf(void);
/**
Write a chunk of bytes to the socket (matches interface of fwrite).
Returns number of bytes successfully written.
*/
ssize_t SockWrite(int sock, const char *buf, size_t 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, or negative value for error.
*/
ssize_t SockPrintf(int sock, const char *format, ...)
__attribute__ ((format (printf, 2, 3)))
;
/**
Send formatted output to the socket (matches interface of fprintf).
Returns number of bytes successfully written, or negative value for error.
Clears its internal formatting buffer after use.
*/
ssize_t SockPrintfClear(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__ */
|