/* Minetest Copyright (C) 2010-2014 celeron55, Perttu Ahola This program is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This program 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 Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ #ifndef _CLIENTIFACE_H_ #define _CLIENTIFACE_H_ #include "irr_v3d.h" // for irrlicht datatypes #include "constants.h" #include "serialization.h" // for SER_FMT_VER_INVALID #include "jthread/jmutex.h" #include #include #include #include class MapBlock; class ServerEnvironment; class EmergeManager; /* * State Transitions Start (peer connect) | v /-----------------\ | | | Created | | | \-----------------/ | | +-----------------------------+ invalid playername, password |IN: | or denied by mod | TOSERVER_INIT |------------------------------ +-----------------------------+ | | | | Auth ok | | | +-----------------------------+ | |OUT: | | | TOCLIENT_INIT | | +-----------------------------+ | | | v | /-----------------\ | | | | | InitSent | | | | | \-----------------/ +------------------ | | | +-----------------------------+ +-----------------------------+ | |IN: | |OUT: | | | TOSERVER_INIT2 | | TOCLIENT_ACCESS_DENIED | | +-----------------------------+ +-----------------------------+ | | | | v v | /-----------------\ /-----------------\ | | | | | | | InitDone | | Denied | | | | | | | \-----------------/ \-----------------/ | | | +-----------------------------+ | |OUT: | | | TOCLIENT_MOVEMENT | | | TOCLIENT_ITEMDEF | | | TOCLIENT_NODEDEF | | | TOCLIENT_ANNOUNCE_MEDIA | | | TOCLIENT_DETACHED_INVENTORY | | | TOCLIENT_TIME_OF_DAY | | +-----------------------------+ | | | | | | ----------------------------------- | v | | | /-----------------\ v | | | +-----------------------------+ | | DefinitionsSent | |IN: | | | | | TOSERVER_REQUEST_MEDIA | | \-----------------/ | TOSERVER_RECEIVED_MEDIA | | | +-----------------------------+ | | ^ | | | ----------------------------------- | | | +-----------------------------+ | |IN: | | | TOSERVER_CLIENT_READY | | +-----------------------------+ | | async | v mod action | +-----------------------------+ (ban,kick) | |OUT: | | | TOCLIENT_MOVE_PLAYER | | | TOCLIENT_PRIVILEGES | | | TOCLIENT_INVENTORY_FORMSPEC | | | UpdateCrafting | | | TOCLIENT_INVENTORY | | | TOCLIENT_HP (opt) | | | TOCLIENT_BREATH | | | TOCLIENT_DEATHSCREEN | | +-----------------------------+ | | | v | /-----------------\ | | |------------------------------------------------------ | Active | | |---------------------------------- \-----------------/ timeout | | +-----------------------------+ | |OUT: | | | TOCLIENT_DISCONNECT | | +-----------------------------+ | | | v +-----------------------------+ /-----------------\ |IN: | | | | TOSERVER_DISCONNECT |------------------->| Disconnecting | +-----------------------------+ | | \-----------------/ */ namespace con { class Connection; } #define CI_ARRAYSIZE(a) (sizeof(a) / sizeof((a)[0])) enum ClientState { CS_Invalid, CS_Disconnecting, CS_Denied, CS_Created, CS_InitSent, CS_InitDone, CS_DefinitionsSent, CS_Active }; enum ClientStateEvent { CSE_Init, CSE_GotInit2, CSE_SetDenied, CSE_SetDefinitionsSent, CSE_SetClientReady, CSE_Disconnect }; /* Used for queueing and sorting block transfers in containers Lower priority number means higher priority. */ struct PrioritySortedBlockTransfer { PrioritySortedBlockTransfer(float a_priority, v3s16 a_pos, u16 a_peer_id) { priority = a_priority; pos = a_pos; peer_id = a_peer_id; } bool operator < (const PrioritySortedBlockTransfer &other) const { return priority < other.priority; } float priority; v3s16 pos; u16 peer_id; }; class RemoteClient { public: // peer_id=0 means this client has no associated peer // NOTE: If client is made allowed to exist while peer doesn't, // this has to be set to 0 when there is no peer. // Also, the client must be moved to some other container. u16 peer_id; // The serialization version to use with the client u8 serialization_version; // u16 net_proto_version; RemoteClient(): peer_id(PEER_ID_INEXISTENT), serialization_version(SER_FMT_VER_INVALID), net_proto_version(0), m_time_from_building(9999), m_pending_serialization_version(SER_FMT_VER_INVALID), m_state(CS_Created), m_nearest_unsent_d(0), m_nearest_unsent_reset_timer(0.0), m_excess_gotblocks(0), m_nothing_to_send_pause_timer(0.0), m_name(""), m_version_major(0), m_version_minor(0), m_version_patch(0), m_full_version("unknown"), m_connection_time(getTime(PRECISION_SECONDS)) { } ~RemoteClient() { } /* Finds block that should be sent next to the client. Environment should be locked when this is called. dtime is used for resetting send radius at slow interval */ void GetNextBlocks(ServerEnvironment *env, EmergeManager* emerge, float dtime, std::vector &dest); void GotBlock(v3s16 p); void SentBlock(v3s16 p); void SetBlockNotSent(v3s16 p); void SetBlocksNotSent(std::map &blocks); /** * tell client about this block being modified right now. * this information is required to requeue the block in case it's "on wire" * while modification is processed by server * @param p position of modified block */ void ResendBlockIfOnWire(v3s16 p); s32 SendingCount() { return m_blocks_sending.size(); } // Increments timeouts and removes timed-out blocks from list // NOTE: This doesn't fix the server-not-sending-block bug // because it is related to emerging, not sending. //void RunSendingTimeouts(float dtime, float timeout); void PrintInfo(std::ostream &o) { o<<"RemoteClient "<