选择 打开 改范围 完整检索页
受支持版本: 当前版本 (18) / 17 / 16 / 15 / 14
开发版本: 19 / devel
不受支持的版本: 13 / 12 / 11 / 10
当前 PostgreSQL 版本不在支持生命周期内。
您可以参阅当前版本的对应页面,或其他在上面列出的活跃大版本。

33.13. 事件系统 #

libpq的事件系统被设计为通知已注册的事件处理器它感兴趣的libpq事件,例如PGconn以及PGresult对象的创建和毁灭。一种主要的使用情况是这允许应用将自己的数据与一个PGconn或者PGresult关联在一起,并且确保那些数据在适当的时候被释放。

每个注册的事件处理程序都与两个数据相关联,libpq仅将其视为不透明的void *指针。 有一个透传指针,当事件处理程序与PGconn注册时,应用程序提供。 透传指针在PGconn及其生成的所有PGresult的生命周期内永远不会更改; 因此,如果使用,它必须指向长期存在的数据。 此外,还有一个实例数据指针,在每个PGconnPGresult中一开始都是NULL。 可以使用PQinstanceDataPQsetInstanceDataPQresultInstanceDataPQsetResultInstanceData函数来操作此指针。 请注意,与透传指针不同,PGconn的实例数据不会自动继承到从中创建的PGresultlibpq不知道透传和实例数据指针指向的内容(如果有的话),也永远不会尝试释放它们 —— 这是事件处理程序的责任。

33.13.1. 事件类型 #

枚举PGEventId命名了事件系统处理的事件类型。它的所有值的名称都以PGEVT开始。对于每一种事件类型,都有一个相应的事件信息结构体用来承载传递给事件处理器的参数。事件类型是:

PGEVT_REGISTER #

注册事件在PQregisterEventProc被调用时触发。此时最适合初始化事件处理函数可能需要的instanceData。每个连接中的每个事件处理函数只会触发一次注册事件。如果事件处理函数失败,则中止注册。

typedef struct
{
    PGconn *conn;
} PGEventRegister;

收到PGEVT_REGISTER事件时,应将evtInfo指针强制转换为PGEventRegister *。此结构体包含一个PGconn,它应处于CONNECTION_OK状态;如果调用PQregisterEventProc紧接在取得正常的PGconn之后,就能保证这一点。返回失败代码时,必须完成全部清理工作,因为不会发送PGEVT_CONNDESTROY事件。

PGEVT_CONNRESET #

连接重置事件会在完成以下调用时触发:PQresetPQresetPoll。在这两种情况下,只有重置成功才会触发该事件。如果事件处理函数失败,整个连接重置就会失败;PGconn会被置于CONNECTION_BAD状态,并且PQresetPoll将返回PGRES_POLLING_FAILED

typedef struct
{
    PGconn *conn;
} PGEventConnReset;

收到PGEVT_CONNRESET事件时,应将evtInfo指针强制转换为PGEventConnReset *。虽然其中的PGconn刚刚被重置,但所有事件数据都保持不变。应利用此事件重置、重新加载或重新查询相关联的instanceData。注意,即使事件处理函数未能处理PGEVT_CONNRESET,它仍会在连接关闭时收到PGEVT_CONNDESTROY事件。

PGEVT_CONNDESTROY #

连接销毁事件由以下调用触发:PQfinish。事件处理函数负责正确清理其事件数据,因为 libpq 无法管理这部分内存。如果不清理,就会造成内存泄漏。

typedef struct
{
    PGconn *conn;
} PGEventConnDestroy;

收到PGEVT_CONNDESTROY事件时,应将evtInfo指针强制转换为PGEventConnDestroy *。该事件触发于以下函数执行任何其他清理工作之前:PQfinish。事件处理函数的返回值会被忽略,因为无法通过以下函数报告失败:PQfinish。此外,事件处理函数失败不应中止清理不再使用的内存的过程。

PGEVT_RESULTCREATE #

任何生成结果的查询执行函数都会触发结果创建事件,其中包括PQgetResult。只有成功创建结果后才会触发该事件。

typedef struct
{
    PGconn *conn;
    PGresult *result;
} PGEventResultCreate;

收到PGEVT_RESULTCREATE事件时,应将evtInfo指针强制转换为PGEventResultCreate *。其中,conn是用于生成结果的连接。这是初始化需要与结果关联的instanceData的理想位置。如果事件处理函数失败,结果会被清除,失败也会向外传递。事件处理函数不得自行调用PQclear来清除结果对象。返回失败代码时,必须完成所有清理工作,因为不会发送PGEVT_RESULTDESTROY事件。

