void DistributedObject::annihilate(channel_t sender, bool notify_parent)
{
unordered_set<channel_t> targets;
if(m_parent_id) {
targets.insert(location_as_channel(m_parent_id, m_zone_id));
// Leave parent on explicit delete ram
if(notify_parent) {
DatagramPtr dg = Datagram::create(m_parent_id, sender, STATESERVER_OBJECT_CHANGING_LOCATION);
dg->add_doid(m_do_id);
dg->add_location(INVALID_DO_ID, 0);
dg->add_location(m_parent_id, m_zone_id);
route_datagram(dg);
}
}
if(m_owner_channel) {
targets.insert(m_owner_channel);
}
if(m_ai_channel) {
targets.insert(m_ai_channel);
}
DatagramPtr dg = Datagram::create(targets, sender, STATESERVER_OBJECT_DELETE_RAM);
dg->add_doid(m_do_id);
route_datagram(dg);
delete_children(sender);
m_stateserver->m_objs.erase(m_do_id);
m_log->debug() << "Deleted.\n";
terminate();
}
void DistributedObject::append_required_data(DatagramPtr dg, bool client_only, bool also_owner)
{
dg->add_doid(m_do_id);
dg->add_location(m_parent_id, m_zone_id);
dg->add_uint16(m_dclass->get_id());
size_t field_count = m_dclass->get_num_fields();
for(size_t i = 0; i < field_count; ++i) {
const Field *field = m_dclass->get_field(i);
if(field->has_keyword("required") && !field->as_molecular() && (!client_only
|| field->has_keyword("broadcast") || field->has_keyword("clrecv")
|| (also_owner && field->has_keyword("ownrecv")))) {
dg->add_data(m_required_fields[field]);
}
}
}
void DistributedObject::handle_datagram(DatagramHandle, DatagramIterator &dgi)
{
channel_t sender = dgi.read_channel();
uint16_t msgtype = dgi.read_uint16();
switch(msgtype) {
case STATESERVER_DELETE_AI_OBJECTS: {
if(m_ai_channel != dgi.read_channel()) {
m_log->warning() << " received reset for wrong AI channel.\n";
break; // Not my AI!
}
annihilate(sender);
break;
}
case STATESERVER_OBJECT_DELETE_RAM: {
if(m_do_id != dgi.read_doid()) {
break; // Not meant for me!
}
// Delete object
annihilate(sender);
break;
}
case STATESERVER_OBJECT_DELETE_CHILDREN: {
doid_t r_do_id = dgi.read_doid();
if(r_do_id == m_do_id) {
delete_children(sender);
} else if(r_do_id == m_parent_id) {
annihilate(sender, false);
}
break;
}
case STATESERVER_OBJECT_SET_FIELD: {
if(m_do_id != dgi.read_doid()) {
break; // Not meant for me!
}
handle_one_update(dgi, sender);
break;
}
case STATESERVER_OBJECT_SET_FIELDS: {
if(m_do_id != dgi.read_doid()) {
break; // Not meant for me!
}
uint16_t field_count = dgi.read_uint16();
for(int16_t i = 0; i < field_count; ++i) {
if(!handle_one_update(dgi, sender)) {
break;
}
}
break;
}
case STATESERVER_OBJECT_CHANGING_AI: {
doid_t r_parent_id = dgi.read_doid();
channel_t new_channel = dgi.read_channel();
m_log->trace() << "Received ChangingAI notification from " << r_parent_id << ".\n";
if(r_parent_id != m_parent_id) {
m_log->warning() << "Received AI channel from " << r_parent_id
<< " but my parent_id is " << m_parent_id << ".\n";
break;
}
if(m_ai_explicitly_set) {
break;
}
handle_ai_change(new_channel, sender, false);
break;
}
case STATESERVER_OBJECT_SET_AI: {
channel_t new_channel = dgi.read_channel();
m_log->trace() << "Updating AI to " << new_channel << ".\n";
handle_ai_change(new_channel, sender, true);
break;
}
case STATESERVER_OBJECT_GET_AI: {
m_log->trace() << "Received AI query from " << sender << ".\n";
DatagramPtr dg = Datagram::create(sender, m_do_id, STATESERVER_OBJECT_GET_AI_RESP);
dg->add_uint32(dgi.read_uint32()); // Get context
dg->add_doid(m_do_id);
dg->add_channel(m_ai_channel);
route_datagram(dg);
break;
}
case STATESERVER_OBJECT_GET_AI_RESP: {
dgi.read_uint32(); // Discard context
doid_t r_parent_id = dgi.read_doid();
m_log->trace() << "Received AI query response from " << r_parent_id << ".\n";
if(r_parent_id != m_parent_id) {
m_log->warning() << "Received AI channel from " << r_parent_id
<< " but my parent_id is " << m_parent_id << ".\n";
break;
}
channel_t new_ai = dgi.read_channel();
if(m_ai_explicitly_set) {
break;
}
handle_ai_change(new_ai, sender, false);
break;
}
case STATESERVER_OBJECT_CHANGING_LOCATION: {
doid_t child_id = dgi.read_doid();
doid_t new_parent = dgi.read_doid();
zone_t new_zone = dgi.read_zone();
doid_t r_do_id = dgi.read_doid();
zone_t r_zone = dgi.read_zone();
if(new_parent == m_do_id) {
if(m_do_id == r_do_id) {
if(new_zone == r_zone) {
break; // No change, so do nothing.
}
auto &children = m_zone_objects[r_zone];
children.erase(child_id);
if(children.empty()) {
m_zone_objects.erase(r_zone);
}
}
m_zone_objects[new_zone].insert(child_id);
DatagramPtr dg = Datagram::create(child_id, m_do_id, STATESERVER_OBJECT_LOCATION_ACK);
dg->add_doid(m_do_id);
dg->add_zone(new_zone);
route_datagram(dg);
} else if(r_do_id == m_do_id) {
auto &children = m_zone_objects[r_zone];
children.erase(child_id);
if(children.empty()) {
m_zone_objects.erase(r_zone);
}
} else {
m_log->warning() << "Received changing location from " << child_id
<< " for " << r_do_id << ", but my id is " << m_do_id << ".\n";
}
break;
}
case STATESERVER_OBJECT_LOCATION_ACK: {
doid_t r_parent_id = dgi.read_doid();
zone_t r_zone_id = dgi.read_zone();
if(r_parent_id != m_parent_id) {
m_log->trace() << "Received location acknowledgement from " << r_parent_id
<< " but my parent_id is " << m_parent_id << ".\n";
} else if(r_zone_id != m_zone_id) {
m_log->trace() << "Received location acknowledgement for zone " << r_zone_id
<< " but my zone_id is " << m_zone_id << ".\n";
} else {
m_log->trace() << "Parent acknowledged my location change.\n";
m_parent_synchronized = true;
}
break;
}
case STATESERVER_OBJECT_SET_LOCATION: {
doid_t new_parent = dgi.read_doid();
zone_t new_zone = dgi.read_zone();
m_log->trace() << "Updating location to Parent: " << new_parent
<< ", Zone: " << new_zone << ".\n";
handle_location_change(new_parent, new_zone, sender);
break;
}
case STATESERVER_OBJECT_GET_LOCATION: {
uint32_t context = dgi.read_uint32();
DatagramPtr dg = Datagram::create(sender, m_do_id, STATESERVER_OBJECT_GET_LOCATION_RESP);
dg->add_uint32(context);
dg->add_doid(m_do_id);
dg->add_location(m_parent_id, m_zone_id);
route_datagram(dg);
break;
}
case STATESERVER_OBJECT_GET_LOCATION_RESP: {
// This case occurs immediately after object creation.
// A parent expects to receive a location_resp from each
// of its pre-existing children.
if(dgi.read_uint32() != STATESERVER_CONTEXT_WAKE_CHILDREN) {
m_log->warning() << "Received unexpected GetLocationResp from "
<< dgi.read_uint32() << ".\n";
break;
}
// Get DOID of our child
doid_t doid = dgi.read_doid();
// Get location
doid_t r_parent = dgi.read_doid();
zone_t r_zone = dgi.read_zone();
// Update the child count
if(r_parent == m_do_id) {
m_zone_objects[r_zone].insert(doid);
}
break;
}
case STATESERVER_OBJECT_GET_ALL: {
uint32_t context = dgi.read_uint32();
if(dgi.read_doid() != m_do_id) {
return; // Not meant for this object!
}
DatagramPtr dg = Datagram::create(sender, m_do_id, STATESERVER_OBJECT_GET_ALL_RESP);
dg->add_uint32(context);
append_required_data(dg);
append_other_data(dg);
route_datagram(dg);
break;
}
case STATESERVER_OBJECT_GET_FIELD: {
uint32_t context = dgi.read_uint32();
if(dgi.read_doid() != m_do_id) {
return; // Not meant for this object!
}
uint16_t field_id = dgi.read_uint16();
DatagramPtr raw_field = Datagram::create();
bool success = handle_one_get(raw_field, field_id);
DatagramPtr dg = Datagram::create(sender, m_do_id, STATESERVER_OBJECT_GET_FIELD_RESP);
dg->add_uint32(context);
dg->add_bool(success);
if(success) {
dg->add_data(raw_field);
}
route_datagram(dg);
break;
}
case STATESERVER_OBJECT_GET_FIELDS: {
uint32_t context = dgi.read_uint32();
if(dgi.read_doid() != m_do_id) {
return; // Not meant for this object!
}
uint16_t field_count = dgi.read_uint16();
// Read our requested fields into a sorted set
set<uint16_t> requested_fields;
for(int i = 0; i < field_count; ++i) {
uint16_t field_id = dgi.read_uint16();
if(!requested_fields.insert(field_id).second) {
const dclass::Field* field = m_dclass->get_field_by_id(field_id);
if(field != nullptr) {
// If it is null, handle_one_get will produce a warning for us later
m_log->warning() << "Received duplicate field '"
<< field->get_name() << "' in get_fields.\n";
}
}
}
// Try to get the values for all the fields
bool success = true;
uint16_t fields_found = 0;
DatagramPtr raw_fields = Datagram::create();
for(auto it = requested_fields.begin(); it != requested_fields.end(); ++it) {
uint16_t field_id = *it;
uint16_t length = raw_fields->size();
if(!handle_one_get(raw_fields, field_id, true)) {
success = false;
break;
}
if(raw_fields->size() > length) {
fields_found++;
}
}
// Send get fields response
DatagramPtr dg = Datagram::create(sender, m_do_id, STATESERVER_OBJECT_GET_FIELDS_RESP);
dg->add_uint32(context);
dg->add_bool(success);
if(success) {
dg->add_uint16(fields_found);
dg->add_data(raw_fields);
}
route_datagram(dg);
break;
}
case STATESERVER_OBJECT_SET_OWNER: {
channel_t new_owner = dgi.read_channel();
m_log->trace() << "Updating owner to " << new_owner << "...\n";
if(new_owner == m_owner_channel) {
m_log->trace() << "... owner is the same, do nothing.\n";
return;
}
if(m_owner_channel) {
m_log->trace() << "... broadcasting changing owner...\n";
DatagramPtr dg = Datagram::create(m_owner_channel, sender, STATESERVER_OBJECT_CHANGING_OWNER);
dg->add_doid(m_do_id);
dg->add_channel(new_owner);
dg->add_channel(m_owner_channel);
route_datagram(dg);
}
m_owner_channel = new_owner;
if(new_owner) {
m_log->trace() << "... sending owner entry...\n";
send_owner_entry(new_owner);
}
m_log->trace() << "... updated owner.\n";
break;
}
case STATESERVER_OBJECT_GET_ZONE_OBJECTS:
case STATESERVER_OBJECT_GET_ZONES_OBJECTS: {
uint32_t context = dgi.read_uint32();
doid_t queried_parent = dgi.read_doid();
m_log->trace() << "Handling get_zones_objects with parent '" << queried_parent << "'"
<< ". My id is " << m_do_id << " and my parent is " << m_parent_id
<< ".\n";
uint16_t zone_count = 1;
if(msgtype == STATESERVER_OBJECT_GET_ZONES_OBJECTS) {
zone_count = dgi.read_uint16();
}
if(queried_parent == m_parent_id) {
// Query was relayed from parent! See if we match any of the zones
// and if so, reply:
for(uint16_t i = 0; i < zone_count; ++i) {
if(dgi.read_zone() == m_zone_id) {
// The parent forwarding this request down to us may or may
// not yet know about our presence (and therefore have us
// included in the count that it sent to the interested
// peer). If we are included in this count, we reply with a
// normal interest entry. If not, we reply with a standard
// location entry and allow the interested peer to resolve
// the difference itself.
if(m_parent_synchronized) {
send_interest_entry(sender, context);
} else {
send_location_entry(sender);
}
break;
}
}
} else if(queried_parent == m_do_id) {
doid_t child_count = 0;
// Start datagram to relay to children
DatagramPtr child_dg = Datagram::create(parent_to_children(m_do_id), sender,
STATESERVER_OBJECT_GET_ZONES_OBJECTS);
child_dg->add_uint32(context);
child_dg->add_doid(queried_parent);
child_dg->add_uint16(zone_count);
// Get all zones requested
for(int i = 0; i < zone_count; ++i) {
zone_t zone = dgi.read_zone();
child_count += m_zone_objects[zone].size();
child_dg->add_zone(zone);
}
// Reply to requestor with count of objects expected
DatagramPtr count_dg = Datagram::create(sender, m_do_id, STATESERVER_OBJECT_GET_ZONES_COUNT_RESP);
count_dg->add_uint32(context);
count_dg->add_doid(child_count);
route_datagram(count_dg);
// Bounce the message down to all children and have them decide
// whether or not to reply.
// TODO: Is this really that efficient?
if(child_count > 0) {
route_datagram(child_dg);
}
}
break;
}
// zones in Astron don't have meaning to the cluster itself
// as such, there is no table of zones to query in the network
// instead, a zone is said to be active if it has at least one object in it
// to get the active zones, get the keys from m_zone_objects and dump them into a std::set<zone_t>
// using an std::set ensures that no duplicate zones are sent
// TODO: evaluate efficiency on large games with many DistributedObjects
case STATESERVER_GET_ACTIVE_ZONES: {
uint32_t context = dgi.read_uint32();
std::unordered_set<zone_t> keys;
for(auto kv : m_zone_objects) {
keys.insert(kv.first);
}
DatagramPtr dg = Datagram::create(sender, m_do_id, STATESERVER_GET_ACTIVE_ZONES_RESP);
dg->add_uint32(context);
dg->add_uint16(keys.size());
std::unordered_set<zone_t>::iterator it;
for(it = keys.begin(); it != keys.end(); ++it) {
dg->add_zone(*it);
}
route_datagram(dg);
break;
}
default:
if(msgtype < STATESERVER_MSGTYPE_MIN || msgtype > STATESERVER_MSGTYPE_MAX) {
m_log->warning() << "Received unknown message of type " << msgtype << ".\n";
} else {
m_log->trace() << "Ignoring stateserver message of type " << msgtype << ".\n";
}
}
}
void DistributedObject::handle_location_change(doid_t new_parent, zone_t new_zone, channel_t sender)
{
doid_t old_parent = m_parent_id;
zone_t old_zone = m_zone_id;
// Set of channels that must be notified about location_change
unordered_set<channel_t> targets;
// Notify AI of changing location
if(m_ai_channel) {
targets.insert(m_ai_channel);
}
// Notify Owner of changing location
if(m_owner_channel) {
targets.insert(m_owner_channel);
}
if(new_parent == m_do_id) {
m_log->warning() << "Object cannot be parented to itself.\n";
return;
}
// Handle parent change
if(new_parent != old_parent) {
// Unsubscribe from the old parent's child-broadcast channel.
if(old_parent) { // If we have an old parent
unsubscribe_channel(parent_to_children(m_parent_id));
// Notify old parent of changing location
targets.insert(old_parent);
// Notify old location of changing location
targets.insert(location_as_channel(old_parent, old_zone));
}
m_parent_id = new_parent;
m_zone_id = new_zone;
// Subscribe to new one...
if(new_parent) { // If we have a new parent
subscribe_channel(parent_to_children(m_parent_id));
if(!m_ai_explicitly_set) {
// Ask the new parent what its AI is.
DatagramPtr dg = Datagram::create(m_parent_id, m_do_id, STATESERVER_OBJECT_GET_AI);
dg->add_uint32(m_next_context++);
route_datagram(dg);
}
targets.insert(new_parent); // Notify new parent of changing location
} else if(!m_ai_explicitly_set) {
m_ai_channel = 0;
}
} else if(new_zone != old_zone) {
m_zone_id = new_zone;
// Notify parent of changing zone
targets.insert(m_parent_id);
// Notify old location of changing location
targets.insert(location_as_channel(m_parent_id, old_zone));
} else {
return; // Not actually changing location, no need to handle.
}
// Send changing location message
DatagramPtr dg = Datagram::create(targets, sender, STATESERVER_OBJECT_CHANGING_LOCATION);
dg->add_doid(m_do_id);
dg->add_location(new_parent, new_zone);
dg->add_location(old_parent, old_zone);
route_datagram(dg);
// At this point, the new parent (which may or may not be the same as the
// old parent) is unaware of our existence in this zone.
m_parent_synchronized = false;
// Send enter location message
if(new_parent) {
send_location_entry(location_as_channel(new_parent, new_zone));
}
}