File: LocalConnection.h

package info (click to toggle)
spring 106.0%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 55,316 kB
  • sloc: cpp: 543,954; ansic: 44,800; python: 12,575; java: 12,201; awk: 5,889; sh: 1,796; asm: 1,546; xml: 655; perl: 405; php: 211; objc: 194; makefile: 76; sed: 2
file content (74 lines) | stat: -rw-r--r-- 2,323 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
/* This file is part of the Spring engine (GPL v2 or later), see LICENSE.html */

#ifndef _LOCAL_CONNECTION_H
#define _LOCAL_CONNECTION_H

#include <deque>
#include "System/Threading/SpringThreading.h"

#include "Connection.h"

namespace netcode {

/**
 * @brief Class for local connection between server / client
 * Directly connects the respective input-buffers, to increase performance.
 * The server and the client have to run in one instance (same process)
 * of spring for this to work.
 * Otherwise, a normal UDP connection had to be used.
 * IMPORTANT: You must not have more than two instances of this.
 */
class CLocalConnection : public CConnection
{
public:
	/**
	 * @brief Constructor
	 * @throw network_error When there already 2 instances
	 */
	CLocalConnection();
	~CLocalConnection();

	// START overriding CConnection

	void SendData(std::shared_ptr<const RawPacket> pkt) override;
	bool HasIncomingData() const override;
	std::shared_ptr<const RawPacket> Peek(unsigned ahead) const override;
	std::shared_ptr<const RawPacket> GetData() override;
	void DeleteBufferPacketAt(unsigned index) override;
	void Flush(const bool forced) override {}
	bool CheckTimeout(int seconds, bool initial) const override { return false; }

	void ReconnectTo(CConnection& conn) override {}
	bool CanReconnect() const override { return false; }
	bool NeedsReconnect() override { return false; }
	void Unmute() override {}
	void Close(bool flush) override;
	void SetLossFactor(int factor) override {}

	unsigned int GetPacketQueueSize() const override;

	std::string Statistics() const override;
	std::string GetFullAddress() const override { return "Localhost"; }

	// END overriding CConnection

private:
	static constexpr unsigned int MAX_INSTANCES = 2;

	static std::deque< std::shared_ptr<const RawPacket> > pktQueues[MAX_INSTANCES];
	static spring::mutex mutexes[MAX_INSTANCES];
	static CLocalConnection* instancePtrs[MAX_INSTANCES];

	unsigned int RemoteInstanceIdx() const { return ((instanceIdx + 1) % MAX_INSTANCES); }

	/// we can have two instances, one in GameServer and one in NetProtocol
	/// (first instance represents server->client and second client->server)
	static unsigned int numInstances;
	/// which instance we are
	unsigned int instanceIdx;
};

} // namespace netcode

#endif // _LOCAL_CONNECTION_H