PGEVT_RESULTCOPY #

结果复制事件会在调用PQcopyResult时触发。只有复制完成后才会触发该事件。只有为源结果成功处理过PGEVT_RESULTCREATEPGEVT_RESULTCOPY事件的事件处理函数,才会收到PGEVT_RESULTCOPY事件。

typedef struct
{
    const PGresult *src;
    PGresult *dest;
} PGEventResultCopy;

收到PGEVT_RESULTCOPY事件时,应将evtInfo指针强制转换为PGEventResultCopy *。其中,src结果是复制源,而dest结果是复制目标。可以利用此事件对instanceData进行深复制,因为PQcopyResult无法完成这项工作。如果事件处理函数失败,整个复制操作就会失败,并且dest结果将被清除。返回失败代码时,必须完成所有清理工作,因为不会为目标结果发送PGEVT_RESULTDESTROY事件。

PGEVT_RESULTDESTROY #

结果销毁事件由以下调用触发:PQclear。事件处理函数负责正确清理其事件数据,因为 libpq 无法管理这部分内存。如果不清理,就会造成内存泄漏。

typedef struct
{
    PGresult *result;
} PGEventResultDestroy;

收到PGEVT_RESULTDESTROY事件时,应将evtInfo指针强制转换为PGEventResultDestroy *。该事件触发于以下函数执行任何其他清理工作之前:PQclear。事件处理函数的返回值会被忽略,因为无法通过以下函数报告失败:PQclear。此外,事件处理函数失败不应中止清理不再使用的内存的过程。

33.13.2. 事件回调函数 #

PGEventProc #

PGEventProc是通过 typedef 定义的事件处理函数指针类型,也就是接收 libpq 事件的用户回调函数的指针类型。事件处理函数的签名必须为

int eventproc(PGEventId evtId, void *evtInfo, void *passThrough)

其中,evtId参数指示发生了哪一种PGEVT事件。必须将evtInfo指针强制转换为适当的结构体类型,以获取关于该事件的更多信息。passThrough参数是在注册事件处理函数时传给以下函数的指针:PQregisterEventProc。函数应在成功时返回非零值,在失败时返回零。

在任何一个PGconn中,一个特定事件过程只能被注册一次。这是因为该过程的地址被用作查找键来标识相关的实例数据。

Caution

在 Windows 上,函数能够有两个不同的地址:一个对 DLL 之外可见而另一个对 DLL 之内可见。我们应当小心只有其中之一会被用于libpq的事件过程函数,否则将会产生混淆。编写代码的最简单规则是将所有的事件过程声明为static。如果过程的地址必须对它自己的源代码文件之外可见,提供一个单独的函数来返回该地址。

33.13.3. 事件支持函数 #

PQregisterEventProc #

为 libpq 注册一个事件回调过程。

int PQregisterEventProc(PGconn *conn, PGEventProc proc,
                        const char *name, void *passThrough);

在每一个你想要接收事件的PGconn上必须注册一个事件过程。和内存不同,没有限制说一个连接上能注册多少个事件过程。如果该函数成功,它会返回一个非零值。如果它失败,则会返回零。

当一个 libpq 事件被触发时,proc参数将被调用。它的内存地址也被用来查找instanceDataname参数被用来在错误消息中引用该事件过程。这个值不能是NULL或一个零长度串。名字串被复制到PGconn中,因此传递进来的东西不需要长期存在。当一个事件发生时,passThrough指针被传递给proc。这个参数可以是NULL

PQsetInstanceData #

设置连接conn的用于过程procinstanceDatadata。它在成功时返回非零值,失败时返回零(只有proc没有被正确地注册在conn中,才可能会失败)。

int PQsetInstanceData(PGconn *conn, PGEventProc proc, void *data);
PQinstanceData #

返回连接conn的与过程proc相关的instanceData,如果没有则返回NULL

void *PQinstanceData(const PGconn *conn, PGEventProc proc);
PQresultSetInstanceData #

将结果的instanceData(针对proc)设置为data。成功时返回非零,失败时返回零。(只有当proc未在结果中正确注册时,才可能失败。)

int PQresultSetInstanceData(PGresult *res, PGEventProc proc, void *data);

请注意,data表示的任何存储都不会计入PQresultMemorySize,除非使用PQresultAlloc分配。 (这样做是值得推荐的,因为它消除了在销毁结果时显式释放此类存储的需要。)

