MessageClient.MessageClient Class Reference


Detailed Description

MessageClient is a specialized version of the client class which knows how to send and receive messages from the MessageServer.

All messages received on the socket (from the server) are queued on to the local message queue.

On connection, we expect an initial NEW_CLIENT_ID message from the server. Upon both connect and disconnect we send out local CLIENT_CONNECTION_STATUS messages.

#include <class_message_client_1_1_message_client.h>

Inheritance diagram for MessageClient.MessageClient:
Inheritance graph
[legend]

List of all members.

Public Member Functions

  __init__ ()
  sendMessage ()
  Overrides MessageSender.sendMessage().
  sendMessageToServer ()
  Send a message to the server.
  connectTo ()
  virtual
  disconnect ()
  virtual
  setSyncClock ()
  If we are given an external clock then we drive it by watching for FRAME_SYNCHRONIZE_[START|END] messages.
  processPacket ()
  virtual

Member Function Documentation

MessageClient.MessageClient.__init__ ( )
MessageClient.MessageClient.sendMessage ( )

Overrides MessageSender.sendMessage().

If a message queue was provided in the constructor, the message is placed on that queue. Otherwise, MessageSender.sendMessage() is used.

MessageClient.MessageClient.sendMessageToServer ( )

Send a message to the server.

MessageClient.MessageClient.connectTo ( )

virtual

Returns true if this client successfully connects to the message server at the given host and port. When the client connects, it expects a NEW_CLIENT_ID message from the server.

Reimplemented from Client.Client.

MessageClient.MessageClient.disconnect ( )

virtual

Disconnect the client and queues a status message.

Reimplemented from Client.Client.

MessageClient.MessageClient.setSyncClock ( )

If we are given an external clock then we drive it by watching for FRAME_SYNCHRONIZE_[START|END] messages.

MessageClient.MessageClient.processPacket ( )

virtual

Converts the packet into a message and queues it.

Always remember that this method is run in a separate thread from the main message processing thread.

Reimplemented from Client.Client.


MessageClient.MessageClient MessageClient.MessageClient MessageClient.MessageClient MessageClient.MessageClient MessageClient.MessageClient MessageClient.MessageClient MessageClient.MessageClient MessageClient.MessageClient MessageClient.MessageClient MessageClient.MessageClient
MessageClient.MessageClient MessageClient.MessageClient MessageClient.MessageClient MessageClient.MessageClient MessageClient.MessageClient MessageClient.MessageClient MessageClient.MessageClient MessageClient.MessageClient MessageClient.MessageClient MessageClient.MessageClient