[X2Go-Commits] [libx2goclient] 23/132: src/x2goclient-network-ssh.h: document error enum.

[git-admin at x2go.org]

This is an automated email from the git hooks/post-receive script.

x2go pushed a commit to branch master
in repository libx2goclient.

commit 132ad9e01c0bdd0752a3706ae755e15c2ba2f3bd
Author: Mihai Moldovan <ionic at ionic.de>
Date:   Sat Feb 27 11:17:00 2021 +0100

    src/x2goclient-network-ssh.h: document error enum.
---
 src/x2goclient-network-ssh.h | 64 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 64 insertions(+)

diff --git a/src/x2goclient-network-ssh.h b/src/x2goclient-network-ssh.h
index f3108cb..fc1f7db 100644
--- a/src/x2goclient-network-ssh.h
+++ b/src/x2goclient-network-ssh.h
@@ -52,6 +52,70 @@ X2GoClientNetworkSSH* x2goclient_network_ssh_new (const gchar * const session_pa
  */
 #define X2GOCLIENT_NETWORK_SSH_ERROR g_quark_from_static_string ("x2goclient-network-ssh")
 
+/**
+ * X2GoClientNetworkSSHErrors:
+ * @X2GOCLIENT_NETWORK_SSH_ERROR_PORT_CONV_NOT_NUMERIC: port value to parse
+ *                                                      was not numeric.
+ * @X2GOCLIENT_NETWORK_SSH_ERROR_PORT_CONV_UNDERFLOW: port value to parse too
+ *                                                    small to fit into
+ *                                                    #long long type.
+ * @X2GOCLIENT_NETWORK_SSH_ERROR_PORT_CONV_OVERFLOW: port value to parse too
+ *                                                   big to fit into
+ *                                                   #long long type.
+ * @X2GOCLIENT_NETWORK_SSH_ERROR_PORT_CONV_TOO_BIG: port value to parse was
+ *                                                  bigger than allowed by
+ *                                                  common port specifications
+ *                                                  <constant>
+ *                                                    65535
+ *                                                  </constant>.
+ * @X2GOCLIENT_NETWORK_SSH_ERROR_PORT_CONV_NEGATIVE_ZERO: port value to parse
+ *                                                        was either negative,
+ *                                                        which is not allowed
+ *                                                        by common port
+ *                                                        specifications,
+ *                                                        or zero, which we
+ *                                                        explicitly disallow.
+ * @X2GOCLIENT_NETWORK_SSH_ERROR_IPV6_CONV: error while parsing socket
+ *                                          specification as an IPv6 address.
+ * @X2GOCLIENT_NETWORK_SSH_ERROR_IPV4_CONV: error while parsing socket
+ *                                          specification as an IPv4 address.
+ * @X2GOCLIENT_NETWORK_SSH_ERROR_ALIAS_CONV: error while parsing socket
+ *                                           specification as a FQDN or
+ *                                           OpenSSH client config alias.
+ * @X2GOCLIENT_NETWORK_SSH_ERROR_CONNECT_DIR_CREATE: error while creating
+ *                                                   parent directory for
+ *                                                   control socket.
+ * @X2GOCLIENT_NETWORK_SSH_ERROR_CONNECT_SOCK_ADDR_NULL: socket endpoint
+ *                                                       undefined in connect
+ *                                                       function.
+ * @X2GOCLIENT_NETWORK_SSH_ERROR_CONNECT_INET_ADDR_NULL: IP address undefined
+ *                                                       in connect function.
+ * @X2GOCLIENT_NETWORK_SSH_ERROR_CONNECT_NATIVE_FETCH: error converting data
+ *                                                     from
+ *                                                     #GNativeSocketAddress
+ *                                                     to sockaddr struct in
+ *                                                     connect function.
+ * @X2GOCLIENT_NETWORK_SSH_ERROR_CONNECT_SOCK_ADDR_UNKNOWN: unknown socket
+ *                                                          address type in
+ *                                                          connect function.
+ * @X2GOCLIENT_NETWORK_SSH_ERROR_CONNECT_OPTIONS_INVALID: options structure
+ *                                                        could not be parsed
+ *                                                        into string array in
+ *                                                        connect function.
+ * @X2GOCLIENT_NETWORK_SSH_ERROR_PROC_COMMUNICATE_TRUE_RETVAL_UNAVAILABLE:
+ *                                                        SSH process spawned
+ *                                                        successfully, but
+ *                                                        exit status is not
+ *                                                        available.
+ * @X2GOCLIENT_NETWORK_SSH_ERROR_PROC_RETVAL_NONZERO: SSH process spawned did
+ *                                                    not execute
+ *                                                    successfully.
+ *
+ * Error message types as used within X2GoClientNetworkSSH. May be passed out
+ * via #GError instances.
+ *
+ * Since: 0.0.5
+ */
 enum {
   X2GOCLIENT_NETWORK_SSH_ERROR_PORT_CONV_NOT_NUMERIC = 0,
   X2GOCLIENT_NETWORK_SSH_ERROR_PORT_CONV_UNDERFLOW,

--
Alioth's /home/x2go-admin/maintenancescripts/git/hooks/post-receive-email on /srv/git/code.x2go.org/libx2goclient.git