omegalib  13.1
omega::MissionControlClient Class Reference

#include <MissionControl.h>

Public Member Functions

 MissionControlClient ()
 
virtual ~MissionControlClient ()
 
virtual void dispose ()
 
virtual void initialize ()
 
virtual void update (const UpdateContext &context)
 
void connect (const String &host, int port)
 
void postCommand (const String &command)
 
bool isConnected ()
 
void closeConnection ()
 
void setName (const String &name)
 
String getName ()
 
vector< String > & listConnectedClients ()
 
void setClientConnectedCommand (const String &cmd)
 
void setClientDisconnectedCommand (const String &cmd)
 
void setClientListUpdatedCommand (const String &cmd)
 
void setListener (IMissionControlListener *l)
 
IMissionControlListenergetListener ()
 
void setLogForwardingEnabled (bool value)
 Enable or disable log forwarding. More...
 
bool isLogForwardingEnabled ()
 
virtual bool handleMessage (MissionControlConnection *sender, const char *header, char *data, int size)
 
bool spawn (const String &id, int slot, const String &script, const String &config)
 Starts a new instance of omegalib using the specified script and configuration file. More...
 
- Public Member Functions inherited from omega::EngineModule
 EngineModule (const String &name)
 
 EngineModule ()
 
virtual ~EngineModule ()
 
void requestOpenGLProfile (OpenGLProfile profile)
 This method can be used within an engine module ctor or initialization to test for module compatibility. More...
 
void enableSharedData ()
 
void disableSharedData ()
 
virtual void handleEvent (const Event &evt)
 
virtual bool handleCommand (const String &cmd)
 
virtual void commitSharedData (SharedOStream &out)
 
virtual void updateSharedData (SharedIStream &in)
 
virtual void initializeRenderer (Renderer *)
 
void doInitialize (Engine *server)
 
void doDispose ()
 
virtual bool isInitialized ()
 
EnginegetEngine ()
 
Priority getPriority ()
 
void setPriority (Priority value)
 
const StringgetName ()
 
- Public Member Functions inherited from omicron::ReferenceType
 ReferenceType ()
 
virtual ~ReferenceType ()
 
void ref ()
 
void unref ()
 
long refCount ()
 

Static Public Member Functions

static MissionControlClientcreate ()
 Utility method: creates a new client and registers it as a module. More...
 
- Static Public Member Functions inherited from omicron::ReferenceType
static void printObjCounts ()
 

Additional Inherited Members

- Public Types inherited from omega::EngineModule
enum  Priority {
  PriorityLowest = 0, PriorityLow = 1, PriorityNormal = 2, PriorityHigh = 3,
  PriorityHighest = 4
}
 
enum  OpenGLProfile { CoreProfile, CompatibilityProfile, UnspecifiedProfile }
 
- Static Protected Attributes inherited from omicron::ReferenceType
static List< ReferenceType * > mysObjList
 
+ Inheritance diagram for omega::MissionControlClient:

Constructor & Destructor Documentation

omega::MissionControlClient::MissionControlClient ( )
inline
virtual omega::MissionControlClient::~MissionControlClient ( )
inlinevirtual

Member Function Documentation

void omega::MissionControlClient::closeConnection ( )
void omega::MissionControlClient::connect ( const String host,
int  port 
)
static MissionControlClient* omega::MissionControlClient::create ( )
static

Utility method: creates a new client and registers it as a module.

virtual void omega::MissionControlClient::dispose ( )
virtual

Reimplemented from omega::EngineModule.

IMissionControlListener* omega::MissionControlClient::getListener ( )
inline
String omega::MissionControlClient::getName ( )
virtual bool omega::MissionControlClient::handleMessage ( MissionControlConnection sender,
const char *  header,
char *  data,
int  size 
)
virtual
virtual void omega::MissionControlClient::initialize ( )
virtual

Reimplemented from omega::EngineModule.

bool omega::MissionControlClient::isConnected ( )
bool omega::MissionControlClient::isLogForwardingEnabled ( )
vector<String>& omega::MissionControlClient::listConnectedClients ( )
void omega::MissionControlClient::postCommand ( const String command)
void omega::MissionControlClient::setClientConnectedCommand ( const String cmd)
inline
void omega::MissionControlClient::setClientDisconnectedCommand ( const String cmd)
inline
void omega::MissionControlClient::setClientListUpdatedCommand ( const String cmd)
inline
void omega::MissionControlClient::setListener ( IMissionControlListener l)
inline
void omega::MissionControlClient::setLogForwardingEnabled ( bool  value)

Enable or disable log forwarding.

When log forwarding is enabled and this client is connected, server log messages will be received and printed on this client's console.

void omega::MissionControlClient::setName ( const String name)
bool omega::MissionControlClient::spawn ( const String id,
int  slot,
const String script,
const String config 
)

Starts a new instance of omegalib using the specified script and configuration file.

The instance will use mission control to connect to the same server this instance is connected to.

Returns
true if the script has been launched successfully. Note: this does not mean the instance is already running and connected back. You will need to use the clientConnected method of IMissionControlMessageHandler for that.
virtual void omega::MissionControlClient::update ( const UpdateContext context)
virtual

Reimplemented from omega::EngineModule.


The documentation for this class was generated from the following file: