Package legume :: Package udp :: Module messages :: Class Disconnected

type 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) (Inherited from legume.udp.messages.BaseMessage)

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

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

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

getMessageFormat(self)
Returns a struct compatible format string of the message header and data (Inherited from legume.udp.messages.BaseMessage)

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

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

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

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

Static Methods

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

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