UltraGrid/src/messaging.h

#ifndef _MESSAGING_H
#define _MESSAGING_H

#ifdef HAVE_CONFIG_H
#include "config.h"
#include "config_unix.h"
#include "config_win32.h"
#endif

#include "types.h"

#ifdef __cplusplus
extern "C" {
#endif

struct messaging;
struct module;
struct response;

#define RESPONSE_OK           200
#define RESPONSE_ACCEPTED     202
#define RESPONSE_NO_CONTENT   204
#define RESPONSE_BAD_REQUEST  400
#define RESPONSE_NOT_FOUND    404
#define RESPONSE_REQ_TIMEOUT  408
#define RESPONSE_INT_SERV_ERR 500
#define RESPONSE_NOT_IMPL     501

struct message;

struct message {
        /**
         * Individual message types may have defined custom data deleters.
         * Please note that the deleter must not delete the struct itself.
         */
        void (*data_deleter)(struct message *);

        // following members are used internally and should not be touched anyhow
        // except from messaging.cpp
        void (*send_response)(void *priv_data, struct response *);
        void *priv_data;
};

enum msg_sender_type {
        SENDER_MSG_CHANGE_RECEIVER,
        SENDER_MSG_CHANGE_PORT,
        SENDER_MSG_PLAY,
        SENDER_MSG_PAUSE,
        SENDER_MSG_CHANGE_FEC,
        SENDER_MSG_QUERY_VIDEO_MODE,
        SENDER_MSG_RESET_SSRC,
};

struct msg_sender {
        struct message m;
        enum msg_sender_type type;
        union {
                int port;
                char receiver[128];
                char fec_cfg[1024];
        };
};

enum msg_receiver_type {
        RECEIVER_MSG_CHANGE_RX_PORT,
        RECEIVER_MSG_VIDEO_PROP_CHANGED,
        RECEIVER_MSG_INCREASE_VOLUME,
        RECEIVER_MSG_DECREASE_VOLUME,
        RECEIVER_MSG_MUTE,
};
struct msg_receiver {
        struct message m;
        enum msg_receiver_type type;
        union {
                uint16_t new_rx_port;
                struct video_desc new_desc;
        };
};

struct msg_change_fec_data {
        struct message m;
        enum tx_media_type media_type;
        char fec[128];
};

enum compress_change_type {
        CHANGE_COMPRESS,
        CHANGE_PARAMS
};

struct msg_change_compress_data {
        struct message m;
        enum compress_change_type what;
        char config_string[128];
};

struct msg_stats {
        struct message m;
        char what[128];
        int value;
};

struct msg_universal {
        struct message m;
        char text[8192];
};

struct response *new_response(int status, const char *optional_message);
void free_response(struct response *r);
int response_get_status(struct response *r);
const char *response_get_text(struct response *r);

void module_check_undelivered_messages(struct module *);
struct response *send_message(struct module *, const char *path, struct message *msg) __attribute__ ((warn_unused_result));
struct response *send_message_sync(struct module *, const char *path, struct message *msg, int timeout_ms) __attribute__ ((warn_unused_result));
struct response *send_message_to_receiver(struct module *, struct message *msg) __attribute__ ((warn_unused_result));
struct message *new_message(size_t length) __attribute__ ((warn_unused_result));
void free_message(struct message *m, struct response *r);
const char *response_status_to_text(int status);

struct message *check_message(struct module *);

#ifdef __cplusplus
}
#endif

#endif// _MESSAGING_H