Package legume :: Module messages :: Class Disconnected

Class Disconnected

 object --+    
          |    
BaseMessage --+
              |
             Disconnected


This message is sent by either the client or server to indicate to the
other end of the connection that the link is closed. In cases where
the connection is severed due to software crash, this message will
not be sent, and the socket will eventually disconnect due to a timeout.

Instance Methods

__init__(self, *values)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature (Inherited from legume.messages.BaseMessage)

get_data_format(self)
Returns a struct compatible format string of the packet data (Inherited from legume.messages.BaseMessage)

get_header_format(self)
Returns the header format as a struct compatible string. (Inherited from legume.messages.BaseMessage)

get_header_values(self)
Returns a list containing the values used to construct the packet header. (Inherited from legume.messages.BaseMessage)

get_message_format(self)
Returns a struct compatible format string of the message... (Inherited from legume.messages.BaseMessage)

get_message_values(self)
Returns a list containing the header+packet values used... (Inherited from legume.messages.BaseMessage)

get_packet_bytes(self)
Returns a string containing the header and data. (Inherited from legume.messages.BaseMessage)

read_from_byte_buffer(self, byteBuffer)
Reconstitute the packet from a ByteBuffer instance (Inherited from legume.messages.BaseMessage)

set_message_values_to_defaults(self)
Override this method to assign default values. (Inherited from legume.messages.BaseMessage)

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Static Methods

read_header_from_byte_buffer(byteBuffer)
Read a packet header from an instance of ByteBuffer. (Inherited from legume.messages.BaseMessage)

Class Variables
	MessageTypeID = `7`
	HEADER_FORMAT = `'B'` (Inherited from legume.messages.BaseMessage)
	MessageValues = `None` (Inherited from legume.messages.BaseMessage)
	UseDefaultValues = `True` (Inherited from legume.messages.BaseMessage)

Properties
Inherited from `object`: `__class__`