libpq-be.h File Reference

#include <sys/time.h>
#include "datatype/timestamp.h"
#include "libpq/hba.h"
#include "libpq/pqcomm.h"

Include dependency graph for libpq-be.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	Port

Typedefs
typedef enum CAC_state	CAC_state
typedef struct Port	Port

Enumerations
enum	CAC_state {   CAC_OK, CAC_STARTUP, CAC_SHUTDOWN, CAC_RECOVERY,   CAC_TOOMANY, CAC_SUPERUSER }

Functions
int	pq_getkeepalivesidle (Port *port)
int	pq_getkeepalivesinterval (Port *port)
int	pq_getkeepalivescount (Port *port)
int	pq_gettcpusertimeout (Port *port)
int	pq_setkeepalivesidle (int idle, Port *port)
int	pq_setkeepalivesinterval (int interval, Port *port)
int	pq_setkeepalivescount (int count, Port *port)
int	pq_settcpusertimeout (int timeout, Port *port)

Variables
ProtocolVersion	FrontendProtocol

Typedef Documentation

CAC_state

typedef enum CAC_state CAC_state

Port

typedef struct Port Port

Enumeration Type Documentation

CAC_state

enum CAC_state

Enumerator
CAC_OK
CAC_STARTUP
CAC_SHUTDOWN
CAC_RECOVERY
CAC_TOOMANY
CAC_SUPERUSER

Definition at line 71 of file libpq-be.h.

{
    CAC_OK, CAC_STARTUP, CAC_SHUTDOWN, CAC_RECOVERY, CAC_TOOMANY,
    CAC_SUPERUSER
} CAC_state;

Function Documentation

pq_getkeepalivescount()

int pq_getkeepalivescount

(

Port *

port

)

Definition at line 1846 of file pqcomm.c.

References SockAddr::addr, Port::default_keepalives_count, elog, IS_AF_UNIX, Port::keepalives_count, Port::laddr, LOG, and Port::sock.

Referenced by pq_setkeepalivescount(), and show_tcp_keepalives_count().

{
#ifdef TCP_KEEPCNT
    if (port == NULL || IS_AF_UNIX(port->laddr.addr.ss_family))
        return 0;

    if (port->keepalives_count != 0)
        return port->keepalives_count;

    if (port->default_keepalives_count == 0)
    {
        ACCEPT_TYPE_ARG3 size = sizeof(port->default_keepalives_count);

        if (getsockopt(port->sock, IPPROTO_TCP, TCP_KEEPCNT,
                       (char *) &port->default_keepalives_count,
                       &size) < 0)
        {
            elog(LOG, "getsockopt(%s) failed: %m", "TCP_KEEPCNT");
            port->default_keepalives_count = -1;    /* don't know */
        }
    }

    return port->default_keepalives_count;
#else
    return 0;
#endif
}

pq_getkeepalivesidle()

int pq_getkeepalivesidle

(

Port *

port

)

Definition at line 1683 of file pqcomm.c.

References SockAddr::addr, Port::default_keepalives_idle, elog, IS_AF_UNIX, Port::keepalives_idle, Port::laddr, LOG, and Port::sock.

Referenced by pq_setkeepalivesidle(), and show_tcp_keepalives_idle().

{
#if defined(PG_TCP_KEEPALIVE_IDLE) || defined(SIO_KEEPALIVE_VALS)
    if (port == NULL || IS_AF_UNIX(port->laddr.addr.ss_family))
        return 0;

    if (port->keepalives_idle != 0)
        return port->keepalives_idle;

    if (port->default_keepalives_idle == 0)
    {
#ifndef WIN32
        ACCEPT_TYPE_ARG3 size = sizeof(port->default_keepalives_idle);

        if (getsockopt(port->sock, IPPROTO_TCP, PG_TCP_KEEPALIVE_IDLE,
                       (char *) &port->default_keepalives_idle,
                       &size) < 0)
        {
            elog(LOG, "getsockopt(%s) failed: %m", PG_TCP_KEEPALIVE_IDLE_STR);
            port->default_keepalives_idle = -1; /* don't know */
        }
#else                           /* WIN32 */
        /* We can't get the defaults on Windows, so return "don't know" */
        port->default_keepalives_idle = -1;
#endif                          /* WIN32 */
    }

    return port->default_keepalives_idle;
#else
    return 0;
#endif
}

pq_getkeepalivesinterval()

int pq_getkeepalivesinterval

(

Port *

port

)

Definition at line 1765 of file pqcomm.c.

References SockAddr::addr, Port::default_keepalives_interval, elog, IS_AF_UNIX, Port::keepalives_interval, Port::laddr, LOG, and Port::sock.

Referenced by pq_setkeepalivesinterval(), and show_tcp_keepalives_interval().

{
#if defined(TCP_KEEPINTVL) || defined(SIO_KEEPALIVE_VALS)
    if (port == NULL || IS_AF_UNIX(port->laddr.addr.ss_family))
        return 0;

    if (port->keepalives_interval != 0)
        return port->keepalives_interval;

    if (port->default_keepalives_interval == 0)
    {
#ifndef WIN32
        ACCEPT_TYPE_ARG3 size = sizeof(port->default_keepalives_interval);

        if (getsockopt(port->sock, IPPROTO_TCP, TCP_KEEPINTVL,
                       (char *) &port->default_keepalives_interval,
                       &size) < 0)
        {
            elog(LOG, "getsockopt(%s) failed: %m", "TCP_KEEPINTVL");
            port->default_keepalives_interval = -1; /* don't know */
        }
#else
        /* We can't get the defaults on Windows, so return "don't know" */
        port->default_keepalives_interval = -1;
#endif                          /* WIN32 */
    }

    return port->default_keepalives_interval;
#else
    return 0;
#endif
}

pq_gettcpusertimeout()

int pq_gettcpusertimeout

(

Port *

port

)

Definition at line 1918 of file pqcomm.c.

References SockAddr::addr, Port::default_tcp_user_timeout, elog, IS_AF_UNIX, Port::laddr, LOG, Port::sock, and Port::tcp_user_timeout.

Referenced by pq_settcpusertimeout(), and show_tcp_user_timeout().

{
#ifdef TCP_USER_TIMEOUT
    if (port == NULL || IS_AF_UNIX(port->laddr.addr.ss_family))
        return 0;

    if (port->tcp_user_timeout != 0)
        return port->tcp_user_timeout;

    if (port->default_tcp_user_timeout == 0)
    {
        ACCEPT_TYPE_ARG3 size = sizeof(port->default_tcp_user_timeout);

        if (getsockopt(port->sock, IPPROTO_TCP, TCP_USER_TIMEOUT,
                       (char *) &port->default_tcp_user_timeout,
                       &size) < 0)
        {
            elog(LOG, "getsockopt(%s) failed: %m", "TCP_USER_TIMEOUT");
            port->default_tcp_user_timeout = -1;    /* don't know */
        }
    }

    return port->default_tcp_user_timeout;
#else
    return 0;
#endif
}

pq_setkeepalivescount()

int pq_setkeepalivescount	(	int	count,
		Port *	port
	)

Definition at line 1875 of file pqcomm.c.

References SockAddr::addr, Port::default_keepalives_count, elog, IS_AF_UNIX, Port::keepalives_count, Port::laddr, LOG, pq_getkeepalivescount(), Port::sock, STATUS_ERROR, and STATUS_OK.

Referenced by assign_tcp_keepalives_count(), and StreamConnection().

{
    if (port == NULL || IS_AF_UNIX(port->laddr.addr.ss_family))
        return STATUS_OK;

#ifdef TCP_KEEPCNT
    if (count == port->keepalives_count)
        return STATUS_OK;

    if (port->default_keepalives_count <= 0)
    {
        if (pq_getkeepalivescount(port) < 0)
        {
            if (count == 0)
                return STATUS_OK;   /* default is set but unknown */
            else
                return STATUS_ERROR;
        }
    }

    if (count == 0)
        count = port->default_keepalives_count;

    if (setsockopt(port->sock, IPPROTO_TCP, TCP_KEEPCNT,
                   (char *) &count, sizeof(count)) < 0)
    {
        elog(LOG, "setsockopt(%s) failed: %m", "TCP_KEEPCNT");
        return STATUS_ERROR;
    }

    port->keepalives_count = count;
#else
    if (count != 0)
    {
        elog(LOG, "setsockopt(%s) not supported", "TCP_KEEPCNT");
        return STATUS_ERROR;
    }
#endif

    return STATUS_OK;
}

pq_setkeepalivesidle()

int pq_setkeepalivesidle	(	int	idle,
		Port *	port
	)

Definition at line 1717 of file pqcomm.c.

References SockAddr::addr, Port::default_keepalives_idle, elog, IS_AF_UNIX, Port::keepalives_idle, Port::keepalives_interval, Port::laddr, LOG, pq_getkeepalivesidle(), Port::sock, STATUS_ERROR, and STATUS_OK.

Referenced by assign_tcp_keepalives_idle(), and StreamConnection().

