summaryrefslogtreecommitdiff
path: root/psycopg/replication_cursor.h
diff options
context:
space:
mode:
authorOleksandr Shulgin <oleksandr.shulgin@zalando.de>2015-10-19 20:00:39 +0200
committerOleksandr Shulgin <oleksandr.shulgin@zalando.de>2015-10-19 20:00:39 +0200
commit0bb81fc84811134bca70b59daa4661bd0697f2ff (patch)
tree4b66a805179645ffd6fbad36a8cc442e6b384602 /psycopg/replication_cursor.h
parent7aea2cef6e42c961fadac61f19b570bdf8c61401 (diff)
downloadpsycopg2-0bb81fc84811134bca70b59daa4661bd0697f2ff.tar.gz
Properly subclass ReplicationCursor on C level.
Diffstat (limited to 'psycopg/replication_cursor.h')
-rw-r--r--psycopg/replication_cursor.h77
1 files changed, 77 insertions, 0 deletions
diff --git a/psycopg/replication_cursor.h b/psycopg/replication_cursor.h
new file mode 100644
index 0000000..1b6dbfa
--- /dev/null
+++ b/psycopg/replication_cursor.h
@@ -0,0 +1,77 @@
+/* replication_cursor.h - definition for the psycopg replication cursor type
+ *
+ * Copyright (C) 2015 Daniele Varrazzo <daniele.varrazzo@gmail.com>
+ *
+ * This file is part of psycopg.
+ *
+ * psycopg2 is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * In addition, as a special exception, the copyright holders give
+ * permission to link this program with the OpenSSL library (or with
+ * modified versions of OpenSSL that use the same license as OpenSSL),
+ * and distribute linked combinations including the two.
+ *
+ * You must obey the GNU Lesser General Public License in all respects for
+ * all of the code used other than OpenSSL.
+ *
+ * psycopg2 is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
+ * License for more details.
+ */
+
+#ifndef PSYCOPG_REPLICATION_CURSOR_H
+#define PSYCOPG_REPLICATION_CURSOR_H 1
+
+#include "psycopg/cursor.h"
+#include "libpq_support.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+extern HIDDEN PyTypeObject replicationCursorType;
+
+typedef struct replicationCursorObject {
+ cursorObject cur;
+
+ int started:1; /* if replication is started */
+ int consuming:1; /* if running the consume loop */
+
+ struct timeval last_io; /* timestamp of the last exchange with the server */
+ struct timeval keepalive_interval; /* interval for keepalive messages in replication mode */
+
+ XLogRecPtr write_lsn; /* LSN stats for replication feedback messages */
+ XLogRecPtr flush_lsn;
+ XLogRecPtr apply_lsn;
+ int feedback_pending; /* flag set when we couldn't send the feedback to the server */
+} replicationCursorObject;
+
+
+RAISES_NEG int psyco_repl_curs_datetime_init(void);
+
+/* exception-raising macros */
+#define EXC_IF_REPLICATING(self, cmd) \
+do \
+ if ((self)->started) { \
+ PyErr_SetString(ProgrammingError, \
+ #cmd " cannot be used when replication is already in progress"); \
+ return NULL; } \
+while (0)
+
+#define EXC_IF_NOT_REPLICATING(self, cmd) \
+do \
+ if (!(self)->started) { \
+ PyErr_SetString(ProgrammingError, \
+ #cmd " cannot be used when replication is not in progress"); \
+ return NULL; } \
+while (0)
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* !defined(PSYCOPG_REPLICATION_CURSOR_H) */