issue-1774: Function to retrieve info about client connections was added

Author: testisnullus

session.go

@@ -780,6 +780,86 @@ func (s *Session) MapExecuteBatchCAS(batch *Batch, dest map[string]interface{})
 	return applied, iter, iter.err
 }
 
+// connectionType is a custom type that represents the different stages
+// of a client connection in a Cassandra cluster. It is used to filter and categorize
+// connections based on their current state.
+type connectionType string
+
+const (
+	Ready      connectionType = "ready"
+	Connecting connectionType = "connecting"
+	Idle       connectionType = "idle"
+	Closed     connectionType = "closed"
+	Failed     connectionType = "failed"
+)
+
+// ClientConnection represents a client connection to a Cassandra node. It holds detailed
+// information about the connection, including the client address, connection stage, driver details,
+// and various configuration options.
+type ClientConnection struct {
+	Address         string  `json:"address"`
+	Port            int     `json:"port"`
+	ConnectionStage string  `json:"connection_stage"`
+	DriverName      string  `json:"driver_name"`
+	DriverVersion   string  `json:"driver_version"`
+	Hostname        string  `json:"hostname"`
+	KeyspaceName    *string `json:"keyspace_name"`
+	ProtocolVersion int     `json:"protocol_version"`
+	RequestCount    int     `json:"request_count"`
+	SSLCipherSuite  *string `json:"ssl_cipher_suite"`
+	SSLEnabled      bool    `json:"ssl_enabled"`
+	SSLProtocol     *string `json:"ssl_protocol"`
+	Username        string  `json:"username"`
+}
+
+// RetrieveClientConnections retrieves a list of client connections from the
+// `system_views.clients` table based on the specified connection type. The function
+// queries the Cassandra database for connections with a given `connection_stage` and
+// scans the results into a slice of `ClientConnection` structs. It handles nullable
+// fields and returns the list of connections or an error if the operation fails.
+func (s *Session) RetrieveClientConnections(connectionType connectionType) ([]*ClientConnection, error) {
+	query := "SELECT address, port, connection_stage, driver_name, driver_version, hostname, keyspace_name, protocol_version, request_count, ssl_cipher_suite, ssl_enabled, ssl_protocol, username FROM system_views.clients WHERE connection_stage = ?"
+	iter := s.Query(query, connectionType).Iter()
+
+	var connections []*ClientConnection
+	// Variables to hold nullable fields
+	var keyspaceName, sslCipherSuite, sslProtocol *string
+
+	for {
+		conn := &ClientConnection{}
+		if !iter.Scan(
+			&conn.Address,
+			&conn.Port,
+			&conn.ConnectionStage,
+			&conn.DriverName,
+			&conn.DriverVersion,
+			&conn.Hostname,
+			&keyspaceName,
+			&conn.ProtocolVersion,
+			&conn.RequestCount,
+			&sslCipherSuite,
+			&conn.SSLEnabled,
+			&sslProtocol,
+			&conn.Username,
+		) {
+			break
+		}
+
+		conn.KeyspaceName = keyspaceName
+		conn.SSLCipherSuite = sslCipherSuite
+		conn.SSLProtocol = sslProtocol
+
+		connections = append(connections, conn)
+	}
+
+	err := iter.Close()
+	if err != nil {
+		return connections, err
+	}
+
+	return connections, nil
+}
+
 type hostMetrics struct {
 	// Attempts is count of how many times this query has been attempted for this host.
 	// An attempt is either a retry or fetching next page of results.