XPSession.h

/* START_LICENSE_HEADER

Copyright (C) 2000 Martin Piper, original design and program code
Copyright (C) 2001 Replica Software

This program file is copyright (C) Replica Software and can only be used under license.
For more information visit: http://www.replicanet.com/
Or email: info@replicanet.com

END_LICENSE_HEADER */
#ifndef __XPSESSION_H__
#define __XPSESSION_H__
#include "RNPlatform/Inc/DLLExportAPI.h"

#define _XPSESSION_VERSION 5900
// All DLL versions with the same major version are compatible
#define _XPSESSION_DLLVERSIONMAJOR 16
#define _XPSESSION_DLLVERSIONMINOR 0

#include <string>

#include "RNXPURL/Inc/Transport.h"

namespace RNReplicaNet
{

const int kXPSessionUnknownID = -1;
const int kXPSessionBroadcastID = -2;

/* These are the internal message types for session messages */
const unsigned char kXPSessionPacketType_Unreliable     = 0;
const unsigned char kXPSessionPacketType_Reliable       = (1<<0);
const unsigned char kXPSessionPacketType_Certain        = (1<<1);

class XPSESSIONDLL_API XPSession
{
public:

    enum Error
    {
        kXPSession_EOK = 0,                     
        kXPSession_EERROR = -1,                 
        kXPSession_ETRANSPORT_CLOSED = -2,
        kXPSession_ETRANSPORT_ERROR = -3
    };

    XPSession() {};

    virtual ~XPSession() {};

    static XPSession *Allocate(void);

    virtual void Create(const std::string name) = 0;

    virtual void Create(const std::string name,const std::string protocols) = 0;

    virtual std::string ExportURL(const bool shortAddress = true) = 0;

    virtual void Join(const std::string url) = 0;

    virtual void Find(void) = 0;

    virtual void Find(const std::string protocols) = 0;

    virtual std::string EnumerateFound(void) = 0;

    virtual int GetGameChannel(void) = 0;

    virtual void SetGameChannel(const int channel = TransportAnyGameChannel) = 0;

    virtual int GetSessionID(void) = 0;

    virtual bool IsStable(void) = 0;

    virtual Error GetStatus(void) = 0;

    virtual Error GetSessionErrorReason(void) = 0;

    virtual void DataSendToSession(const int sessionid,const char *data,const int length,const bool reliable = true,const bool certain = false,const unsigned int band = 0) = 0;

    virtual void DataSendToSessionUnreliable(const int sessionid,const char *data,const int length) = 0;

    virtual void DataSendToSessionReliable(const int sessionid,const char *data,const int length,const unsigned int band = 0) = 0;

    virtual void DataSendToSessionCertain(const int sessionid,const char *data,const int length) = 0;

    virtual bool DataReceivePeek(int *const fromsessionid,int *const length,unsigned char *const type = 0) = 0;

    virtual bool DataReceive(int *const fromsessionid,char *const data,int *const length,unsigned char *const type = 0) = 0;

    virtual bool IsMaster(void) = 0;

    virtual int GetJoiner(void) = 0;

    virtual int GetLeaver(void) = 0;

    virtual float GetTime(void) = 0;

    virtual float GetLocalTime(void) = 0;

    virtual float GetNetworkSendRate(void) = 0;

    virtual float GetNetworkReceiveRate(void) = 0;

    virtual int GetNetworkPacketsLost(void) = 0;

    virtual void Poll(void) = 0;

    virtual void SetPollLayerBelow(bool enable = true) = 0;

    virtual bool GetPollLayerBelow(void) = 0;

    virtual void SetManualPoll(void) = 0;

    virtual void SetAutomaticPoll(void) = 0;

    virtual void SetManualPollXPURL(void) = 0;

    virtual void SetAutomaticPollXPURL(void) = 0;


    virtual void SetCanSpider(const bool canSpider = true) = 0;

    virtual bool GetCanSpider(void) = 0;

    virtual void SetCanBecomeMaster(const bool canBeMaster = true) = 0;

    virtual bool GetCanBecomeMaster(void) = 0;

    virtual float GetLatencyToMasterSession(void) = 0;

    virtual float GetLatencyToSessionID(const int sessionID) = 0;

    virtual void SetLatencyRecalculationDelay(const float seconds = 1.0f) = 0;

    virtual void SetEncryption(const bool enable = false) = 0;

    virtual bool GetEncryption(void) = 0;


    virtual void Disconnect(const int sessionID = kXPSessionUnknownID) = 0;

    virtual bool GetPreConnectStatus(void) = 0;

    virtual void SetPreConnect(const bool enable = false) = 0;

    virtual bool GetPreConnect(void) = 0;

    virtual void PreConnectHasFinished(void) = 0;

    virtual void SetAutomaticPacketCompression(const bool enable = false) = 0;

    virtual bool GetAutomaticPacketCompression(void) = 0;

    virtual void GetCompressionStatistics(int *const before=0,int *const after=0,const bool reset = false) = 0;

    virtual void GetMergedStatistics(int *const sent=0,int *const received=0,const bool reset = false) = 0;

    virtual int GetMasterSessionID(void) = 0;

    virtual std::string GetURLFromSessionID(const int sessionID) = 0;

    virtual void SetClientOnly(const bool isClient = false) = 0;

    virtual bool GetClientOnly(void) = 0;

    virtual bool GetBandwidthFromSessionID(const int sessionID,Transport::Bandwidth *const bandwidth,int *const output,int *const input) = 0;

    virtual void SetAllowConnections(const bool allow = true) = 0;

    virtual bool GetAllowConnections(void) = 0;

    virtual void SetNodeBuffers(const bool enable = false) = 0;

    virtual bool GetNodeBuffers(void) = 0;

private:
};

} // namespace RNReplicaNet

#endif

---