PostgreSQL Source Code  git master
async.h
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * async.h
4  * Asynchronous notification: NOTIFY, LISTEN, UNLISTEN
5  *
6  * Portions Copyright (c) 1996-2023, PostgreSQL Global Development Group
7  * Portions Copyright (c) 1994, Regents of the University of California
8  *
9  * src/include/commands/async.h
10  *
11  *-------------------------------------------------------------------------
12  */
13 #ifndef ASYNC_H
14 #define ASYNC_H
15 
16 #include <signal.h>
17 
18 /*
19  * The number of SLRU page buffers we use for the notification queue.
20  */
21 #define NUM_NOTIFY_BUFFERS 8
22 
23 extern PGDLLIMPORT bool Trace_notify;
24 extern PGDLLIMPORT volatile sig_atomic_t notifyInterruptPending;
25 
26 extern Size AsyncShmemSize(void);
27 extern void AsyncShmemInit(void);
28 
29 extern void NotifyMyFrontEnd(const char *channel,
30  const char *payload,
31  int32 srcPid);
32 
33 /* notify-related SQL statements */
34 extern void Async_Notify(const char *channel, const char *payload);
35 extern void Async_Listen(const char *channel);
36 extern void Async_Unlisten(const char *channel);
37 extern void Async_UnlistenAll(void);
38 
39 /* perform (or cancel) outbound notify processing at transaction commit */
40 extern void PreCommit_Notify(void);
41 extern void AtCommit_Notify(void);
42 extern void AtAbort_Notify(void);
43 extern void AtSubCommit_Notify(void);
44 extern void AtSubAbort_Notify(void);
45 extern void AtPrepare_Notify(void);
46 
47 /* signal handler for inbound notifies (PROCSIG_NOTIFY_INTERRUPT) */
48 extern void HandleNotifyInterrupt(void);
49 
50 /* process interrupts */
51 extern void ProcessNotifyInterrupt(bool flush);
52 
53 #endif /* ASYNC_H */
HandleNotifyInterrupt
void HandleNotifyInterrupt(void)
Definition: async.c:1853
Trace_notify
PGDLLIMPORT bool Trace_notify
Definition: async.c:443
Async_UnlistenAll
void Async_UnlistenAll(void)
Definition: async.c:804
NotifyMyFrontEnd
void NotifyMyFrontEnd(const char *channel, const char *payload, int32 srcPid)
Definition: async.c:2278
AtCommit_Notify
void AtCommit_Notify(void)
Definition: async.c:1002
ProcessNotifyInterrupt
void ProcessNotifyInterrupt(bool flush)
Definition: async.c:1883
notifyInterruptPending
PGDLLIMPORT volatile sig_atomic_t notifyInterruptPending
Definition: async.c:431
AtAbort_Notify
void AtAbort_Notify(void)
Definition: async.c:1720
PreCommit_Notify
void PreCommit_Notify(void)
Definition: async.c:895
AsyncShmemSize
Size AsyncShmemSize(void)
Definition: async.c:516
Async_Unlisten
void Async_Unlisten(const char *channel)
Definition: async.c:786
Async_Listen
void Async_Listen(const char *channel)
Definition: async.c:772
AtSubAbort_Notify
void AtSubAbort_Notify(void)
Definition: async.c:1810
AtPrepare_Notify
void AtPrepare_Notify(void)
Definition: async.c:870
AtSubCommit_Notify
void AtSubCommit_Notify(void)
Definition: async.c:1740
AsyncShmemInit
void AsyncShmemInit(void)
Definition: async.c:533
Async_Notify
void Async_Notify(const char *channel, const char *payload)
Definition: async.c:625
PGDLLIMPORT
#define PGDLLIMPORT
Definition: c.h:1321
int32
signed int int32
Definition: c.h:478
Size
size_t Size
Definition: c.h:589