{
    if (port == NULL || IS_AF_UNIX(port->laddr.addr.ss_family))
        return STATUS_OK;

/* check SIO_KEEPALIVE_VALS here, not just WIN32, as some toolchains lack it */
#if defined(PG_TCP_KEEPALIVE_IDLE) || defined(SIO_KEEPALIVE_VALS)
    if (idle == port->keepalives_idle)
        return STATUS_OK;

#ifndef WIN32
    if (port->default_keepalives_idle <= 0)
    {
        if (pq_getkeepalivesidle(port) < 0)
        {
            if (idle == 0)
                return STATUS_OK;   /* default is set but unknown */
            else
                return STATUS_ERROR;
        }
    }

    if (idle == 0)
        idle = port->default_keepalives_idle;

    if (setsockopt(port->sock, IPPROTO_TCP, PG_TCP_KEEPALIVE_IDLE,
                   (char *) &idle, sizeof(idle)) < 0)
    {
        elog(LOG, "setsockopt(%s) failed: %m", PG_TCP_KEEPALIVE_IDLE_STR);
        return STATUS_ERROR;
    }

    port->keepalives_idle = idle;
#else                           /* WIN32 */
    return pq_setkeepaliveswin32(port, idle, port->keepalives_interval);
#endif
#else
    if (idle != 0)
    {
        elog(LOG, "setting the keepalive idle time is not supported");
        return STATUS_ERROR;
    }
#endif

    return STATUS_OK;
}

pq_setkeepalivesinterval()

int pq_setkeepalivesinterval	(	int	interval,
		Port *	port
	)

Definition at line 1799 of file pqcomm.c.

References SockAddr::addr, Port::default_keepalives_interval, elog, IS_AF_UNIX, Port::keepalives_idle, Port::keepalives_interval, Port::laddr, LOG, pq_getkeepalivesinterval(), Port::sock, STATUS_ERROR, and STATUS_OK.

Referenced by assign_tcp_keepalives_interval(), and StreamConnection().

{
    if (port == NULL || IS_AF_UNIX(port->laddr.addr.ss_family))
        return STATUS_OK;

#if defined(TCP_KEEPINTVL) || defined(SIO_KEEPALIVE_VALS)
    if (interval == port->keepalives_interval)
        return STATUS_OK;

#ifndef WIN32
    if (port->default_keepalives_interval <= 0)
    {
        if (pq_getkeepalivesinterval(port) < 0)
        {
            if (interval == 0)
                return STATUS_OK;   /* default is set but unknown */
            else
                return STATUS_ERROR;
        }
    }

    if (interval == 0)
        interval = port->default_keepalives_interval;

    if (setsockopt(port->sock, IPPROTO_TCP, TCP_KEEPINTVL,
                   (char *) &interval, sizeof(interval)) < 0)
    {
        elog(LOG, "setsockopt(%s) failed: %m", "TCP_KEEPINTVL");
        return STATUS_ERROR;
    }

    port->keepalives_interval = interval;
#else                           /* WIN32 */
    return pq_setkeepaliveswin32(port, port->keepalives_idle, interval);
#endif
#else
    if (interval != 0)
    {
        elog(LOG, "setsockopt(%s) not supported", "TCP_KEEPINTVL");
        return STATUS_ERROR;
    }
#endif

    return STATUS_OK;
}

pq_settcpusertimeout()

int pq_settcpusertimeout	(	int	timeout,
		Port *	port
	)

Definition at line 1947 of file pqcomm.c.

References SockAddr::addr, Port::default_tcp_user_timeout, elog, IS_AF_UNIX, Port::laddr, LOG, pq_gettcpusertimeout(), Port::sock, STATUS_ERROR, STATUS_OK, and Port::tcp_user_timeout.

Referenced by assign_tcp_user_timeout(), and StreamConnection().

{
    if (port == NULL || IS_AF_UNIX(port->laddr.addr.ss_family))
        return STATUS_OK;

#ifdef TCP_USER_TIMEOUT
    if (timeout == port->tcp_user_timeout)
        return STATUS_OK;

    if (port->default_tcp_user_timeout <= 0)
    {
        if (pq_gettcpusertimeout(port) < 0)
        {
            if (timeout == 0)
                return STATUS_OK;   /* default is set but unknown */
            else
                return STATUS_ERROR;
        }
    }

    if (timeout == 0)
        timeout = port->default_tcp_user_timeout;

    if (setsockopt(port->sock, IPPROTO_TCP, TCP_USER_TIMEOUT,
                   (char *) &timeout, sizeof(timeout)) < 0)
    {
        elog(LOG, "setsockopt(%s) failed: %m", "TCP_USER_TIMEOUT");
        return STATUS_ERROR;
    }

    port->tcp_user_timeout = timeout;
#else
    if (timeout != 0)
    {
        elog(LOG, "setsockopt(%s) not supported", "TCP_USER_TIMEOUT");
        return STATUS_ERROR;
    }
#endif

    return STATUS_OK;
}

Variable Documentation

FrontendProtocol

ProtocolVersion FrontendProtocol

Definition at line 28 of file globals.c.

Referenced by BeginReportingGUCOptions(), CheckSCRAMAuth(), HandleFunctionRequest(), NotifyMyFrontEnd(), NullCommand(), pq_redirect_to_shm_mq(), printtup_startup(), process_postgres_switches(), ProcessStartupPacket(), ReadyForQuery(), ReceiveCopyBegin(), send_message_to_frontend(), SendCopyBegin(), SendFunctionResult(), SendRowDescriptionMessage(), SetRemoteDestReceiverParams(), socket_putmessage(), and SocketBackend().