QPID-4538 - Added shell for an embedded management agent

git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk@1446737 13f79535-47bb-0310-9956-ffa450edef68

3 files changed, 260 insertions, 1 deletions

diff --git a/qpid/extras/nexus/CMakeLists.txt b/qpid/extras/nexus/CMakeLists.txt
index 2f00074f7a..affe292f7d 100644
--- a/qpid/extras/nexus/CMakeLists.txt
+++ b/qpid/extras/nexus/CMakeLists.txt
@@ -63,7 +63,7 @@ set(CATCH_UNDEFINED "-Wl,--no-undefined")
 ## Build the Multi-Threaded Server Library
 ##
 set(server_SOURCES
-#    src/agent.c
+    src/agent.c
     src/alloc.c
     src/auth.c
     src/buffer.c
diff --git a/qpid/extras/nexus/include/qpid/nexus/agent.h b/qpid/extras/nexus/include/qpid/nexus/agent.h
new file mode 100644
index 0000000000..162399f649
--- /dev/null
+++ b/qpid/extras/nexus/include/qpid/nexus/agent.h
@@ -0,0 +1,108 @@
+#ifndef __nexus_agent_h__
+#define __nexus_agent_h__ 1
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ * 
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+#include <stddef.h>
+#include <stdbool.h>
+#include <stdint.h>
+
+/**
+ * \defgroup Container Management Agent
+ * @{
+ */
+
+typedef struct nx_agent_class_t nx_agent_class_t;
+
+
+/**
+ * \brief Get Schema Data Handler
+ *
+ * @param context The handler context supplied in nx_agent_register.
+ */
+typedef void (*nx_agent_schema_cb_t)(void* context);
+
+
+/**
+ * \brief Query Handler
+ *
+ * @param context The handler context supplied in nx_agent_register.
+ * @param id The identifier of the instance being queried or NULL for all instances.
+ * @param correlator The correlation handle to be used in calls to nx_agent_value_*
+ */
+typedef void (*nx_agent_query_cb_t)(void* context, const char *id, const void *correlator);
+
+
+/**
+ * \brief Initialize the agent module and prepare it for operation.
+ *
+ */
+void nx_agent_initialize();
+
+
+/**
+ * \brief Finalize the agent after it has stopped running.
+ */
+void nx_agent_finalize(void);
+
+
+/**
+ * \brief Register a class/object-type with the agent.
+ */
+nx_agent_class_t *nx_agent_register_class(const char           *fqname,
+                                          void                 *context,
+                                          nx_agent_schema_cb_t  schema_handler,
+                                          nx_agent_query_cb_t   query_handler);
+
+/**
+ * \brief Register an event-type with the agent.
+ */
+nx_agent_class_t *nx_agent_register_event(const char           *fqname,
+                                          void                 *context,
+                                          nx_agent_schema_cb_t  schema_handler);
+
+/**
+ *
+ */
+void nx_agent_value_string(const void *correlator, const char *key, const char *value);
+void nx_agent_value_uint(const void *correlator, const char *key, uint64_t value);
+void nx_agent_value_null(const void *correlator, const char *key);
+void nx_agent_value_boolean(const void *correlator, const char *key, bool value);
+void nx_agent_value_binary(const void *correlator, const char *key, const uint8_t *value, size_t len);
+void nx_agent_value_uuid(const void *correlator, const char *key, const uint8_t *value);
+void nx_agent_value_timestamp(const void *correlator, const char *key, uint64_t value);
+
+
+/**
+ *
+ */
+void nx_agent_value_complete(const void *correlator, bool more);
+
+
+/**
+ *
+ */
+void *nx_agent_raise_event(nx_agent_class_t *event);
+
+
+/**
+ * @}
+ */
+
+#endif
diff --git a/qpid/extras/nexus/src/agent.c b/qpid/extras/nexus/src/agent.c
new file mode 100644
index 0000000000..d131cc87dc
--- /dev/null
+++ b/qpid/extras/nexus/src/agent.c
@@ -0,0 +1,151 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ * 
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+#include <qpid/nexus/agent.h>
+#include <qpid/nexus/ctools.h>
+#include <qpid/nexus/hash.h>
+#include <qpid/nexus/container.h>
+#include <qpid/nexus/message.h>
+#include <qpid/nexus/threading.h>
+#include <qpid/nexus/timer.h>
+#include <string.h>
+
+
+typedef struct nx_agent_t {
+    hash_t            *class_hash;
+    nx_message_list_t  in_fifo;
+    nx_message_list_t  out_fifo;
+    sys_mutex_t       *lock;
+    nx_timer_t        *timer;
+} nx_agent_t;
+
+static nx_agent_t *agent = 0;
+
+
+struct nx_agent_class_t {
+    char                 *fqname;
+    void                 *context;
+    nx_agent_schema_cb_t  schema_handler;
+    nx_agent_query_cb_t   query_handler;  // 0 iff class is an event.
+};
+
+
+static void nx_agent_timer_handler(void *context)
+{
+    // TODO - Process the in_fifo here
+}
+
+
+void nx_agent_initialize()
+{
+    assert(!agent);
+    agent = NEW(nx_agent_t);
+    agent->class_hash = hash(6, 10, 1);
+    DEQ_INIT(agent->in_fifo);
+    DEQ_INIT(agent->out_fifo);
+    agent->lock  = sys_mutex();
+    agent->timer = nx_timer(nx_agent_timer_handler, agent);
+}
+
+
+void nx_agent_finalize(void)
+{
+    sys_mutex_free(agent->lock);
+    nx_timer_free(agent->timer);
+    hash_free(agent->class_hash);
+    free(agent);
+    agent = 0;
+}
+
+
+nx_agent_class_t *nx_agent_register_class(const char           *fqname,
+                                          void                 *context,
+                                          nx_agent_schema_cb_t  schema_handler,
+                                          nx_agent_query_cb_t   query_handler)
+{
+    nx_agent_class_t *cls = NEW(nx_agent_class_t);
+    assert(cls);
+    cls->fqname = (char*) malloc(strlen(fqname) + 1);
+    strcpy(cls->fqname, fqname);
+    cls->context        = context;
+    cls->schema_handler = schema_handler;
+    cls->query_handler  = query_handler;
+
+    nx_field_iterator_t *iter = nx_field_iterator_string(fqname, ITER_VIEW_ALL);
+    int result = hash_insert_const(agent->class_hash, iter, cls);
+    nx_field_iterator_free(iter);
+    assert(result >= 0);
+
+    return cls;
+}
+
+
+nx_agent_class_t *nx_agent_register_event(const char           *fqname,
+                                          void                 *context,
+                                          nx_agent_schema_cb_t  schema_handler)
+{
+    return nx_agent_register_class(fqname, context, schema_handler, 0);
+}
+
+
+void nx_agent_value_string(const void *correlator, const char *key, const char *value)
+{
+}
+
+
+void nx_agent_value_uint(const void *correlator, const char *key, uint64_t value)
+{
+}
+
+
+void nx_agent_value_null(const void *correlator, const char *key)
+{
+}
+
+
+void nx_agent_value_boolean(const void *correlator, const char *key, bool value)
+{
+}
+
+
+void nx_agent_value_binary(const void *correlator, const char *key, const uint8_t *value, size_t len)
+{
+}
+
+
+void nx_agent_value_uuid(const void *correlator, const char *key, const uint8_t *value)
+{
+}
+
+
+void nx_agent_value_timestamp(const void *correlator, const char *key, uint64_t value)
+{
+}
+
+
+void nx_agent_value_complete(const void *correlator, bool more)
+{
+}
+
+
+void *nx_agent_raise_event(nx_agent_class_t *event)
+{
+    return 0;
+}
+