Package legume :: Package udp :: Module messages :: Class MessageFactory

type MessageFactory

object --+
         |
        MessageFactory

Instance Methods

add(self, *message_classes)
Add message class(es) to the message factory.

getById(self, id)
Obtain a message class by specifying the packets MessageTypeID.

getByName(self, name)
Obtain a message class by specifying the packets name.

isA(self, message_instance, message_name)
Determine if message_instance is an instance of the named message class.

Method Details

Add message class(es) to the message factory. The parameters to this method must be subclasses of BaseMessage.

A MessageError will be raised if a message already exists in this factory with an identical name or MessageTypeID.

Obtain a message class by specifying the packets MessageTypeID. If the message cannot be found a MessageError exception is raised.

Obtain a message class by specifying the packets name. If the message cannot be found a MessageError exception is raised.

Determine if message_instance is an instance of the named message class.

Example: >>> tp = TestPacket1() >>> message_factory.isA(tp, 'TestPacket1') True