Eiffel Media API
Overview Cluster Class Classes Index      Previous Next      Top Features

em.network.multiplayer.net_system_objects

Class EM_NET_EVENT_CONTAINER_OBJECT


Direct ancestors

EM_NET_OBJECT, EM_TIME_SINGLETON

Creation

Features

Invariants

indexing

description

This network object wrapps one or multiple EM_NET_EVENT_OBJECT such that they
can be transmitted over a network in one message.

This wrapper manages a queue of incomming and outgoing events.

All features are available trough EM_NET_BASE, it is not necessary to
manually deal with it.

date

$Date: 2005/10/26 14:05:23 $

revision

$Revision: 1.24 $

class

EM_NET_EVENT_CONTAINER_OBJECT

inherit

EM_NET_OBJECT

create {EM_NET_OBJECT_TYPES}

make_set_type (a_type_id: INTEGER)

-- Initalize a new wrapper for EM_NET_EVENT_OBJECTs.

-- (From EM_NET_OBJECT)

feature -- Initialisation

make_set_type (a_type_id: INTEGER)

-- Initalize a new wrapper for EM_NET_EVENT_OBJECTs.

-- (From EM_NET_OBJECT)

feature -- Initialization

init_serialization_byte_count: INTEGER

-- Count of bytes needed for a successful serialization of initialization data.
-- The default behaviour uses the serialize_byte_count feature.
-- If you redefine serialize_init_data, you'll also to redefine this feature.
-- This might be a constant and *could* be a dynamic value.
-- {EM_NET_WORK_CONSTANTS}.max_serialization_byte_count is the limit!

-- (From EM_NET_OBJECT)

make_from_stream (an_unserializer: EM_NET_UNSERIALIZER)

-- Initialize object with data from an_unserializer.
-- The default behaviour uses the unserialize feature.
-- If you have other/extended initialization data you need to redefine this feature.
-- Note: There is no need to serialize the type ID, this is done automatically.
-- This function will usually be called by the EM_NET_OBJECT_GENERATOR class.

-- (From EM_NET_OBJECT)

serialize_init_data (a_serializer: EM_NET_SERIALIZER)

-- Serialize initialization data to the given stream using a_serializer.
-- The default behaviour uses the serialize feature.
-- If you redefine make_from_stream, you'll also have to redefine this feature.
-- Note: There is no need to serialize the type ID, this is done automatically.

-- (From EM_NET_OBJECT)

feature {EM_NET_BASE,EM_NET_EVENT_CONTAINER_OBJECT} -- Element change

set_group (a_group: EM_NET_GROUP)

-- Set group to a_group.
-- Note that an object can only belong to one group.
-- If you set a new group, the object should be removed from the previous one first.

-- (From EM_NET_OBJECT)

require
not_already_added_to_a_group: not a_group.has_object (Current)
ensure
group_set: group = a_group
set_id (an_id: INTEGER)

-- Set id to an_id.

-- (From EM_NET_OBJECT)

ensure
id_correct_set: an_id = id
set_net_object_factory (an_object_factory: EM_NET_OBJECT_FACTORY)

-- Set the factory that is used to create objects and events.

require
factory_not_void: an_object_factory /= Void
ensure
factory_set: net_object_factory = an_object_factory
set_time_offset (a_time: INTEGER)

-- Set last_update to a_time.

-- (From EM_NET_OBJECT)

ensure
last_update_set: time_offset = a_time
set_updating_connection (a_connection: EM_NET_CONNECTION)

-- Set updating_connection to a_connection.

-- (From EM_NET_OBJECT)

require
a_connection_not_void: a_connection /= Void
ensure
updating_connection_set: updating_connection = a_connection
wipe_out

-- Wipe out the list of incoming objects.
-- Most probably you just processed them all and you don't need them anymore.

feature -- Event handling

publish (an_event: EM_NET_EVENT_OBJECT)

-- Publish an_event to the clients that belong to group.

require
an_object_not_void: an_event /= Void
ensure
outgoing_net_events.has (an_event)

feature -- Serialization

event_count_to_serialize: INTEGER

-- Count of event objects we can serialize without breaking the max_serialization_byte_count limit.

ensure
at_least_one_event_to_serialize: Result > 0
serialization_byte_count: INTEGER

-- Count of bytes needed for a successful serialization
-- This may be a constant or a dynamic value.

-- (From EM_NET_OBJECT)

require else
serialization_needed: is_synchronisation_needed
ensure
Result_in_max_serialization_byte_count_range: Result <= max_serialization_byte_count.item
serialize (a_serializer: EM_NET_SERIALIZER)

-- Serialize to the given stream using a_serializer.

-- (From EM_NET_OBJECT)

require
a_serializer_not_void: a_serializer /= Void
unserialize (an_unserializer : EM_NET_UNSERIALIZER)

-- Unserialize from a given stream using an_unserializer.

-- (From EM_NET_OBJECT)

require
a_unserializer_not_void: an_unserializer /= Void

feature -- Information

group: EM_NET_GROUP

-- Group that contains the current object
-- The object will be synchronized with all clients that are in
-- the same group.

-- (From EM_NET_OBJECT)

id: INTEGER

-- Unique ID that indentifies a single instance of an object

-- (From EM_NET_OBJECT)

is_make_set_type_called: BOOLEAN

-- Has make_set_type been called?

-- (From EM_NET_OBJECT)

is_synchronisation_needed: BOOLEAN

-- Is synchronisation needed?

-- (From EM_NET_OBJECT)

is_synchronized: BOOLEAN

-- Is this object currently synchronized over network?
-- True if this object is added to a server or client list for synchronisation.

-- (From EM_NET_OBJECT)

next_sync_frame: INTEGER

-- Next time when object synchronisation occurs

-- (From EM_NET_OBJECT)

time_offset: INTEGER

-- Time in miliseconds of the lastupdate

-- (From EM_NET_OBJECT)

type_id: INTEGER

-- ID that identifies the type of of an on object

-- (From EM_NET_OBJECT)

updating_connection: EM_NET_CONNECTION

-- Connection which sent the last update

-- (From EM_NET_OBJECT)

feature {EM_NET_BASE} -- Implementation

net_object_factory: EM_NET_OBJECT_FACTORY

-- Object factory that is used to create objects and events

invariant

type_id_set_by_factory: type_id > 0 and is_make_set_type_called

-- From ANY
reflexive_equality: standard_is_equal (Current)
reflexive_conformance: conforms_to (Current)

end