3 Copyright (C) 2010-2014 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 Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser 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.
19 #ifndef _CLIENTIFACE_H_
20 #define _CLIENTIFACE_H_
22 #include "irr_v3d.h" // for irrlicht datatypes
24 #include "constants.h"
25 #include "serialization.h" // for SER_FMT_VER_INVALID
26 #include "jthread/jmutex.h"
27 #include "network/networkpacket.h"
35 class ServerEnvironment;
52 +-----------------------------+ invalid playername, password
53 |IN: | or denied by mod
54 | TOSERVER_INIT |------------------------------
55 +-----------------------------+ |
59 +-----------------------------+ |
62 +-----------------------------+ |
69 \-----------------/ +------------------
71 +-----------------------------+ +-----------------------------+ |
73 | TOSERVER_INIT2 | | TOCLIENT_ACCESS_DENIED | |
74 +-----------------------------+ +-----------------------------+ |
77 /-----------------\ /-----------------\ |
79 | InitDone | | Denied | |
81 \-----------------/ \-----------------/ |
83 +-----------------------------+ |
85 | TOCLIENT_MOVEMENT | |
86 | TOCLIENT_ITEMDEF | |
87 | TOCLIENT_NODEDEF | |
88 | TOCLIENT_ANNOUNCE_MEDIA | |
89 | TOCLIENT_DETACHED_INVENTORY | |
90 | TOCLIENT_TIME_OF_DAY | |
91 +-----------------------------+ |
94 | ----------------------------------- |
96 /-----------------\ v |
97 | | +-----------------------------+ |
98 | DefinitionsSent | |IN: | |
99 | | | TOSERVER_REQUEST_MEDIA | |
100 \-----------------/ | TOSERVER_RECEIVED_MEDIA | |
101 | +-----------------------------+ |
103 | ----------------------------------- |
105 +-----------------------------+ |
107 | TOSERVER_CLIENT_READY | |
108 +-----------------------------+ |
111 +-----------------------------+ (ban,kick) |
113 | TOCLIENT_MOVE_PLAYER | |
114 | TOCLIENT_PRIVILEGES | |
115 | TOCLIENT_INVENTORY_FORMSPEC | |
117 | TOCLIENT_INVENTORY | |
118 | TOCLIENT_HP (opt) | |
119 | TOCLIENT_BREATH | |
120 | TOCLIENT_DEATHSCREEN | |
121 +-----------------------------+ |
124 /-----------------\ |
125 | |------------------------------------------------------
127 | |----------------------------------
128 \-----------------/ timeout |
129 | +-----------------------------+
131 | | TOCLIENT_DISCONNECT |
132 | +-----------------------------+
135 +-----------------------------+ /-----------------\
137 | TOSERVER_DISCONNECT |------------------->| Disconnecting |
138 +-----------------------------+ | |
145 #define CI_ARRAYSIZE(a) (sizeof(a) / sizeof((a)[0]))
159 enum ClientStateEvent
164 CSE_SetDefinitionsSent,
170 Used for queueing and sorting block transfers in containers
172 Lower priority number means higher priority.
174 struct PrioritySortedBlockTransfer
176 PrioritySortedBlockTransfer(float a_priority, v3s16 a_pos, u16 a_peer_id)
178 priority = a_priority;
182 bool operator < (const PrioritySortedBlockTransfer &other) const
184 return priority < other.priority;
194 // peer_id=0 means this client has no associated peer
195 // NOTE: If client is made allowed to exist while peer doesn't,
196 // this has to be set to 0 when there is no peer.
197 // Also, the client must be moved to some other container.
199 // The serialization version to use with the client
200 u8 serialization_version;
202 u16 net_proto_version;
205 peer_id(PEER_ID_INEXISTENT),
206 serialization_version(SER_FMT_VER_INVALID),
207 net_proto_version(0),
208 m_time_from_building(9999),
209 m_pending_serialization_version(SER_FMT_VER_INVALID),
211 m_nearest_unsent_d(0),
212 m_nearest_unsent_reset_timer(0.0),
213 m_excess_gotblocks(0),
214 m_nothing_to_send_pause_timer(0.0),
219 m_full_version("unknown"),
220 m_connection_time(getTime(PRECISION_SECONDS))
228 Finds block that should be sent next to the client.
229 Environment should be locked when this is called.
230 dtime is used for resetting send radius at slow interval
232 void GetNextBlocks(ServerEnvironment *env, EmergeManager* emerge,
233 float dtime, std::vector<PrioritySortedBlockTransfer> &dest);
235 void GotBlock(v3s16 p);
237 void SentBlock(v3s16 p);
239 void SetBlockNotSent(v3s16 p);
240 void SetBlocksNotSent(std::map<v3s16, MapBlock*> &blocks);
243 * tell client about this block being modified right now.
244 * this information is required to requeue the block in case it's "on wire"
245 * while modification is processed by server
246 * @param p position of modified block
248 void ResendBlockIfOnWire(v3s16 p);
252 return m_blocks_sending.size();
255 // Increments timeouts and removes timed-out blocks from list
256 // NOTE: This doesn't fix the server-not-sending-block bug
257 // because it is related to emerging, not sending.
258 //void RunSendingTimeouts(float dtime, float timeout);
260 void PrintInfo(std::ostream &o)
262 o<<"RemoteClient "<<peer_id<<": "
263 <<"m_blocks_sent.size()="<<m_blocks_sent.size()
264 <<", m_blocks_sending.size()="<<m_blocks_sending.size()
265 <<", m_nearest_unsent_d="<<m_nearest_unsent_d
266 <<", m_excess_gotblocks="<<m_excess_gotblocks
268 m_excess_gotblocks = 0;
271 // Time from last placing or removing blocks
272 float m_time_from_building;
275 List of active objects that the client knows of.
278 std::set<u16> m_known_objects;
280 ClientState getState()
283 std::string getName()
286 void setName(std::string name)
289 /* update internal client state */
290 void notifyEvent(ClientStateEvent event);
292 /* set expected serialization version */
293 void setPendingSerializationVersion(u8 version)
294 { m_pending_serialization_version = version; }
296 void confirmSerializationVersion()
297 { serialization_version = m_pending_serialization_version; }
303 /* set version information */
304 void setVersionInfo(u8 major, u8 minor, u8 patch, std::string full) {
305 m_version_major = major;
306 m_version_minor = minor;
307 m_version_patch = patch;
308 m_full_version = full;
311 /* read version information */
312 u8 getMajor() { return m_version_major; }
313 u8 getMinor() { return m_version_minor; }
314 u8 getPatch() { return m_version_patch; }
315 std::string getVersion() { return m_full_version; }
317 // Version is stored in here after INIT before INIT2
318 u8 m_pending_serialization_version;
320 /* current state of client */
324 Blocks that have been sent to client.
325 - These don't have to be sent again.
326 - A block is cleared from here when client says it has
327 deleted it from it's memory
329 Key is position, value is dummy.
330 No MapBlock* is stored here because the blocks can get deleted.
332 std::set<v3s16> m_blocks_sent;
333 s16 m_nearest_unsent_d;
335 float m_nearest_unsent_reset_timer;
338 Blocks that are currently on the line.
339 This is used for throttling the sending of blocks.
340 - The size of this list is limited to some value
341 Block is added when it is sent with BLOCKDATA.
342 Block is removed when GOTBLOCKS is received.
343 Value is time from sending. (not used at the moment)
345 std::map<v3s16, float> m_blocks_sending;
348 Count of excess GotBlocks().
349 There is an excess amount because the client sometimes
350 gets a block so late that the server sends it again,
351 and the client then sends two GOTBLOCKs.
352 This is resetted by PrintInfo()
354 u32 m_excess_gotblocks;
356 // CPU usage optimization
357 float m_nothing_to_send_pause_timer;
360 name of player using this client
371 std::string m_full_version;
374 time this client was created
376 const u32 m_connection_time;
379 class ClientInterface {
384 ClientInterface(con::Connection* con);
388 void step(float dtime);
390 /* get list of active client id's */
391 std::vector<u16> getClientIDs(ClientState min_state=CS_Active);
393 /* get list of client player names */
394 std::vector<std::string> getPlayerNames();
396 /* send message to client */
397 void send(u16 peer_id, u8 channelnum, NetworkPacket* pkt, bool reliable, bool deletepkt=true);
399 /* send to all clients */
400 void sendToAll(u16 channelnum, NetworkPacket* pkt, bool reliable);
402 /* delete a client */
403 void DeleteClient(u16 peer_id);
406 void CreateClient(u16 peer_id);
408 /* get a client by peer_id */
409 RemoteClient* getClientNoEx(u16 peer_id, ClientState state_min=CS_Active);
411 /* get client by peer_id (make sure you have list lock before!*/
412 RemoteClient* lockedGetClientNoEx(u16 peer_id, ClientState state_min=CS_Active);
414 /* get state of client by id*/
415 ClientState getClientState(u16 peer_id);
417 /* set client playername */
418 void setPlayerName(u16 peer_id,std::string name);
420 /* get protocol version of client */
421 u16 getProtocolVersion(u16 peer_id);
423 /* set client version */
424 void setClientVersion(u16 peer_id, u8 major, u8 minor, u8 patch, std::string full);
426 /* event to update client state */
427 void event(u16 peer_id, ClientStateEvent event);
429 /* set environment */
430 void setEnv(ServerEnvironment* env)
431 { assert(m_env == 0); m_env = env; }
433 static std::string state2Name(ClientState state);
436 //TODO find way to avoid this functions
438 { m_clients_mutex.Lock(); }
440 { m_clients_mutex.Unlock(); }
442 std::map<u16, RemoteClient*>& getClientList()
443 { return m_clients; }
446 /* update internal player list */
447 void UpdatePlayerList();
450 con::Connection* m_con;
451 JMutex m_clients_mutex;
452 // Connected clients (behind the con mutex)
453 std::map<u16, RemoteClient*> m_clients;
454 std::vector<std::string> m_clients_names; //for announcing masterserver
457 ServerEnvironment *m_env;
460 float m_print_info_timer;
462 static const char *statenames[];