summaryrefslogtreecommitdiff
path: root/mblock/src/lib/mb_port.h
diff options
context:
space:
mode:
Diffstat (limited to 'mblock/src/lib/mb_port.h')
-rw-r--r--mblock/src/lib/mb_port.h83
1 files changed, 83 insertions, 0 deletions
diff --git a/mblock/src/lib/mb_port.h b/mblock/src/lib/mb_port.h
new file mode 100644
index 000000000..35ac34e2c
--- /dev/null
+++ b/mblock/src/lib/mb_port.h
@@ -0,0 +1,83 @@
+/* -*- c++ -*- */
+/*
+ * Copyright 2006 Free Software Foundation, Inc.
+ *
+ * This file is part of GNU Radio
+ *
+ * GNU Radio is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2, or (at your option)
+ * any later version.
+ *
+ * GNU Radio 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+#ifndef INCLUDED_MB_PORT_H
+#define INCLUDED_MB_PORT_H
+
+#include <mb_common.h>
+
+/*!
+ * \brief Public port characteristics
+ */
+class mb_port : boost::noncopyable
+{
+public:
+
+ //! port classification
+ enum port_type_t {
+ EXTERNAL, //< Externally visible
+ RELAY, //< Externally visible but really connected to a sub-component
+ INTERNAL //< Visible to self only
+ };
+
+private:
+ friend class mb_mblock_impl;
+
+ mb_port_detail_sptr d_detail;
+ std::string d_port_name;
+ pmt_t d_protocol_class;
+ bool d_conjugated;
+ port_type_t d_port_type;
+
+ // private constructor
+ mb_port(const std::string &port_name,
+ const std::string &protocol_class_name,
+ bool conjugated,
+ mb_port::port_type_t port_type);
+
+
+public:
+ std::string port_name() const { return d_port_name; }
+ pmt_t protocol_class() const { return d_protocol_class; }
+ bool conjugated() const { return d_conjugated; }
+ port_type_t port_type() const { return d_port_type; }
+
+ pmt_t incoming_message_set() const;
+ pmt_t outgoing_message_set() const;
+
+ ~mb_port();
+
+ /*!
+ * \brief send a message
+ *
+ * \param signal the event name
+ * \param data optional data
+ * \param metadata optional metadata
+ * \param priority the urgency at which the message is sent
+ */
+ void
+ send(pmt_t signal,
+ pmt_t data = PMT_NIL,
+ pmt_t metadata = PMT_NIL,
+ mb_pri_t priority = MB_PRI_DEFAULT);
+
+};
+
+#endif /* INCLUDED_MB_PORT_H */