PQresultInstanceData #

返回结果的与过程proc相关的instanceData,如果没有则返回NULL

void *PQresultInstanceData(const PGresult *res, PGEventProc proc);

33.13.4. 事件实例 #

这里是一个管理与 libpq 连接和结果相关的私有数据的示例的框架。


/* required header for libpq events (note: includes libpq-fe.h) */
#include <libpq-events.h>

/* The instanceData */
typedef struct
{
    int n;
    char *str;
} mydata;

/* PGEventProc */
static int myEventProc(PGEventId evtId, void *evtInfo, void *passThrough);

int
main(void)
{
    mydata *data;
    PGresult *res;
    PGconn *conn =
        PQconnectdb("dbname=postgres options=-csearch_path=");

    if (PQstatus(conn) != CONNECTION_OK)
    {
        fprintf(stderr, "Connection to database failed: %s",
                PQerrorMessage(conn));
        PQfinish(conn);
        return 1;
    }

    /* called once on any connection that should receive events.
     * Sends a PGEVT_REGISTER to myEventProc.
     */
    if (!PQregisterEventProc(conn, myEventProc, "mydata_proc", NULL))
    {
        fprintf(stderr, "Cannot register PGEventProc\n");
        PQfinish(conn);
        return 1;
    }

    /* conn instanceData is available */
    data = PQinstanceData(conn, myEventProc);

    /* Sends a PGEVT_RESULTCREATE to myEventProc */
    res = PQexec(conn, "SELECT 1 + 1");

    /* result instanceData is available */
    data = PQresultInstanceData(res, myEventProc);

    /* If PG_COPYRES_EVENTS is used, sends a PGEVT_RESULTCOPY to myEventProc */
    res_copy = PQcopyResult(res, PG_COPYRES_TUPLES | PG_COPYRES_EVENTS);

    /* result instanceData is available if PG_COPYRES_EVENTS was
     * used during the PQcopyResult call.
     */
    data = PQresultInstanceData(res_copy, myEventProc);

    /* Both clears send a PGEVT_RESULTDESTROY to myEventProc */
    PQclear(res);
    PQclear(res_copy);

    /* Sends a PGEVT_CONNDESTROY to myEventProc */
    PQfinish(conn);

    return 0;
}

static int
myEventProc(PGEventId evtId, void *evtInfo, void *passThrough)
{
    switch (evtId)
    {
        case PGEVT_REGISTER:
        {
            PGEventRegister *e = (PGEventRegister *)evtInfo;
            mydata *data = get_mydata(e->conn);

            /* associate app specific data with connection */
            PQsetInstanceData(e->conn, myEventProc, data);
            break;
        }

        case PGEVT_CONNRESET:
        {
            PGEventConnReset *e = (PGEventConnReset *)evtInfo;
            mydata *data = PQinstanceData(e->conn, myEventProc);

            if (data)
              memset(data, 0, sizeof(mydata));
            break;
        }

        case PGEVT_CONNDESTROY:
        {
            PGEventConnDestroy *e = (PGEventConnDestroy *)evtInfo;
            mydata *data = PQinstanceData(e->conn, myEventProc);

            /* free instance data because the conn is being destroyed */
            if (data)
              free_mydata(data);
            break;
        }

        case PGEVT_RESULTCREATE:
        {
            PGEventResultCreate *e = (PGEventResultCreate *)evtInfo;
            mydata *conn_data = PQinstanceData(e->conn, myEventProc);
            mydata *res_data = dup_mydata(conn_data);

            /* associate app specific data with result (copy it from conn) */
            PQsetResultInstanceData(e->result, myEventProc, res_data);
            break;
        }

        case PGEVT_RESULTCOPY:
        {
            PGEventResultCopy *e = (PGEventResultCopy *)evtInfo;
            mydata *src_data = PQresultInstanceData(e->src, myEventProc);
            mydata *dest_data = dup_mydata(src_data);

            /* associate app specific data with result (copy it from a result) */
            PQsetResultInstanceData(e->dest, myEventProc, dest_data);
            break;
        }

        case PGEVT_RESULTDESTROY:
        {
            PGEventResultDestroy *e = (PGEventResultDestroy *)evtInfo;
            mydata *data = PQresultInstanceData(e->result, myEventProc);

            /* free instance data because the result is being destroyed */
            if (data)
              free_mydata(data);
            break;
        }

        /* unknown event ID, just return true. */
        default:
            break;
    }

    return true; /* event processing succeeded */
}