path: root/include/salticidae/msg.h

/**
 * Copyright (c) 2018 Cornell University.
 *
 * Author: Ted Yin <tederminant@gmail.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 * of the Software, and to permit persons to whom the Software is furnished to do
 * so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#ifndef _SALTICIDAE_MSG_H
#define _SALTICIDAE_MSG_H

#include <cstdint>
#include <cstring>
#include <string>
#include <vector>

#include "salticidae/type.h"
#include "salticidae/stream.h"
#include "salticidae/netaddr.h"

namespace salticidae {

template<typename OpcodeType>
class MsgBase {
    public:
    using opcode_t = OpcodeType;
    static const size_t header_size;

    private:
    /* header */
    /* all integers are encoded in little endian in the protocol */
    uint32_t magic;
    opcode_t opcode;
    uint32_t length;
#ifndef SALTICIDAE_NOCHECKSUM
    uint32_t checksum;
#endif

    mutable bytearray_t payload;
    mutable bool no_payload;

    public:
    MsgBase(): magic(0x0), no_payload(true) {}

    template<typename MsgType,
            typename = typename std::enable_if<
                !std::is_same<MsgType, MsgBase>::value &&
                !std::is_same<MsgType, uint8_t *>::value>::type>
    MsgBase(const MsgType &msg): magic(0x0) {
        set_opcode(MsgType::opcode);
        set_payload(std::move(msg.serialized));
    }

    MsgBase(const MsgBase &other):
            magic(other.magic),
            opcode(other.opcode),
            length(other.length),
#ifndef SALTICIDAE_NOCHECKSUM
            checksum(other.checksum),
#endif
            payload(other.payload),
            no_payload(other.no_payload) {}

    MsgBase(MsgBase &&other):
            magic(other.magic),
            opcode(std::move(other.opcode)),
            length(other.length),
#ifndef SALTICIDAE_NOCHECKSUM
            checksum(other.checksum),
#endif
            payload(std::move(other.payload)),
            no_payload(other.no_payload) {}

    MsgBase(const uint8_t *raw_header): no_payload(true) {
        uint32_t _magic;
        opcode_t _opcode;
        uint32_t _length;
#ifndef SALTICIDAE_NOCHECKSUM
        uint32_t _checksum;
#endif
        DataStream s(raw_header, raw_header + MsgBase::header_size);

        s >> _magic
          >> _opcode
          >> _length
#ifndef SALTICIDAE_NOCHECKSUM
          >> _checksum
#endif
          ;
        magic = letoh(_magic);
        opcode = _opcode;