granicus.if.org Git - postgresql/blob - src/include/libpq/libpq.h

   1 /*-------------------------------------------------------------------------
   2  *
   3  * libpq.h
   4  *        POSTGRES LIBPQ buffer structure definitions.
   5  *
   6  *
   7  * Portions Copyright (c) 1996-2016, PostgreSQL Global Development Group
   8  * Portions Copyright (c) 1994, Regents of the University of California
   9  *
  10  * src/include/libpq/libpq.h
  11  *
  12  *-------------------------------------------------------------------------
  13  */
  14 #ifndef LIBPQ_H
  15 #define LIBPQ_H
  16
  17 #include <sys/types.h>
  18 #include <netinet/in.h>
  19
  20 #include "lib/stringinfo.h"
  21 #include "libpq/libpq-be.h"
  22
  23
  24 typedef struct
  25 {
  26         void            (*comm_reset) (void);
  27         int                     (*flush) (void);
  28         int                     (*flush_if_writable) (void);
  29         bool            (*is_send_pending) (void);
  30         int                     (*putmessage) (char msgtype, const char *s, size_t len);
  31         void            (*putmessage_noblock) (char msgtype, const char *s, size_t len);
  32         void            (*startcopyout) (void);
  33         void            (*endcopyout) (bool errorAbort);
  34 } PQcommMethods;
  35
  36 extern PGDLLIMPORT PQcommMethods *PqCommMethods;
  37
  38 #define pq_comm_reset() (PqCommMethods->comm_reset())
  39 #define pq_flush() (PqCommMethods->flush())
  40 #define pq_flush_if_writable() (PqCommMethods->flush_if_writable())
  41 #define pq_is_send_pending() (PqCommMethods->is_send_pending())
  42 #define pq_putmessage(msgtype, s, len) \
  43         (PqCommMethods->putmessage(msgtype, s, len))
  44 #define pq_putmessage_noblock(msgtype, s, len) \
  45         (PqCommMethods->putmessage(msgtype, s, len))
  46 #define pq_startcopyout() (PqCommMethods->startcopyout())
  47 #define pq_endcopyout(errorAbort) (PqCommMethods->endcopyout(errorAbort))
  48
  49 /*
  50  * External functions.
  51  */
  52
  53 /*
  54  * prototypes for functions in pqcomm.c
  55  */
  56 extern int StreamServerPort(int family, char *hostName,
  57                                  unsigned short portNumber, char *unixSocketDir,
  58                                  pgsocket ListenSocket[], int MaxListen);
  59 extern int      StreamConnection(pgsocket server_fd, Port *port);
  60 extern void StreamClose(pgsocket sock);
  61 extern void TouchSocketFiles(void);
  62 extern void RemoveSocketFiles(void);
  63 extern void pq_init(void);
  64 extern int      pq_getbytes(char *s, size_t len);
  65 extern int      pq_getstring(StringInfo s);
  66 extern void pq_startmsgread(void);
  67 extern void pq_endmsgread(void);
  68 extern bool pq_is_reading_msg(void);
  69 extern int      pq_getmessage(StringInfo s, int maxlen);
  70 extern int      pq_getbyte(void);
  71 extern int      pq_peekbyte(void);
  72 extern int      pq_getbyte_if_available(unsigned char *c);
  73 extern int      pq_putbytes(const char *s, size_t len);
  74
  75 /*
  76  * prototypes for functions in be-secure.c
  77  */
  78 extern char *ssl_cert_file;
  79 extern char *ssl_key_file;
  80 extern char *ssl_ca_file;
  81 extern char *ssl_crl_file;
  82
  83 extern int      (*pq_putmessage_hook) (char msgtype, const char *s, size_t len);
  84 extern int      (*pq_flush_hook) (void);
  85
  86 extern int      secure_initialize(void);
  87 extern bool secure_loaded_verify_locations(void);
  88 extern void secure_destroy(void);
  89 extern int      secure_open_server(Port *port);
  90 extern void secure_close(Port *port);
  91 extern ssize_t secure_read(Port *port, void *ptr, size_t len);
  92 extern ssize_t secure_write(Port *port, void *ptr, size_t len);
  93 extern ssize_t secure_raw_read(Port *port, void *ptr, size_t len);
  94 extern ssize_t secure_raw_write(Port *port, const void *ptr, size_t len);
  95
  96 extern bool ssl_loaded_verify_locations;
  97
  98 /* GUCs */
  99 extern char *SSLCipherSuites;
 100 extern char *SSLECDHCurve;
 101 extern bool SSLPreferServerCiphers;
 102
 103 #endif   /* LIBPQ_H */