TIBCO Adapter SDK C++ Reference
MApp Methods
MApp | Legend
Methods
Method Description
~MApp Destructor.
getAdapterServiceInfo Return the adapter service information associated with this MApp.
getAdvisory Return the MApp owned MAdvisory object.
getAdvisoryListener  
getAppName Return the name of this MApp instance, as set inMAppProperties.
getClassRegistry Return a pointer to the MClassRegistry instance for this application manager instance. Return NULL if no MClassRegistry exists.
getClientVariable Lookup the value for the specified client variable name. Returns the value set by tibco.clientvar and -system:clientvar that overrides the default configured GlobalVariable value.
getClientVariables Return all the client variable names and their values that are used in the repository.
getCommandLineArgc Return the count (argc) of the command-line arguments.
getCommandLineArgv Return the vector of strings (argv) that was used as a command-line argument.
getComponentByName Return a pointer to an MComponent if given the name of that component.
getComponentByName Return a pointer to an MComponent if given the name of that component and the class in which you want to look for the component.
getComponentCount Accessor for MApp instances. Return the number of MComponent instances this MApp instance is managing.
getComponentRegistry Accessor for MApp instances. Return the component registry associated with this MApp instance.
getConfigDocName Accessor for MApp instances. Return the name of the adapter instance description object.
getConfigProperties Return the MProperties instance that stores configuration information associated with this application.
getConfigURL Accessor for MApp instances. Return the full path of the adapter instance description object used to initialize this adapter.
getGlobalVariable Lookup the value for the specified global variable name. Returns the default configured value stored in the repository.
getGlobalVariables Return all the global variable names and their values that in the repository.
getInstanceId Accessor for MApp instances. Return the instance ID for this adapter instance, which is specified via the TIBCO Designer.
getPropertiesRegistry Accessor for MApp instances. Retrieve the MPropertiesRegistry for this MApp.
getRepoURL Accessor for MApp instances. Return the repository instance URL, from which all configuration and metadata information for this adapter instance is read.
getTrace Return the currently attached trace (MTrace object). MApp always creates a trace, even if there are no predefined sinks.
getVersion Accessor for MApp instances. Return the version of this custom adapter, as specified in MAppProperties.
isDedicatedHawkThreadOn  
isValid Check whether this MApp instance is valid.
MApp Constructor for this class. Note that MApp is an abstract class; applications create instances of an MApp subclass.

The constructor creates an application manager using an application-specified MAppProperties instance that contains information for this MApp instance.

newGUID Create a new MGUID instance for this MApp.
nextEvent Dispatches the next event for all the sessions of the MApp. When the time limit has been reached, control returns to the caller.

Return TRUE if an event was dispatched before the timeout, FALSE otherwise.

onInitialization This method performs application-specific initialization.
onTermination You terminate an adapter application by calling MApp::stop(). At that time, the SDK first calls the application-defined onTermination() method, then performs some cleanup of its own. The application has to explicitly call the destructor for MApp after the call to MApp::stop() has returned.
setAdapterServiceInfo Sets the service information for this adapter instance.
setAdvisoryListener Install a custom advisory listener for advisories related to the creation of MRvSession objects created by the SDK from configuration information.
setAdvisoryListener Install a custom advisory listener for advisories related to the creation of MRvSession objects created by the SDK from configuration information.
setHostInfo Sets the Host information for this adapter instance.
start Start this application. This method first performs some initialization that is internal to the adapter SDK, then calls the application-specific MApp::onInitialization() method.
stop Stop this adapter application.
Copyright (c) 2010 TIBCO Software Inc. All rights reserved.