tentacle.h

Go to the documentation of this file.

// Copyright 2017 Space HAUC Command and Data Handling
// This file is part of octopOS which is released under AGPLv3.
// See file LICENSE.txt or go to <http://www.gnu.org/licenses/> for full
// license details.

#ifndef INCLUDE_TENTACLE_H_
#define INCLUDE_TENTACLE_H_

#include <string.h>
#include <sys/types.h>
#include <sys/time.h>
#include <time.h>
#include <unistd.h>

#include <exception>
#include <iostream>
#include <cstdlib>
#include <string>
#include <utility>
#include <mutex>                                                                  // NOLINT

#include "utility.h"                                                              // NOLINT

class tentacle {
    friend class octopOS;

 private:
    static std::mutex id_lock;

    static void initRand(ushort* rand_seed);

 protected:
    static int message_que;

    static intptr_t* shared_data;

    enum role_t {SUBSCRIBER, PUBLISHER };  // PROTECT ME SQUIRE

    static long getTempId(role_t role);                                           // NOLINT

 public:
    explicit tentacle(key_t msg_key);

    static std::pair<long, std::string> read(long type, bool block = true,        // NOLINT
                                      bool under = false);

    bool write(long type, std::string data);                                      // NOLINT

    bool write(std::pair<long, std::string> pair);                                // NOLINT
};

// Size-invariant string data type for publishing
class OctoString {
 private:
    char buf[MSGLEN - 1];

 public:
    OctoString() {}
    explicit OctoString(const std::string &value) {
        if (value.size() > (MSGLEN - 2)) {
            throw std::range_error("Given string is too large to publish.");
        }
        strcpy(buf, value.c_str());  // NOLINT - complains about strcpy?
    }
    OctoString& operator=(const std::string &other) {
        strcpy(buf, other.c_str());  // NOLINT - complains about strcpy?
        return *this;
    }
    OctoString& operator=(const OctoString &other) {
        strcpy(buf, other.buf);  // NOLINT - complains about strcpy?
        return *this;
    }
    std::string get() {
        return std::string(buf);
    }

    operator std::string() {
        return std::string(buf);
    }
};

#endif  // INCLUDE_TENTACLE_H_