3 Copyright (C) 2010 celeron55, Perttu Ahola <celeron55@gmail.com>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 #include "connection.h"
26 #include "environment.h"
27 #include "common_irrlicht.h"
31 class ClientNotReadyException : public BaseException
34 ClientNotReadyException(const char *s):
41 class ClientUpdateThread : public SimpleThread
47 ClientUpdateThread(Client *client):
64 IncomingPacket(const IncomingPacket &a)
67 m_datalen = a.m_datalen;
68 m_refcount = a.m_refcount;
69 if(m_refcount != NULL)
72 IncomingPacket(u8 *data, u32 datalen)
74 m_data = new u8[datalen];
75 memcpy(m_data, data, datalen);
77 m_refcount = new s32(1);
81 if(m_refcount != NULL){
82 assert(*m_refcount > 0);
91 /*IncomingPacket & operator=(IncomingPacket a)
94 m_datalen = a.m_datalen;
95 m_refcount = a.m_refcount;
104 class Client : public con::PeerHandler
108 NOTE: Every public method should be thread-safe
111 IrrlichtDevice *device,
112 const char *playername,
113 MapDrawControl &control
118 The name of the local player should already be set when
119 calling this, as it is sent in the initialization.
121 void connect(Address address);
124 m_con.Connected() == true
125 AND m_server_ser_ver != SER_FMT_VER_INVALID
126 throws con::PeerNotFoundException if connection has been deleted,
129 bool connectedAndInitialized();
131 Stuff that references the environment is valid only as
132 long as this is not called. (eg. Players)
133 If this throws a PeerNotFoundException, the connection has
136 void step(float dtime);
138 // Called from updater thread
142 void ProcessData(u8 *data, u32 datasize, u16 sender_peer_id);
143 // Returns true if something was received
144 bool AsyncProcessPacket();
145 bool AsyncProcessData();
146 void Send(u16 channelnum, SharedBuffer<u8> data, bool reliable);
149 bool isFetchingBlocks();
151 // Pops out a packet from the packet queue
152 IncomingPacket getPacket();
154 void groundAction(u8 action, v3s16 nodepos_undersurface,
155 v3s16 nodepos_oversurface, u16 item);
156 void clickObject(u8 button, v3s16 blockpos, s16 id, u16 item);
158 void sendSignText(v3s16 blockpos, s16 id, std::string text);
159 void sendInventoryAction(InventoryAction *a);
160 void sendChatMessage(const std::wstring &message);
163 void removeNode(v3s16 p);
165 void addNode(v3s16 p, MapNode n);
167 void updateCamera(v3f pos, v3f dir);
169 // Returns InvalidPositionException if not found
170 MapNode getNode(v3s16 p);
171 // Returns InvalidPositionException if not found
172 //void setNode(v3s16 p, MapNode n);
174 // Returns InvalidPositionException if not found
175 //f32 getGroundHeight(v2s16 p);
177 v3f getPlayerPosition();
179 void setPlayerControl(PlayerControl &control);
181 // Returns true if the inventory of the local player has been
182 // updated from the server. If it is true, it is set to false.
183 bool getLocalInventoryUpdated();
184 // Copies the inventory of the local player to parameter
185 void getLocalInventory(Inventory &dst);
187 // Gets closest object pointed by the shootline
188 // Returns NULL if not found
189 MapBlockObject * getSelectedObject(
191 v3f from_pos_f_on_map,
192 core::line3d<f32> shootline_on_map
195 // Prints a line or two of info
196 void printDebugInfo(std::ostream &os);
198 //s32 getDayNightIndex();
199 u32 getDayNightRatio();
201 //void updateSomeExpiredMeshes();
203 void setTempMod(v3s16 p, NodeMod mod)
205 JMutexAutoLock envlock(m_env_mutex);
206 assert(m_env.getMap().mapType() == MAPTYPE_CLIENT);
207 v3s16 blockpos = ((ClientMap&)m_env.getMap()).setTempMod(p, mod);
208 m_env.getMap().updateMeshes(blockpos, m_env.getDayNightRatio());
210 void clearTempMod(v3s16 p)
212 JMutexAutoLock envlock(m_env_mutex);
213 assert(m_env.getMap().mapType() == MAPTYPE_CLIENT);
214 v3s16 blockpos = ((ClientMap&)m_env.getMap()).clearTempMod(p);
215 m_env.getMap().updateMeshes(blockpos, m_env.getDayNightRatio());
220 JMutexAutoLock lock(m_con_mutex);
221 con::Peer *peer = m_con.GetPeerNoEx(PEER_ID_SERVER);
224 return peer->avg_rtt;
227 bool getChatMessage(std::wstring &message)
229 if(m_chat_queue.size() == 0)
231 message = m_chat_queue.pop_front();
235 void addChatMessage(const std::wstring &message)
237 JMutexAutoLock envlock(m_env_mutex);
238 LocalPlayer *player = m_env.getLocalPlayer();
239 assert(player != NULL);
240 std::wstring name = narrow_to_wide(player->getName());
241 m_chat_queue.push_back(
242 (std::wstring)L"<"+name+L"> "+message);
247 // Virtual methods from con::PeerHandler
248 void peerAdded(con::Peer *peer);
249 void deletingPeer(con::Peer *peer, bool timeout);
254 void sendPlayerPos();
255 // This sends the player's current name etc to the server
256 void sendPlayerInfo();
258 float m_packetcounter_timer;
259 float m_delete_unused_sectors_timer;
260 float m_connection_reinit_timer;
261 float m_avg_rtt_timer;
262 float m_playerpos_send_timer;
264 ClientUpdateThread m_thread;
266 // NOTE: If connection and environment are both to be locked,
267 // environment shall be locked first.
272 con::Connection m_con;
275 /*core::map<v3s16, float> m_fetchblock_history;
276 JMutex m_fetchblock_mutex;*/
278 core::list<IncomingPacket> m_incoming_queue;
279 JMutex m_incoming_queue_mutex;
281 IrrlichtDevice *m_device;
284 v3f camera_direction;
286 // Server serialization version
290 JMutex m_step_dtime_mutex;
292 // This is behind m_env_mutex.
293 bool m_inventory_updated;
295 core::map<v3s16, bool> m_active_blocks;
297 PacketCounter m_packetcounter;
299 // Received from the server. 0-23999
300 MutexedVariable<u32> m_time_of_day;
302 // 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
304 //u32 m_daynight_ratio;
306 Queue<std::wstring> m_chat_queue;
311 #endif // !CLIENT_HEADER