libpq 的事件系统旨在向已注册的事件处理程序发出有关有趣的 libpq 事件的通知，如创建或销毁 PGconn 和 PGresult 对象。一种主要用例是，这允许应用程序将自己的数据与 PGconn 或 PGresult 关联起来并确保在适当的时候释放该数据。
每个已注册的事件处理程序都与两条数据关联，libpq 仅将它们识别为不透明的 void * 指针。当事件处理程序使用 PGconn 注册时，应用程序会提供一个 直通 指针。对于 PGconn 的生命周期和所有从其生成 PGresult 的生命周期而言，直通指针始终不变；因此，如果使用，它必须指向长期数据。此外，还有一个 实例数据 指针，其在每个 PGconn 和 PGresult 中都最初为 NULL。此指针可以使用 PQinstanceData、PQsetInstanceData、PQresultInstanceData 和 PQresultSetInstanceData 函数来操作。请注意，与直通指针不同，PGconn 的实例数据不会自动由从中创建的 PGresult 继承。 libpq 不知道直通和实例数据指针指向什么（如果有的话），也绝不会尝试释放它们——这是事件处理程序的责任。
枚举 PGEventId 命名事件系统处理的事件类型。它的所有值均以 PGEVT 开头的名称命名。对于每种事件类型，都有一个相应的事件信息结构来承载传递给事件处理程序的参数。事件类型是
PGEVT_REGISTER #当调用 PQregisterEventProc 时，将发生注册事件。这是初始化事件过程可能需要的任何 instanceData 的理想时间。仅会针对每个事件处理程序和每个连接触发一次注册事件。如果事件过程失败（返回零），则取消注册。
typedef struct
{
PGconn *conn;
} PGEventRegister;
当接收到 PGEVT_REGISTER 事件时，evtInfo 指针应转换为 PGEventRegister *。此结构包含 PGconn，其状态应为 CONNECTION_OK；如果在获得良好的 PGconn 之后立即调用 PQregisterEventProc，则保证这一点。返回失败代码时，必须执行所有清理工作，因为不会发送 PGEVT_CONNDESTROY 事件。
PGEVT_CONNRESET #连接重置事件在完成 PQreset 或 PQresetPoll 时触发。在这两种情况下，仅在重置成功时才触发事件。在 PostgreSQL v15 及更高版本中将忽略事件过程的返回值。但是，对于较早版本来说，返回成功（非零）非常重要，否则将中止连接。
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 的理想位置。如果事件过程失败（返回零），则在结果的剩余生命周期内将忽略该事件过程；也就是说，它不会为此结果或从此结果复制的结果接收 PGEVT_RESULTCOPY 或 PGEVT_RESULTDESTROY 事件。
PGEVT_RESULTCOPY #结果复制事件作为对 PQcopyResult 的响应而触发。此事件仅在复制完成后触发。只有成功处理源结果的 PGEVT_RESULTCREATE 或 PGEVT_RESULTCOPY 事件的事件过程才会收到 PGEVT_RESULTCOPY 事件。
typedef struct
{
const PGresult *src;
PGresult *dest;
} PGEventResultCopy;
接收到 PGEVT_RESULTCOPY 事件时，应将 evtInfo 指针强制转换为 PGEventResultCopy *。src 结果是被复制的内容，而 dest 结果是复制的目标。此事件可用于提供 instanceData 的深度副本，因为 PQcopyResult 无法执行此操作。如果事件过程失败（返回零），则在结果的剩余生命周期内将忽略该事件过程；也就是说，它不会为此结果或从此结果复制的结果接收 PGEVT_RESULTCOPY 或 PGEVT_RESULTDESTROY 事件。
PGEVT_RESULTDESTROY #结果销毁事件作为对 PQclear 的响应而触发。由事件过程负责正确清理其事件数据，因为 libpq 无法管理此内存。未清理干净会导致内存泄漏。
typedef struct
{
PGresult *result;
} PGEventResultDestroy;
收到 PGEVT_RESULTDESTROY 事件时，应将 evtInfo 指针转换为 PGEventResultDestroy *。在 PQclear 执行任何其他清理工作之前触发此事件。忽略事件过程的返回值，因为没有办法指示 PQclear 出现故障。此外，事件过程故障不应中止清理不需要内存的过程。
PGEventProc #PGEventProc 是指向事件过程（即从 libpq 接收事件的用户回调函数）的指针的一个类型，事件过程的签名必须为
int eventproc(PGEventId evtId, void *evtInfo, void *passThrough)
evtId 参数指示发生哪个 PGEVT 事件。evtInfo 指针必须转换为相应的结构类型以获取有关此事件的详细信息。passThrough 参数是指针在 PQregisterEventProc 注册事件过程时提供的。如果函数成功，则返回一个非零值，如果函数失败，则返回零。
特定事件过程只能在任何 PGconn 中注册一次。这是因为过程的地址用作查找密钥，用于标识关联的实例数据。
在 Windows 上，函数可以有两个不同的地址：一个在 DLL 外部可见，另一个在 DLL 内部可见。应小心，只能将其中一个地址与 libpq 的事件过程函数一起使用，否则将会产生混淆。编写可正常工作的代码的最简单规则是确保将事件过程声明为 static。如果过程的地址必须在其自身源文件外部可用，请公开一个单独的函数以返回该地址。
PQregisterEventProc #向 libpq 注册事件回调过程。
int PQregisterEventProc(PGconn *conn, PGEventProc proc,
const char *name, void *passThrough);
需要在每个您要接收有关其事件的 PGconn 上注册一次事件过程。对可以向连接注册的事件过程数量没有限制（内存除外）。如果成功，该函数返回一个非零值，如果失败，则返回零。
当 libpq 事件触发时，会调用 proc 参数。其内存地址还用于查找 instanceData。 name 参数用于在错误消息中参考事件过程。此值不能为 NULL 或一个零长度字符串。名称字符串被复制到 PGconn，因此传递的内容不必是长期存在的。每次发生事件时，都会将 passThrough 指针传递给 proc。此参数可以为 NULL。
PQsetInstanceData #为过程 proc 将连接 conn 的 instanceData 设置为 data。它返回非零表示成功，返回零表示失败。（仅当 proc 未在 conn 中正确注册时才可能失败。）
int PQsetInstanceData(PGconn *conn, PGEventProc proc, void *data);
PQinstanceData #返回与过程 proc 关联的连接 conn 的 instanceData，如果没有该数据，则返回 NULL。
void *PQinstanceData(const PGconn *conn, PGEventProc proc);
PQresultSetInstanceData #为 proc 将结果的 instanceData 设置为 data。它返回非零表示成功，返回零表示失败。（仅当 proc 未在结果中正确注册时才可能失败。）
int PQresultSetInstanceData(PGresult *res, PGEventProc proc, void *data);
请注意，由 data 表示的任何存储都将不计入 PQresultMemorySize，除非使用 PQresultAlloc 进行分配。（这样做是推荐的做法，因为它消除了在结果被销毁时显式释放此类存储的需要。）
PQresultInstanceData #返回与 proc 关联的结果的 instanceData，如果没有该数据，则返回 NULL。
void *PQresultInstanceData(const PGresult *res, PGEventProc proc);
以下是与 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)
{
/* PQerrorMessage's result includes a trailing newline */
fprintf(stderr, "%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) */
PQresultSetInstanceData(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) */
PQresultSetInstanceData(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 */
}