message.h

Go to the documentation of this file.

#ifndef _message_h_
#define _message_h_

#include "client.h"

typedef struct MsgDescr_t  MsgDescr;

enum {
    MSG_TYPE_ACK,
    MSG_TYPE_CONN_REQ,
    MSG_TYPE_CONN_DENY,
    MSG_TYPE_CONN_ACCEPT,
    MSG_TYPE_CONN_DISCONN,
    MSG_TYPE_OPTION,
    MSG_TYPE_OBSTACLE,
    MSG_TYPE_SPAWN,
    MSG_TYPE_GOAL,
    MSG_TYPE_GAME_START,
    MSG_TYPE_GAME_OVER,
    MSG_TYPE_SCORE = MSG_TYPE_GOAL + 1,
    MSG_TYPE_PLAYER_UPDATE,
    MSG_TYPE_PLAYER_SPWAN,
    MSG_TYPE_MAX
};

#define MSG_MAX_SIZE  510

struct NetBuffer_t {
    Uint8  data[MSG_MAX_SIZE];
    Sint16 length;
};

typedef struct NetBuffer_t  NetBuffer;

typedef void (*ConstructMsg)(MsgDescr *descr);

/*
 * The simplest message contructor -- writes the message ID to a pre-existing
 * pre-filled buffer. Useful for messages that are constructed in buffers
 * prior to being added to the message system because the message ID is not
 * known until the message is put into the system.
 * @deprecated
 * @pre  The buffer for the message exists and already has message data prior
 *       to calling AddMessage().
 * @post The message ID is written to the buffer starting a byte 1, and the
 *       MsgDescr::constrFunc is set to NULL.
 * @param descr  The message descriptor of the message to modify.
 * @author Jeff Jackowski
 */
//void MsgSetId(MsgDescr *descr);

typedef void (*AcknowledgeMsg)(MsgDescr *descr, int cid);

typedef void (*FailMsg)(MsgDescr *descr, ClientData *client);

void MsgFailDropConnection(MsgDescr *descr, ClientData *client);

void MsgFailDisconnect(MsgDescr *descr, ClientData *client);

typedef Bool (*ApproveSendMsg)(MsgDescr *descr, int cid);

#define DESTMAPTYPE  Uint16

#define DESTMAPLEN  bitarraylen(MAX_PLAYERS, DESTMAPTYPE)

#define GetDestMapIndex(id)  bitindex(id, DESTMAPTYPE)

#define GetDestMapFlag(id)  bitflag(id, DESTMAPTYPE)

#define SetDestToAll(msg) \
{                                                                \
    int loop;                                                    \
    DESTMAPTYPE *map = &((msg)->destMap[0]);                     \
    *map = ~0;                                                   \
    for (loop = DESTMAPLEN - 1; loop > 0; loop--) *(++map) = ~0; \
}
/*
    DESTMAPTYPE *map = &((msg)->destMap[0]);                  \
    for (loop = DESTMAPLEN; loop > 0; loop--) *(map++) = ~0;  \
*/

struct MsgDescr_t {
    /*
     * The function called to construct the message.
     * @warning Either this function pointer must not be NULL, or buffer and
     *          length must already be set and the buffer must contain the
     *          message data. See BufferNew() for the required steps to enter
     *          a pre-made message (this pointer NULL) into the system.
     */
    //ConstructMsg constrFunc;
    AcknowledgeMsg ackFunc;
    FailMsg failFunc;
    ApproveSendMsg approveFunc;
    NetBuffer *buffer;
    void *data;
    DESTMAPTYPE destMap[DESTMAPLEN];
    Uint32 nextSend;
    Uint16 msgId;
    Uint16 interval;
    Sint8 triesLeft;
    union {
        Uint8 flags;
        struct {
            Bool inflight   : 1;
            Bool bcast      : 1;
            Bool mcast      : 1;
            Bool noResend   : 1;
            Bool buffLifeUnmanaged : 1;
            Bool doNotAddId : 1;
        };
    };
};

Bool MessageInit();

void MessageUninit();

MsgDescr *MessageNew();

void MessageFree(MsgDescr *msg);

NetBuffer *BufferNew();

void BufferFree(NetBuffer *buff);

void BufferVecDestr(void *buff);

Bool AddMessage(MsgDescr *msg);

void ServiceMessages();

Bool ReceiveMessages();

void CancelAllMessages();

int  GetNumOutgoingMessages();

typedef Bool (*HandleMsg)(SocketAddr *origin, NetBuffer *buffer,
    Uint8 *clientId, Uint16 messageId);

Bool SendDisconnectMessage(Uint8 id);

Bool ValidateClient(SocketAddr *origin, Uint8 clientId);

Bool ValidateServer(SocketAddr *origin);

void ProcessNetworkMessages();

#endif

---