msu_type.h

Go to the documentation of this file.

/*
START OF LICENSE STUB
    DeDOS: Declarative Dispersion-Oriented Software
    Copyright (C) 2017 University of Pennsylvania, Georgetown University

    This program 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 3 of the License, or
    (at your option) any later version.

    This program 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, see <http://www.gnu.org/licenses/>.
END OF LICENSE STUB
*/
#ifndef MSU_TYPE_H
#define MSU_TYPE_H
#include "routing.h"
#include "ctrl_runtime_messages.h"

#include <stdint.h>

// Need forward declarations due to circular dependency
struct local_msu;
struct msu_msg;
struct msu_msg_hdr;
struct msu_type;

typedef ssize_t (*serialization_fn)(struct msu_type *, struct msu_msg *, void **output);
typedef void *(*deserialization_fn)(struct local_msu *self, size_t input_size, void *input,
                                    size_t *out_size);

struct msu_type{
    char *name;

    unsigned int id;

    int (*init_type)(struct msu_type *type);

    void (*destroy_type)(struct msu_type *type);

    int (*init)(struct local_msu *self, struct msu_init_data *initial_data);

    void (*destroy)(struct local_msu *self);

    int (*receive)(struct local_msu *self, struct msu_msg *msg);

    int (*receive_error)(struct local_msu *self, struct msu_msg *msg);

    int (*route)(struct msu_type *type, struct local_msu *sender,
                 struct msu_msg *msg, struct msu_endpoint *output);

    serialization_fn serialize;

    serialization_fn serialize_error;

    deserialization_fn deserialize;

    deserialization_fn deserialize_error;
};

void destroy_msu_types();

int init_msu_type_id(unsigned int type_id);

struct msu_type *get_msu_type(int id);

#endif // MSS_TYPE_H