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);
148 // Pops out a packet from the packet queue
149 IncomingPacket getPacket();
151 void groundAction(u8 action, v3s16 nodepos_undersurface,
152 v3s16 nodepos_oversurface, u16 item);
153 void clickObject(u8 button, v3s16 blockpos, s16 id, u16 item);
155 void sendSignText(v3s16 blockpos, s16 id, std::string text);
156 void sendInventoryAction(InventoryAction *a);
157 void sendChatMessage(const std::wstring &message);
160 void removeNode(v3s16 p);
162 void addNode(v3s16 p, MapNode n);
164 void updateCamera(v3f pos, v3f dir);
166 // Returns InvalidPositionException if not found
167 MapNode getNode(v3s16 p);
168 // Returns InvalidPositionException if not found
169 //void setNode(v3s16 p, MapNode n);
171 // Returns InvalidPositionException if not found
172 //f32 getGroundHeight(v2s16 p);
174 v3f getPlayerPosition();
176 void setPlayerControl(PlayerControl &control);
178 // Returns true if the inventory of the local player has been
179 // updated from the server. If it is true, it is set to false.
180 bool getLocalInventoryUpdated();
181 // Copies the inventory of the local player to parameter
182 void getLocalInventory(Inventory &dst);
184 // Gets closest object pointed by the shootline
185 // Returns NULL if not found
186 MapBlockObject * getSelectedObject(
188 v3f from_pos_f_on_map,
189 core::line3d<f32> shootline_on_map
192 // Prints a line or two of info
193 void printDebugInfo(std::ostream &os);
195 //s32 getDayNightIndex();
196 u32 getDayNightRatio();
198 //void updateSomeExpiredMeshes();
200 void setTempMod(v3s16 p, NodeMod mod)
202 JMutexAutoLock envlock(m_env_mutex);
203 assert(m_env.getMap().mapType() == MAPTYPE_CLIENT);
204 v3s16 blockpos = ((ClientMap&)m_env.getMap()).setTempMod(p, mod);
205 m_env.getMap().updateMeshes(blockpos, m_env.getDayNightRatio());
207 void clearTempMod(v3s16 p)
209 JMutexAutoLock envlock(m_env_mutex);
210 assert(m_env.getMap().mapType() == MAPTYPE_CLIENT);
211 v3s16 blockpos = ((ClientMap&)m_env.getMap()).clearTempMod(p);
212 m_env.getMap().updateMeshes(blockpos, m_env.getDayNightRatio());
217 JMutexAutoLock lock(m_con_mutex);
218 con::Peer *peer = m_con.GetPeerNoEx(PEER_ID_SERVER);
221 return peer->avg_rtt;
224 bool getChatMessage(std::wstring &message)
226 if(m_chat_queue.size() == 0)
228 message = m_chat_queue.pop_front();
232 void addChatMessage(const std::wstring &message)
234 JMutexAutoLock envlock(m_env_mutex);
235 LocalPlayer *player = m_env.getLocalPlayer();
236 assert(player != NULL);
237 std::wstring name = narrow_to_wide(player->getName());
238 m_chat_queue.push_back(
239 (std::wstring)L"<"+name+L"> "+message);
244 // Virtual methods from con::PeerHandler
245 void peerAdded(con::Peer *peer);
246 void deletingPeer(con::Peer *peer, bool timeout);
251 void sendPlayerPos();
252 // This sends the player's current name etc to the server
253 void sendPlayerInfo();
255 float m_packetcounter_timer;
256 float m_delete_unused_sectors_timer;
257 float m_connection_reinit_timer;
258 float m_avg_rtt_timer;
259 float m_playerpos_send_timer;
261 ClientUpdateThread m_thread;
263 // NOTE: If connection and environment are both to be locked,
264 // environment shall be locked first.
269 con::Connection m_con;
272 /*core::map<v3s16, float> m_fetchblock_history;
273 JMutex m_fetchblock_mutex;*/
275 core::list<IncomingPacket> m_incoming_queue;
276 JMutex m_incoming_queue_mutex;
278 IrrlichtDevice *m_device;
281 v3f camera_direction;
283 // Server serialization version
287 JMutex m_step_dtime_mutex;
289 // This is behind m_env_mutex.
290 bool m_inventory_updated;
292 core::map<v3s16, bool> m_active_blocks;
294 PacketCounter m_packetcounter;
296 // Received from the server. 0-23999
297 MutexedVariable<u32> m_time_of_day;
299 // 0 <= m_daynight_i < DAYNIGHT_CACHE_COUNT
301 //u32 m_daynight_ratio;
303 Queue<std::wstring> m_chat_queue;
308 #endif // !CLIENT_HEADER