Provide a "has error" property for XCBConnection.

[free-sw/xcb/libxcb] / src / xcb.h

diff --git a/src/xcb.h b/src/xcb.h
index 114f2cf..3d193e1 100644 (file)
--- a/src/xcb.h
+++ b/src/xcb.h
@@ -333,6 +333,21 @@ const XCBSetup *XCBGetSetup(XCBConnection *c);
  */
 int XCBGetFileDescriptor(XCBConnection *c);
 
+/**
+ * @brief Test whether the connection has shut down due to a fatal error.
+ * @param c: The connection.
+ * @return 1 if the connection is in an error state; 0 otherwise.
+ *
+ * Some errors that occur in the context of an XCBConnection
+ * are unrecoverable. When such an error occurs, the
+ * connection is shut down and further operations on the
+ * XCBConnection have no effect.
+ *
+ * @todo Other functions should document the conditions in
+ * which they shut down the connection.
+ */
+int XCBConnectionHasError(XCBConnection *c);
+
 /**
  * @brief Connects to the X server.
  * @param fd: The file descriptor.