Changeset 21022

Show
Ignore:
Timestamp:
02/09/08 22:07:05 (10 months ago)
Author:
patrick
Message:

Added/expanded API documentation.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • juggler/trunk/modules/tweek/tweek/CORBA/CorbaManager.h

    r21013 r21022  
    7373 
    7474   /** 
    75     * Initializes the ORB and POA associated with this object.  A child POA of 
    76     * the root POA (RootPOA) is created, and all servants registered with this 
    77     * manager are activated within that child POA. 
     75    * Initializes the ORB and POA associated with this object for use with the 
     76    * CORBA Naming Service. A child POA of the root POA (RootPOA) is created, 
     77    * and all servants registered with this manager are activated within that 
     78    * child POA. 
     79    * 
     80    * By initializing this object in this manner, the Subject Manager servant 
     81    * can only be accessed through the CORBA Naming Service. 
     82    * 
     83    * @pre This CorbaManager object has not been initialized previously. 
    7884    * 
    7985    * @param localID     A string providing a unique identifier for the local 
    80     *                    POA. 
     86    *                    POA. When used, "tweek_" will be prepended to this 
     87    *                    value, but user-level code should generally not need 
     88    *                    to worry aubot that detail. 
    8189    * @param argc        The size of the following argument vector.  This will 
    8290    *                    be modified if any elements are removed from argv. 
    …… 
    99107    *                    the Naming Service.  Common values are "1.0" and 
    100108    *                    "1.2".  It defaults to "1.0". 
     109    * 
     110    * @return \c true is returned if initialization completes successfully. 
     111    *         Otherwise, \c false is returned. 
    101112    */ 
    102113   bool init(const std::string& localID, int& argc, char** argv, 
    …… 
    106117 
    107118   /** 
     119    * Initializes the ORB and POA associated with this object for use with 
     120    * direct object connnetions. A child POA of the root POA (RootPOA) is 
     121    * created, and all servants registered with this manager are activated 
     122    * within that child POA. 
     123    * 
     124    * By initializing this object in this manner, the Subject Manager servant 
     125    * can only be accessed through a direct object connection. Moreover, this 
     126    * feature is only supported when using omniORB as the C++ CORBA 
     127    * implementation. 
     128    * 
     129    * @pre This CorbaManager object has not been initialized previously. 
     130    * 
     131    * @param localID       A string providing a unique identifier for the 
     132    *                      local POA. When used, "tweek_" will be prepended 
     133    *                      to this value, but user-level code should generally 
     134    *                      not need to worry aubot that detail. 
     135    * @param argc          The size of the following argument vector. This 
     136    *                      will be modified if any elements are removed from 
     137    *                      argv. 
     138    * @param argv          The command-line arguments passed to the 
     139    *                      application. These may include parameters defining 
     140    *                      the ORB's behavior. Those recognized as ORB 
     141    *                      arguments are removed from the array leaving 
     142    *                      application parameters. 
     143    * @param listenAddress The network address on the local machine to which 
     144    *                      the ORB endpoint will be bound. If an empty string 
     145    *                      is used, the default network interface will be 
     146    *                      used. Typically, a non-empty address will be passed 
     147    *                      in for this parameter only on multi-homed machines 
     148    *                      when a specific network interface must be used for 
     149    *                      the ORB endpoint. 
     150    * @param listenPort    The port on which the ORB endpoint will listen for 
     151    *                      incoming connections. As with any port number, it 
     152    *                      must not be one that is currently in use by another 
     153    *                      listening socket. 
     154    * 
     155    * @return \c true is returned if initialization completes successfully. 
     156    *         Otherwise, \c false is returned. 
     157    * 
    108158    * @since 1.3.4 
    109159    */ 
    …… 
    220270} // End of tweek namespace 
    221271 
     272 
    222273#endif /* _TWEEK_CORBA_MANAGER_H_ */