# HG changeset patch # User Tero Marttila # Date 1233003827 -7200 # Node ID c6d7272a164b20306be32d8bfd0c37aaf4e09dc2 # Parent 74e562e16399018058e8a78fba1631c5b7125998 rework Network send() code to use NetworkTarget/Node/Group::send classes, add a NetworkMessage class for sending NetworkObject messages, and fix a bug whereby the server's client TCP sockets weren't nonblocking.... I wonder how this has worked before?\! diff -r 74e562e16399 -r c6d7272a164b src/Engine.cc --- a/src/Engine.cc Mon Jan 26 19:52:52 2009 +0200 +++ b/src/Engine.cc Mon Jan 26 23:03:47 2009 +0200 @@ -144,7 +144,7 @@ GameState& Engine::onNetworkClientConnected (Terrain *terrain) { // sanity-check - assert(!terrain && !game_state && graphics); + assert(!this->terrain && !game_state && graphics); // setup the game setupGame(terrain); diff -r 74e562e16399 -r c6d7272a164b src/Network/Channel.hh --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/Network/Channel.hh Mon Jan 26 23:03:47 2009 +0200 @@ -0,0 +1,15 @@ +#ifndef NETWORK_CHANNEL_HH +#define NETWORK_CHANNEL_HH + +#include "../Types.hh" + +/** + * A NetworkSession puts each packet onto a specific channel, which can the be used to run multiple different modules + * on top of a single session. + * + * NetworkChannelID zero is reserved for internal NetworkSession use + */ +typedef uint16_t NetworkChannelID; + + +#endif /* NETWORK_CHANNEL_HH */ diff -r 74e562e16399 -r c6d7272a164b src/Network/Client.cc --- a/src/Network/Client.cc Mon Jan 26 19:52:52 2009 +0200 +++ b/src/Network/Client.cc Mon Jan 26 23:03:47 2009 +0200 @@ -5,6 +5,9 @@ #include "../Engine.hh" #include "../Logger.hh" +// XXX: move +#include "Message.hh" + #include /* @@ -66,13 +69,13 @@ Engine::log(INFO, "net.client") << "Got game data, creating player"; // create our new NetworkClient object - client = new NetworkClient(engine, gs, netsession, server); + client = new NetworkClient(engine, gs, netsession, *server); } /* * NetworkClient */ -NetworkClient::NetworkClient (Engine &engine, GameState &state, NetworkSession &netsession, NetworkNode *server) : +NetworkClient::NetworkClient (Engine &engine, GameState &state, NetworkSession &netsession, NetworkNode &server) : engine(engine), state(state), netsession(netsession), server(server), controller(*this) { @@ -108,9 +111,10 @@ case NETMSG_PLAYER_JOIN: on_player_join(obj_id, pkt); break; - + + case NETMSG_PROJECTILE_INFO: case NETMSG_PROJECTILE_PLAYER_FIRED: - on_projectile_player_fired(obj_id, pkt); + on_projectile_create(obj_id, pkt); break; default: @@ -155,7 +159,7 @@ Engine::log(INFO, "net.client") << "Player joined: " << player; } -void NetworkClientController::on_projectile_player_fired (NetworkObjectID obj_id, NetworkPacketInput &pkt) { +void NetworkClientController::on_projectile_create (NetworkObjectID obj_id, NetworkPacketInput &pkt) { // read the packet NetworkObject *player_obj = client.controller.read_object(pkt); Vector position = pkt.read_vector(); @@ -337,14 +341,14 @@ } void NetworkClientLocalPlayer::handleInput (PlayerInput input, TimeMS dt) { - NetworkPacket pkt; + NetworkMessage msg (*this, NETMSG_CLIENT_INPUT); // write packet - pkt.write_uint16(input); - pkt.write_uint32(dt); + msg.write_uint16(input); + msg.write_uint32(dt); - // send - send(NETMSG_CLIENT_INPUT, pkt, false); + // send to server + client.server.send_raw(msg); // do not handle locally } diff -r 74e562e16399 -r c6d7272a164b src/Network/Client.hh --- a/src/Network/Client.hh Mon Jan 26 19:52:52 2009 +0200 +++ b/src/Network/Client.hh Mon Jan 26 23:03:47 2009 +0200 @@ -60,9 +60,9 @@ void on_player_join (NetworkObjectID obj_id, NetworkPacketInput &pkt); /** - * Handle NETMSG_PROJECTILE_PLAYER_FIRED -> NetworkClientProjectile + * Handle NETMSG_PROJECTILE_{INFO/PLAYER_FIRED} -> NetworkClientProjectile */ - void on_projectile_player_fired (NetworkObjectID obj_id, NetworkPacketInput &pkt); + void on_projectile_create (NetworkObjectID obj_id, NetworkPacketInput &pkt); }; /** @@ -95,7 +95,7 @@ /** * The server NetworkNode from Netsession::connect */ - NetworkNode *server; + NetworkNode &server; /** * Our specialized NetworkObject_ClientController @@ -112,7 +112,7 @@ * @param state the GameState to use * @param connect_to the address to connect to */ - NetworkClient (Engine &engine, GameState &state, NetworkSession &netsession, NetworkNode *server); + NetworkClient (Engine &engine, GameState &state, NetworkSession &netsession, NetworkNode &server); public: /** diff -r 74e562e16399 -r c6d7272a164b src/Network/Group.cc --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/Network/Group.cc Mon Jan 26 23:03:47 2009 +0200 @@ -0,0 +1,18 @@ + +#include "Group.hh" +#include "Node.hh" + +void NetworkGroup::send_pkt (const NetworkPacketBuffer &pkt, bool reliable) { + // iterate + recurse send_pkt + for (iterator_type it = targets_begin; it != targets_end; it++) { + // handle as NetworkTarget + NetworkTarget *target = static_cast(*it); + + // exclude? + if (target == exclude) + continue; + + // recurse + target->send_pkt(pkt, reliable); + } +} diff -r 74e562e16399 -r c6d7272a164b src/Network/Group.hh --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/Network/Group.hh Mon Jan 26 23:03:47 2009 +0200 @@ -0,0 +1,46 @@ +#ifndef NETWORK_GROUP_HH +#define NETWORK_GROUP_HH + +#include "Target.hh" + +#include + +// XXX: ugly forward-declare hack +class NetworkNode; + +/** + * Implements group-multicast for groups of NetworkTargets, by having each target copy + send the packet + */ +class NetworkGroup : public NetworkTarget { + protected: + // XXX: only support NetworkNodes for now... + typedef std::list::iterator iterator_type; + + /** List of targets to send to */ + iterator_type targets_begin, targets_end; + + /** Special-case for single target to exclude */ + NetworkNode *exclude; + + public: + /** + * Construct a NetworkGroup with the given targets. + * + * This does not copy the iterated list contents - the list must remain valid for the lifetime of this object. + * + * @param targets the list of targets to send to + */ + NetworkGroup (iterator_type targets_begin, iterator_type targets_end, NetworkNode *except = NULL) : + targets_begin(targets_begin), targets_end(targets_end), exclude(except) + { + + } + + protected: + /** + * Implement NetworkTarget + */ + virtual void send_pkt (const NetworkPacketBuffer &pkt, bool reliable = true); +}; + +#endif diff -r 74e562e16399 -r c6d7272a164b src/Network/Message.cc --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/Network/Message.cc Mon Jan 26 23:03:47 2009 +0200 @@ -0,0 +1,11 @@ + +#include "Message.hh" + +NetworkMessage::NetworkMessage (NetworkObject &obj, NetworkMessageID msg_id) { + // write the netsession channel ID header + obj.controller.session.write_packet_header(*this, obj.controller.channel_id); + + // write the NetworkObject header + write_uint32(obj.obj_id); + write_uint16(msg_id); +} diff -r 74e562e16399 -r c6d7272a164b src/Network/Message.hh --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/Network/Message.hh Mon Jan 26 23:03:47 2009 +0200 @@ -0,0 +1,24 @@ +#ifndef NETWORK_MESSAGE_HH +#define NETWORK_MESSAGE_HH + +/** + * @file + * + * NetworkPacket for use with NetworkObjects + */ + +#include "Packet.hh" +#include "Object.hh" + +/** + * NetworkMessages are NetworkPackets that are related to some specfic NetworkObject and its NetworkObjectController. + */ +class NetworkMessage : public NetworkPacket { + public: + /** + * Create a message of the given type to be sent on the given object + */ + NetworkMessage (NetworkObject &obj, NetworkMessageID msg_id); +}; + +#endif /* NETWORK_MESSAGE_HH */ diff -r 74e562e16399 -r c6d7272a164b src/Network/Node.cc --- a/src/Network/Node.cc Mon Jan 26 19:52:52 2009 +0200 +++ b/src/Network/Node.cc Mon Jan 26 23:03:47 2009 +0200 @@ -27,11 +27,7 @@ // delete this; } -void NetworkNode::write_packet_header (NetworkPacketOutput &pkt, NetworkChannelID channel_id) { - pkt.write_uint16(channel_id); -} - -void NetworkNode::send_raw (const NetworkPacketBuffer &pkt, bool reliable) { +void NetworkNode::send_pkt (const NetworkPacketBuffer &pkt, bool reliable) { // either tcp or udp if (reliable) { assert(tcp); @@ -43,19 +39,6 @@ } } - -void NetworkNode::send (NetworkChannelID channel_id, const NetworkPacketBuffer &pkt, bool reliable) { - assert(channel_id > 0); - - // add our header - NetworkPacket pkt2; - - write_packet_header(pkt2, channel_id); - pkt2.write_packet(pkt); - - // send - send_raw(pkt2, reliable); -} const NetworkAddress& NetworkNode::getRemoteAddress (void) { return address; diff -r 74e562e16399 -r c6d7272a164b src/Network/Node.hh --- a/src/Network/Node.hh Mon Jan 26 19:52:52 2009 +0200 +++ b/src/Network/Node.hh Mon Jan 26 23:03:47 2009 +0200 @@ -23,13 +23,16 @@ #include "TCP.hh" #include "UDP.hh" #include "Session.hh" +#include "Target.hh" /** * A NetworkNode represents a remote NetworkSession connected to our NetworkSession. * * A NetworkNode has a tcp connection, plus an udp socket to us (either NetworkSession's udp_srv or udp_client) + * + * NetworkNode implements the NetworkTarget interface, so you can use send() */ -class NetworkNode { +class NetworkNode : public NetworkTarget { private: /** * Our local NetworkSession @@ -82,41 +85,13 @@ */ CL_Signal_v0 _sig_disconnected; - public: - /** - * Write to appropriate NetworkSession header to the given packet. Can be used to prepare packets for use with - * send_raw. The size of the header is equal to NETWORK_SESSION_HEADER_SIZE - * - * @param pkt the packet to write the header to - * @param channel_id the NetworkChannelID to use - * - * @see send_raw - * @see NETWORK_SESSION_HEADER_SIZE - */ - void write_packet_header (NetworkPacketOutput &pkt, NetworkChannelID channel_id); - + protected: /** - * Send a raw packet prepared using write_packet_header. This does not need to copy the packet data around. - * - * @param pkt the NetworkPacket prepared using write_packet_header - * @param reliable Whether to use TCP or UDP - * - * @see write_packet_header + * Send the given packet to this node, used by NetworkTarget */ - void send_raw (const NetworkPacketBuffer &pkt, bool reliable = true); - - /** - * Send the given packet to this node on the given channel. - * - * Note that this constructs a new *NetworkPacket* containing our header and the given packet, so there - * given packet must be small enough to fit. - * - * @param channel_id the NetworkChannelID to use - * @param pkt the NetworkPacket to send on the given channel - * @param reliable Whether to use TCP or UDP - */ - void send (NetworkChannelID channel_id, const NetworkPacketBuffer &pkt, bool reliable = true); + virtual void send_pkt (const NetworkPacketBuffer &pkt, bool reliable = true); + public: /** * Get this node's remote address (both TCP and UDP). * diff -r 74e562e16399 -r c6d7272a164b src/Network/Object.cc --- a/src/Network/Object.cc Mon Jan 26 19:52:52 2009 +0200 +++ b/src/Network/Object.cc Mon Jan 26 23:03:47 2009 +0200 @@ -67,15 +67,16 @@ /* * NetworkObject_ClientController * */ -NetworkObject_ClientController::NetworkObject_ClientController (NetworkSession &session, NetworkChannelID channel_id, NetworkNode *server) : - NetworkObjectController(session, channel_id), server(server) { +NetworkObject_ClientController::NetworkObject_ClientController (NetworkSession &session, NetworkChannelID channel_id, NetworkNode &server) : + NetworkObjectController(session, channel_id), server(server) +{ } void NetworkObject_ClientController::handle_create (NetworkObjectID obj_id, NetworkMessageID msg_id, NetworkPacketInput &pkt, NetworkNode *node) { // we only communicate with the server - if (node != server) + if (node != &server) assert(false); // create new object @@ -101,12 +102,6 @@ controller.objects.erase(obj_id); } -void NetworkObject::buildPacket (NetworkPacketOutput &pkt, NetworkMessageID msg_id, const NetworkPacketBuffer &payload) { - pkt.write_uint32(obj_id); - pkt.write_uint16(msg_id); - pkt.write_packet(payload); -} - std::ostream& operator<< (std::ostream &s, const NetworkObject &obj) { return s << ""; } @@ -123,26 +118,6 @@ _map_sig_message[msg_id](node, pkt); } -void NetworkObject_Server::send_to (NetworkNode *dst, NetworkMessageID msg_id, const NetworkPacketBuffer &pkt, bool reliable) { - NetworkPacket pkt_out; - - buildPacket(pkt_out, msg_id, pkt); - - dst->send(controller.channel_id, pkt_out, reliable); -} - -void NetworkObject_Server::send_all (NetworkMessageID msg_id, const NetworkPacketBuffer &pkt, bool reliable) { - send_all_except(msg_id, pkt, NULL, reliable); -} - -void NetworkObject_Server::send_all_except (NetworkMessageID msg_id, const NetworkPacketBuffer &pkt, NetworkNode *black_sheep, bool reliable) { - NetworkPacket pkt_out; - - buildPacket(pkt_out, msg_id, pkt); - - controller.session.send_all_except(controller.channel_id, pkt_out, black_sheep, reliable); -} - /* * NetworkObject_Client */ @@ -153,17 +128,9 @@ } void NetworkObject_Client::handle_packet (NetworkNode *node, NetworkMessageID msg_id, NetworkPacketInput &pkt) { - if (node != controller.server) - assert(false); + if (node != &controller.server) + throw Error("Reject NetworkObject packet from non-server"); _map_sig_message[msg_id](pkt); } - -void NetworkObject_Client::send (NetworkMessageID msg_id, const NetworkPacketBuffer &pkt, bool reliable) { - NetworkPacket pkt_out; - buildPacket(pkt_out, msg_id, pkt); - - controller.server->send(controller.channel_id, pkt_out, reliable); -} - diff -r 74e562e16399 -r c6d7272a164b src/Network/Object.hh --- a/src/Network/Object.hh Mon Jan 26 19:52:52 2009 +0200 +++ b/src/Network/Object.hh Mon Jan 26 23:03:47 2009 +0200 @@ -38,6 +38,9 @@ friend class NetworkObject; friend class NetworkObject_Server; friend class NetworkObject_Client; + + // XXX: needs to access session and channel_id + friend class NetworkMessage; private: /** @@ -146,7 +149,7 @@ /** * The server node, as returned by NetworkSession::connect */ - NetworkNode *server; + NetworkNode &server; /** * A mapping of NetworkMessageID -> sig_create, used by the default handle_create @@ -160,7 +163,7 @@ * * @see NetworkObjectController */ - NetworkObject_ClientController (NetworkSession &session, NetworkChannelID channel_id, NetworkNode *server); + NetworkObject_ClientController (NetworkSession &session, NetworkChannelID channel_id, NetworkNode &server); protected: /** @@ -190,6 +193,9 @@ friend class NetworkObjectController; friend std::ostream& operator<< (std::ostream &s, const NetworkObject &obj); + // XXX: needs to access controller and obj_id + friend class NetworkMessage; + protected: /** * Generic controller @@ -223,15 +229,6 @@ * @param pkt the packet itself, with the headers read */ virtual void handle_packet (NetworkNode *node, NetworkMessageID msg_id, NetworkPacketInput &pkt) = 0; - - /** - * Prepare an outgoing packet, writing the header and the payload - * - * @param pkt the packet to prepare - * @param msg_id the packet's message id - * @param payload the packet's payload - */ - void buildPacket (NetworkPacketOutput &pkt, NetworkMessageID msg_id, const NetworkPacketBuffer &payload); }; /** @@ -272,35 +269,6 @@ public: /** - * Send a message on this object to the given node - * - * @param dst the NetworkNode to send the message to - * @param msg_id the type of message to send - * @param pkt the packet payload - * @param reliable Whether to use TCP or UDP - */ - void send_to (NetworkNode *dst, NetworkMessageID msg_id, const NetworkPacketBuffer &pkt, bool reliable = true); - - /** - * Send a message on this object to all nodes on our controller's NetworkSession - * - * @param msg_id the type of message to send - * @param pkt the packet payload - * @param reliable Whether to use TCP or UDP - */ - void send_all (NetworkMessageID msg_id, const NetworkPacketBuffer &pkt, bool reliable = true); - - /** - * Send a message on this object to all nodes on our controller's NetworkSession, except the given node - * - * @param msg_id the type of message to send - * @param pkt the packet payload - * @param black_sheep the node to *NOT* send the message to - * @param reliable Whether to use TCP or UDP - */ - void send_all_except (NetworkMessageID msg_id, const NetworkPacketBuffer &pkt, NetworkNode *black_sheep, bool reliable = true); - - /** * Triggered whenever we receive a message of the given type on this object, giving the node that sent it and the * packet itself * @@ -343,15 +311,6 @@ public: /** - * Send a message on this object to the server - * - * @param msg_id the type of message to send - * @param pkt the packet payload - * @param reliable Whether to use TCP or UDP - */ - void send (NetworkMessageID msg_id, const NetworkPacketBuffer &pkt, bool reliable = true); - - /** * Triggered whenever we receive a message of the given type on this object from the server. * * @param msg_id the NetworkMessageID to handle diff -r 74e562e16399 -r c6d7272a164b src/Network/Protocol.hh --- a/src/Network/Protocol.hh Mon Jan 26 19:52:52 2009 +0200 +++ b/src/Network/Protocol.hh Mon Jan 26 23:03:47 2009 +0200 @@ -47,9 +47,10 @@ * * Message names are of the form 'NETMSG_