summaryrefslogtreecommitdiff
path: root/src/net/netcomputer.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/net/netcomputer.h')
-rw-r--r--src/net/netcomputer.h96
1 files changed, 96 insertions, 0 deletions
diff --git a/src/net/netcomputer.h b/src/net/netcomputer.h
new file mode 100644
index 00000000..d3485f64
--- /dev/null
+++ b/src/net/netcomputer.h
@@ -0,0 +1,96 @@
+/*
+ * The Mana Server
+ * Copyright (C) 2004-2010 The Mana World Development Team
+ *
+ * This file is part of The Mana Server.
+ *
+ * The Mana Server 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 2 of the License, or
+ * any later version.
+ *
+ * The Mana Server is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with The Mana Server. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef NETCOMPUTER_H
+#define NETCOMPUTER_H
+
+#include <iostream>
+#include <enet/enet.h>
+
+class MessageOut;
+
+/**
+ * This class represents a known computer on the network. For example a
+ * connected client or a server we're connected to.
+ */
+class NetComputer
+{
+ public:
+ /**
+ * Constructor.
+ */
+ NetComputer(ENetPeer *peer);
+
+ /**
+ * Destructor.
+ */
+ virtual ~NetComputer() {}
+
+ /**
+ * Returns <code>true</code> if this computer is connected.
+ */
+ bool isConnected();
+
+ /**
+ * Disconnects the computer from the server, after sending a message.
+ *
+ * The caller of this method should prepare the message, because
+ * NetComputer does not know which handler is sending it
+ * (could have been chat/game/account)
+ */
+ void disconnect(const MessageOut &msg);
+
+ /**
+ * Queues a message for sending to a client.
+ *
+ * Reliable packets always arrive, if the client stays connected.
+ * Unreliable packets may not arrive, and may not even be sent.
+ *
+ * Channels are used to ensure that unrelated reliable packets do not
+ * hold each other up. In essence, each channel represents a different
+ * queue.
+ *
+ * @param msg The message to be sent.
+ * @param reliable Defines if a reliable or an unreliable packet
+ * should be sent.
+ * @param channel The channel number of which the packet should
+ * be sent.
+ */
+ void send(const MessageOut &msg, bool reliable = true,
+ unsigned int channel = 0);
+
+ /**
+ * Returns IP address of computer in 32bit int form
+ */
+ int getIP() const;
+
+ private:
+ ENetPeer *mPeer; /**< Client peer */
+
+ /**
+ * Converts the ip-address of the peer to a stringstream.
+ * Example:
+ * <code> std::cout << comp </code>
+ */
+ friend std::ostream& operator <<(std::ostream &os,
+ const NetComputer &comp);
+};
+
+#endif // NETCOMPUTER_H