mirror of
https://github.com/electronicarts/CnC_Remastered_Collection
synced 2024-04-26 08:22:17 +12:00
03416d24e1
Initial commit of original Tiberian Dawn and Red Alert source code converted to build as DLLs, and compatible with the release version of Command & Conquer Remastered.
191 lines
8.8 KiB
C++
191 lines
8.8 KiB
C++
//
|
|
// Copyright 2020 Electronic Arts Inc.
|
|
//
|
|
// TiberianDawn.DLL and RedAlert.dll and corresponding source code 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.
|
|
|
|
// TiberianDawn.DLL and RedAlert.dll and corresponding source code is distributed
|
|
// in the hope that it will be useful, but with permitted additional restrictions
|
|
// under Section 7 of the GPL. See the GNU General Public License in LICENSE.TXT
|
|
// distributed with this program. You should have received a copy of the
|
|
// GNU General Public License along with permitted additional restrictions
|
|
// with this program. If not, see https://github.com/electronicarts/CnC_Remastered_Collection
|
|
|
|
/* $Header: F:\projects\c&c0\vcs\code\comqueue.h_v 4.1 11 Apr 1996 18:26:02 JOE_BOSTIC $ */
|
|
/***************************************************************************
|
|
** C O N F I D E N T I A L --- W E S T W O O D S T U D I O S **
|
|
***************************************************************************
|
|
* *
|
|
* Project Name : Command & Conquer *
|
|
* *
|
|
* File Name : COMQUEUE.H *
|
|
* *
|
|
* Programmer : Bill Randolph *
|
|
* *
|
|
* Start Date : December 19, 1994 *
|
|
* *
|
|
* Last Update : April 1, 1995 [BR] *
|
|
* *
|
|
*-------------------------------------------------------------------------*
|
|
* *
|
|
* This class's job is to queue up outgoing messages & incoming messages, *
|
|
* and serves as a storage area for various flags for ACK & Retry logic. *
|
|
* It allows the application to keep track of how many messages have *
|
|
* passed through this queue, in & out, so packets can use this as a *
|
|
* unique ID. (If packets have a unique ID, the application can use this *
|
|
* to detect re-sends.) *
|
|
* *
|
|
* The queues act as FIFO buffers (First-In, First-Out). The first entry *
|
|
* placed in a queue is the first one read from it, and so on. The *
|
|
* controlling application must ensure it places the entries on the queue *
|
|
* in the order it wants to access them. *
|
|
* *
|
|
* The queue is implemented as an array of Queue Entries. Index 0 is the *
|
|
* first element placed on the queue, and is the first retrieved. Index *
|
|
* 1 is the next, and so on. When Index 0 is retrieved, the next-available*
|
|
* entry becomes Index 1. The array is circular; when the end is reached, *
|
|
* the indices wrap around to the beginning. *
|
|
* *
|
|
* The class also contains routines to maintain a cumulative response time *
|
|
* for this queue. It's up to the caller to call Add_Delay() whenever *
|
|
* it detects that an outgoing message has been ACK'd; this class adds *
|
|
* that delay into a computed average delay over the last few message *
|
|
* delays. *
|
|
* *
|
|
* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
|
|
|
|
#ifndef COMQUEUE_H
|
|
#define COMQUEUE_H
|
|
|
|
|
|
|
|
/*---------------------------------------------------------------------------
|
|
This is one output queue entry
|
|
---------------------------------------------------------------------------*/
|
|
typedef struct {
|
|
unsigned int IsActive : 1; // 1 = this entry is ready to be processed
|
|
unsigned int IsACK : 1; // 1 = ACK received for this packet
|
|
unsigned long FirstTime; // time this packet was first sent
|
|
unsigned long LastTime; // time this packet was last sent
|
|
unsigned long SendCount; // # of times this packet has been sent
|
|
int BufLen; // size of the packet stored in this entry
|
|
char *Buffer; // the data packet
|
|
} SendQueueType;
|
|
|
|
/*---------------------------------------------------------------------------
|
|
This is one input queue entry
|
|
---------------------------------------------------------------------------*/
|
|
typedef struct {
|
|
unsigned int IsActive : 1; // 1 = this entry is ready to be processed
|
|
unsigned int IsRead : 1; // 1 = caller has read this entry
|
|
unsigned int IsACK : 1; // 1 = ACK sent for this packet
|
|
int BufLen; // size of the packet stored in this entry
|
|
char *Buffer; // the data packet
|
|
} ReceiveQueueType;
|
|
|
|
/*
|
|
***************************** Class Declaration *****************************
|
|
*/
|
|
class CommQueueClass
|
|
{
|
|
/*
|
|
---------------------------- Public Interface ----------------------------
|
|
*/
|
|
public:
|
|
/*
|
|
....................... Constructor/Destructor ........................
|
|
*/
|
|
CommQueueClass(int numsend, int numrecieve, int maxlen);
|
|
virtual ~CommQueueClass();
|
|
void Init(void);
|
|
|
|
/*
|
|
......................... Send Queue routines .........................
|
|
*/
|
|
int Queue_Send(void *buf, int buflen); // add to Send queue
|
|
int UnQueue_Send(void *buf, int *buflen); // remove from Send queue
|
|
SendQueueType * Next_Send(void); // ptr to next avail entry
|
|
int Num_Send(void) {return (SendCount);} // # entries in queue
|
|
int Max_Send(void) { return (MaxSend);} // max # send queue entries
|
|
SendQueueType * Get_Send(int index); // random access to queue
|
|
unsigned long Send_Total(void) {return (SendTotal);}
|
|
|
|
/*
|
|
....................... Receive Queue routines ........................
|
|
*/
|
|
int Queue_Receive(void *buf, int buflen); // add to Receive queue
|
|
int UnQueue_Receive(void *buf, int *buflen); // remove from Receive queue
|
|
ReceiveQueueType * Next_Receive(void); // ptr to next avail entry
|
|
int Num_Receive(void) {return (ReceiveCount);} // # entries in queue
|
|
int Max_Receive(void) { return (MaxReceive); } // max # recv queue entries
|
|
ReceiveQueueType * Get_Receive(int index); // random access to queue
|
|
unsigned long Receive_Total(void) {return (ReceiveTotal);}
|
|
|
|
/*
|
|
....................... Response time routines ........................
|
|
*/
|
|
void Add_Delay(unsigned long delay); // accumulates response time
|
|
unsigned long Avg_Response_Time(void); // gets mean response time
|
|
unsigned long Max_Response_Time(void); // gets max response time
|
|
void Reset_Response_Time(void); // resets computations
|
|
|
|
/*
|
|
........................ Debug output routines ........................
|
|
*/
|
|
void Configure_Debug(int offset, int size, char **names, int maxnames);
|
|
void Mono_Debug_Print(int refresh = 0);
|
|
void Mono_Debug_Print2(int refresh = 0);
|
|
|
|
/*
|
|
--------------------------- Private Interface ----------------------------
|
|
*/
|
|
private:
|
|
/*
|
|
.......................... Limiting variables .........................
|
|
*/
|
|
int MaxSend; // max # send queue entries
|
|
int MaxReceive; // max # receive queue entries
|
|
int MaxPacketSize; // max size of a packet, in bytes
|
|
|
|
/*
|
|
....................... Response time variables .......................
|
|
*/
|
|
unsigned long DelaySum; // sum of last 4 delay times
|
|
unsigned long NumDelay; // current # delay times summed
|
|
unsigned long MeanDelay; // current average delay time
|
|
unsigned long MaxDelay; // max delay ever for this queue
|
|
|
|
/*
|
|
........................ Send Queue variables .........................
|
|
*/
|
|
SendQueueType * SendQueue; // incoming packets
|
|
int SendCount; // # packets in the queue
|
|
int SendNext; // next entry read from queue
|
|
int SendEmpty; // next empty spot in queue
|
|
unsigned long SendTotal; // total # added to send queue
|
|
|
|
/*
|
|
....................... Receive Queue variables .......................
|
|
*/
|
|
ReceiveQueueType * ReceiveQueue; // outgoing packets
|
|
int ReceiveCount; // # packets in the queue
|
|
int ReceiveNext; // next entry read from queue
|
|
int ReceiveEmpty; // next empty spot in queue
|
|
unsigned long ReceiveTotal; // total # added to receive queue
|
|
|
|
/*
|
|
......................... Debugging Variables .........................
|
|
*/
|
|
int DebugOffset; // offset into app's packet for ID
|
|
int DebugSize; // size of app's ID
|
|
char **DebugNames; // ptr to array of app-specific names
|
|
int DebugMaxNames; // max # of names in array
|
|
};
|
|
|
|
#endif
|
|
|
|
/*************************** end of comqueue.h *****************************/
|
|
|