diff options
Diffstat (limited to 'TAO/docs/Options.html')
-rw-r--r-- | TAO/docs/Options.html | 260 |
1 files changed, 75 insertions, 185 deletions
diff --git a/TAO/docs/Options.html b/TAO/docs/Options.html index 9f87f4aeedb..68e0304dca2 100644 --- a/TAO/docs/Options.html +++ b/TAO/docs/Options.html @@ -22,16 +22,6 @@ environment variables or (2) strings passed on the command-line. They are generally passed to component initialization methods for consumption.</P> -<p>Both command-line options and environment variables are used to -control the global ORB features like the IOR format or ORB's -bootstraping methods. Options in <code>svc.conf</code> file on the -other hand provides a mechanism to fine-tune the internal components -in TAO and they are specific to individual components. -<code>svc.conf</code> files are not required to run TAO programs. -However, if you know the behavior of your programs, you can tune-up -your programs and use various optimization provided by TAO thru the -use of svc.conf files.</p> - <P><EM>Programmer's Note:</EM> the internal structure for options is the traditional <CODE>argc</CODE>/<CODE>argv</CODE> vector of strings style popularized by C and Unix. By convention, an initialization @@ -39,7 +29,7 @@ method will consume, <EM>i.e.</EM>, remove from the vector, any options that it recognizes.</P> </blockquote> <HR><P> -<H3><A NAME="ev">Environment Variables</A></H3> +<H3>Environment Variables</H3> The following environment variables are supported by TAO: @@ -68,6 +58,11 @@ Specifies which IOR the Trading Service is listening on. <TD> Specifies which port the Trading Service is listening on. </TD></TR> +<TR> +<TD><CODE>TAO_ORB_DEBUG</CODE> <EM>which</EM></TD> +<TD> +Enables TAO debugging mode. +</TD></TR> </TABLE> </P> </BLOCKQUOTE> @@ -81,6 +76,7 @@ Specifies which port the Trading Service is listening on. <UL> <LI><A HREF="#ORB"><CODE>CORBA::ORB</CODE></A> + <LI><A HREF="#POA"><CODE>CORBA::POA</CODE></A> <LI><A HREF="#ResourceFactory"><CODE>TAO_Resource_Factory</CODE></A> <LI><A HREF="#DefaultServer"><CODE>TAO_Default_Server_Strategy_Factory</CODE></A> <LI><A HREF="#DefaultClient" TARGET="_top"><CODE>TAO_Default_Client_Strategy_Factory</CODE></A> @@ -116,32 +112,24 @@ directive, which is passed to ACE's Service Configurator.</TD></TR> <TD>Turns on the output of debugging messages within ACE's Service Configurator componentry.</TD></TR> <TR> -<TD><CODE>-ORBdebuglevel</CODE> <EM>level</EM></TD> -<TD>Control the level of debugging in the ORB. Higher number produce -more output (try 10). -</TD></TR> -<TR> - -<TD><CODE>-ORBhost</CODE> <EM>hostname</EM></TD> <TD><a -name="-ORBhost"></a>Tells the ORB to listen for requests on the -interface associated with the host named -<I><EM>hostname</EM></I>.</TD></TR> - +<TD><CODE>-ORBhost</CODE> <EM>hostname</EM></TD> +<TD><a name="-ORBhost"></a>Tells the Object Adapter to listen for requests on the interface associated +with the host named <I><EM>hostname</EM></I>.</TD></TR> <TR> - -<TD><CODE>-ORBport</CODE> <EM>portspec</EM></TD> <TD>Tells the ORB to -listen for requests on the port specified by -<I><EM>portspec</EM></I>. If not specified, the OS gets to choose a -random empty port.</TD> - -</TR> - +<TD><CODE>-ORBport</CODE> <EM>portspec</EM></TD> +<TD>Tells the Object Adapter to listen for requests on the port specified by +<I><EM>portspec</EM></I>, which can be a name as found in <TT>/etc/services</TT> +or a number. The default is <TT>10013</TT>.</TD></TR> <TR> <TD><CODE>-ORBobjrefstyle</CODE> <EM>which</EM></TD> <TD>Specifies the user-visible style of object references. The range of values is <CODE>IOR</CODE>, which is the traditional nonsensical object reference, or <CODE>URL</CODE>, which looks more like a URL.</TD></TR> <TR> +<TD><CODE>-ORBtablesize</CODE> <EM>object table size</EM></TD> +<TD>Specifies the size of the object table as a positive, non-zero integer. +If not specified, the default is <TT>64</TT>.</TD></TR> +<TR> <TD><CODE>-ORBrcvsock</CODE> <EM>receive buffer size</EM></TD> <TD><A NAME="-ORBrcvsock"></a>Specify the size of the socket receive buffer as a positive, non-zero integer. If not specified, the system-dependent default is used.</TD></TR> @@ -156,13 +144,6 @@ If not specified, the system-dependent default is used.</TD></TR> <TD><CODE>-ORBnameserviceior</CODE> <EM>ior</EM></TD> <TD>Specifies the IOR for the Naming Service.</TD></TR> <TR> -<TD><CODE>-ORBtradingserviceior"</CODE> <EM>ior</EM></TD> -<TD>Specifiles the IOR for the Trading Service.</TD></TR> -<TR> -<TD><CODE>-ORBtradingserviceport"</CODE> <EM>portspec</EM></TD> -<TD>Specifies to which port the tradingservice is listening - on.</TD></TR> -<TR> <TD><CODE>-ORBcollocation</CODE> <EM>yes/no</EM></TD> <TD>Specifies the use of collocation object optimization. Default is yes.</TD></TR> <TR> @@ -173,16 +154,16 @@ be established, a warning is announced and it continues with the next listed. Listing the same combination multiple times will properly establish multiple connections to that endpoint.</TD></TR> <TR> -<TD><CODE>-ORBcdrtradeoff</CODE> <EM>maxsize</EM></TD> +<TD><CODE>-ORBCDRtradeoff</CODE> <EM>maxsize</EM></TD> <TD><A name="-ORBCDRtradeoff"></a>Control the strategy to tradeoff between copy vs no copy marshalling of octet sequences. If an octet sequence is smaller than <EM>maxsize</EM> and the current message block contains enough space for it the octet sequence is copied instead of appended to the CDR stream.</TD></TR> <TR> -<TD><CODE>-ORBgioplite</CODE></TD> -<TD><A name="-ORBgioplite"></a>Enable a lightweight version of the - GIOP protocol. This protocol removes some of the fields in +<TD><CODE>-ORBiioplite</CODE></TD> +<TD><A name="-ORBiioplite"></a>Enable a lightweight version of the + IIOP protocol. This protocol removes some of the fields in the GIOP and the Request header. It only works on homogenous environments..</TD></TR> <TR> @@ -191,12 +172,23 @@ copied instead of appended to the CDR stream.</TD></TR> notation for addresses.</TD></TR> <TR> <TD><CODE>-ORBInitRef</CODE> <EM>ObjectId=IOR</EM></TD> -<TD><A name="-ORBInitRef"></a> Allows specification of an arbitrary object reference for an initial service. The IOR could be in the one of the following formats : OMG IOR, URL or iioploc form. iioploc is a multiple end-point IORs understood by the string_to_object () and used as a boot-strapping mechanism by the resolve_initial_references (). The mappings specified through this argument override the orb-install-time defaults.</TD></TR> +<TD><A name="-ORBInitRef"></a> Specify a mapping between an ObjectId and an IOR. The IOR could be in the OMG IOR + form or in the URL form. More formats for the IOR will be supported soon. This mapping is used by the + resolve_initial_references () and overrides the orb-install-time defaults.</TD></TR> +</TABLE> +</P> +</blockquote> -<TR> -<TD><CODE>-ORBDefaultInitRef</CODE> <EM>IOR prefix</EM></TD> -<TD><A name="-ORBDefaultInitRef"></a> This argument allows resolution of initial references not explicitly specified with -ORBInitRef. It requires a URL prefix that, after appending a slash '/' and a simple object key, forms a new URL to identify an initial object reference. The URL prefix format currently supported is iioploc.</TD></TR> +<H3><CODE>CORBA::POA</CODE><A NAME="POA"></A></H3> +<blockquote> +<P><TABLE BORDER="2" CELLSPACING="2" CELLPADDING="0"> +<TR> +<TH>Option</TH> +<TH>Description</TH></TR> +<TR> +<TD><CODE>-OAid</CODE> <EM>OA Identifier</EM></TD> +<TD>Associates <I><EM>OA Identifier</EM></I> with the Object Adapter.</TD></TR> </TABLE> </P> </blockquote> @@ -214,45 +206,15 @@ copied instead of appended to the CDR stream.</TD></TR> (<em>which</em> = <code>global</code>) or a thread-specific (<em>which</em> = <code>tss</code>) instance for the resources it returns.</TD></TR> <TR> +<TD><CODE>-ORBpoa</CODE> <EM>which</EM></TD> +<TD><a name="-ORBpoa"></a>Specify whether each thread uses a global +(<em>which</em> = <code>global</code>) or a thread-specific +(<em>which</em> = <code>tss</code>) instance for the Root POA.</TD></TR> +<TR> <TD><CODE>-ORBreactorlock</CODE> <EM>which</EM></TD> -<TD><a name="-ORBreactorlock"></a>Specify whether the ORB reactor is - thread-safe +<TD><a name="-ORBcoltable"></a>Specify whether the ORB reactor is thread-safe (<em>which</em> = <code>token</code>) or not -(<em>which</em> = <code>null</code>). Default is <code>token</code>. - <P>This option has been superseeded by - <CODE>-ORBreactortype</CODE> - </P> -</TD></TR> -<TR> -<TD><CODE>-ORBreactortype</CODE> <EM>which</EM></TD> -<TD><a name="-ORBcoltable"></a>Specify what kind of reactor does the - ORB use, the options are: - <TABLE BORDER="1" CELLSPACING="2" CELLPADDING="0"> - <TR><TH><em>which</em></TH><TH>Reactor</TH></TR> - <TR><TD><CODE>select_mt<CODE></TD><TD>Use the - <CODE>ACE_Select_Reactor</CODE> with the usual - locking mechanism for this platform</TD></TR> - <TR><TD><CODE>select_st<CODE></TD><TD>Use the - <CODE>ACE_Select_Reactor</CODE> with null locks - </TD></TR> - <TR><TD><CODE>fl_reactor<CODE></TD><TD>Use the - <CODE>ACE_FlReactor</CODE> only available if ACE - was compiled with support for the FL toolkit - </TD></TR> - <TR><TD><CODE>xt_reactor<CODE></TD><TD>Use the - <CODE>ACE_FlReactor</CODE> only available if ACE - was compiled with support for the XWindows Toolkit - </TD></TR> - <TR><TD><CODE>WFMO<CODE></TD><TD>Use the - <CODE>ACE_WFMO_Reactor</CODE> only available on - Win32 platforms. - </TD></TR> - <TR><TD><CODE>MsgWFMO<CODE></TD><TD>Use the - <CODE>ACE_Msg_WFMO_Reactor</CODE> only available on - Win32 platforms. - </TD></TR> - </TABLE> - The default is <code>select_mt</code></TD></TR> +(<em>which</em> = <code>null</code>). Default is <code>token</code></TD></TR> <TR> <TD><CODE>-ORBcoltable</CODE> <EM>which</EM></TD> <TD><a name="-ORBcoltable"></a>Specify whether each ORB uses a global @@ -265,15 +227,10 @@ copied instead of appended to the CDR stream.</TD></TR> (<em>which</em> = <code>global</code>) or a per-thread (<em>which</em> = <code>tss</code>) allocator for the incoming CDR buffers. - Though <CODE>tss</CODE> should give the + The default is <CODE>tss</CODE> and should give the optimal performance; - we made the default <CODE>global</CODE>. - TAO optimizations for octet sequences will not work when - returning that data type if the allocator is - <CODE>tss</CODE>. - Using global allocator also allows the users to - take advantage of the TAO octet sequence - extensions to preserve the buffer after the upcall. + unless the user takes advantage of the features in TAO + to keep the CDR stream buffer after the upcall. </TD></TR> </TABLE> </P> @@ -281,93 +238,43 @@ copied instead of appended to the CDR stream.</TD></TR> <H3><CODE>TAO_Default_Server_Strategy_Factory</CODE><A NAME="DefaultServer"></A></H3> -<p><em>Note:</em> <code>-ORBdemuxstrategy</code> flag has been changed to <code>-ORBsystemidpolicydemuxstrategy</code> and <code>-ORBuseridpolicydemuxstrategy</code>. -<p><em>Note:</em> <code>-ORBtablesize</code> flag has been changed to <code>-ORBactiveobjectmapsize</code>. - <blockquote> <P><TABLE BORDER="2" CELLSPACING="2" CELLPADDING="0" > <TR> <TH>Option</TH> <TH>Description</TH></TR> <TR> - -<TD><CODE>-ORBconcurrency</CODE> <EM>which</EM></TD> <TD>Specify which -concurrency strategy to use. Range of values is <code>reactive</code> +<TD><CODE>-ORBconcurrency</CODE> <EM>which</EM></TD> +<TD>Specify which concurrency strategy to use. Range of values is <code>reactive</code> for a purely Reactor-driven concurrency strategy or -<code>thread-per-connection</code> for creating a new thread to -service each connection.</TD></TR> <TR> - -<TD><CODE>-ORBactiveobjectmapsize</CODE> <EM>active object map -size</EM></TD> <TD>Specify the size of the active object map. If not -specified, the default value is 64.</TD></TR> <TR> +<code>thread-per-connection</code> for creating a new thread to service each connection.</TD></TR> +<TR> +<TD><CODE>-ORBtablesize</CODE> <EM>object table size</EM></TD> +<TD>Specify the size of the object table. If not specified, the default value +is 64.</TD></TR> +<TR> <TD><CODE>-ORBuseridpolicydemuxstrategy</CODE> <EM>user id policy based demultiplexing strategy</EM></TD> <TD>Specify the demultiplexing lookup strategy to be used with the user id policy. The -<EM>demultiplexing strategy</EM> can be one of <CODE>dynamic</CODE> or -<CODE>linear</CODE>. This option defaults to use the -<CODE>dynamic</CODE> strategy. </TD></TR> <TR> +<EM>demultiplexing strategy</EM> can be one of <CODE>dynamic</CODE>, +<CODE>linear</CODE>, or <CODE>user</CODE>. This option defaults to +use the <CODE>dynamic</CODE> strategy. </TD></TR> <TR> <TD><CODE>-ORBsystemidpolicydemuxstrategy</CODE> <EM>system id policy based demultiplexing strategy</EM></TD> <TD>Specify the demultiplexing lookup strategy to be used with the system id policy. The <EM>demultiplexing strategy</EM> can be one of <CODE>dynamic</CODE>, -<CODE>linear</CODE>, or <CODE>active</CODE>. This option defaults to -use the <CODE>active</CODE> strategy. </TD></TR> <TR> +<CODE>linear</CODE>, <CODE>active</CODE>, or <CODE>user</CODE>. This +option defaults to use the <CODE>active</CODE> strategy. </TD></TR> +<TR> <TD><CODE>-ORBuniqueidpolicyreversedemuxstrategy</CODE> <EM>unique id policy based reverse demultiplexing strategy</EM></TD> <TD>Specify the reverse demultiplexing lookup strategy to be used with the unique id policy. The <EM>reverse demultiplexing strategy</EM> can be one of -<CODE>dynamic</CODE> or <CODE>linear</CODE>. This option defaults to -use the <CODE>dynamic</CODE> strategy. </TD></TR> <TR> - -<TD><CODE>-ORBallowreactivationofsystemids</CODE> <EM>allows -reactivation of system ids</EM></TD> <TD>Specify whether system ids -can be reactivated, i.e., once an id that was generated by the system -has be deactivated, will the user reactivate a new servant using the -old id. If the user is not going to use this feature, the IORs can be -shortened, an extra comparison in the critical upcall path removed, -and some memory on the server side can be saved. The -<CODE>ORBallowreactivationofsystemids</CODE> can be <CODE>0</CODE> or -<CODE>1</CODE>. This option defaults to <CODE>1</CODE>. </TD></TR> -<TR> - -<TD><CODE>-ORBactivehintinids</CODE> <EM>adds an active hint in -ids</EM></TD> <TD>Specify whether an active hint should be added to -ids. With active hints, ids can be found quickly. However, they lead -to larger IORs. Note that this option is disregarded -<CODE>-ORBallowreactivationofsystemids</CODE> is set to -<CODE>0</CODE>. The <EM>-ORBactivehintinids</EM> can be <CODE>0</CODE> -or <CODE>1</CODE>. This option defaults to <CODE>1</CODE>. </TD></TR> -<TR> - -<TD><CODE>-ORBpoamapsize</CODE> <EM>poa map size</EM></TD> <TD>Specify -the size of the poa map. If not specified, the default value is -24.</TD></TR> <TR> - -<TD><CODE>-ORBpersiententidpolicydemuxstrategy</CODE> <EM>persistent -id policy based demultiplexing strategy</EM></TD> <TD>Specify the -demultiplexing lookup strategy to be used with the persistent id -policy. The <EM>demultiplexing strategy</EM> can be one of -<CODE>dynamic</CODE> or <CODE>linear</CODE>. This option defaults to -use the <CODE>dynamic</CODE> strategy. </TD></TR> <TR> - -<TD><CODE>-ORBtransientidpolicydemuxstrategy</CODE> <EM>transient id -policy based demultiplexing strategy</EM></TD> <TD>Specify the -demultiplexing lookup strategy to be used with the transient id -policy. The <EM>demultiplexing strategy</EM> can be one of -<CODE>dynamic</CODE>, <CODE>linear</CODE>, or -<CODE>active</CODE>. This option defaults to use the -<CODE>active</CODE> strategy. </TD></TR> <TR> - -<TD><CODE>-ORBactivehintinpoanames</CODE> <EM>adds an active hint in -poa names</EM></TD> <TD>Specify whether an active hint should be added -to poa names. With active hints, poa names can be found quickly. -However, they lead to larger IORs. The -<EM>-ORBactivehintinpoanames</EM> can be <CODE>0</CODE> or -<CODE>1</CODE>. This option defaults to <CODE>1</CODE>. </TD></TR> -<TR> +<CODE>dynamic</CODE> or <CODE>user</CODE>. This option defaults to use +the <CODE>dynamic</CODE> strategy. </TD></TR> <TR> <TD><CODE>-ORBthreadflags</CODE> <EM>thread flags</EM></TD> <TD>Specify the flags used for thread creation. Flags can be any @@ -399,6 +306,14 @@ used to guarantee exclusive acccess, and <code>null</code>, which specifies that no locking be performed. The default is <code>thread</code>.</TD></TR> <TR> +<TD><CODE>-ORBpoamgrlock</CODE> <EM>lock type</EM></TD> <TD><a +name="-ORBpoamgrlock"></a>Specify the type of lock to be used for POA +Manager accesses. Possible values for <em>lock type</em> are +<code>thread</code>, which specifies that an inter-thread mutex is +used to guarantee exclusive acccess, and <code>null</code>, which +specifies that no locking be performed. The default is +<code>null</code>.</TD></TR> + </TABLE> </P> </blockquote> @@ -420,35 +335,10 @@ This makes sense in case of optiziations and is allowed when no forwarding is used or only a single threaded client. </TD></TR> <TR> -<TD><CODE>-ORBclientconnectionhandler</CODE> <EM>MT / ST / RW</EM></TD> - -<TD><A name="-ORBclientconnectionhandler"></a> - -ST means use the single-threaded client connection handler, i.e., the -leader follower model will not be used. However, ST does support -nested upcalls and handling of new requests while waiting for the -reply from a server. <p> - -MT means use the multi-threaded client connection handler which uses -the leader follower model. This model allows the use of multiple -threads with a single Reactor. <p> - -RW selects a strategy that simply blocks in recv() when waiting for a -response from the server instead of waiting in the Reactor. The RW -strategy only works when the application does not have to worry about -new request showing up when waiting for a response. Therefore, this -strategy is appropriate only for "pure" clients. Note that -applications with nested upcalls are not "pure" clients. Also note -that this strategy will only effect two way calls, since there is no -waiting for one way calls. This strategy can also be used in an -application that is both a client and a server if the server side is -handled by a separate thread and the client threads are "pure" -clients. <p> - -Default for this option is MT. - -</TD></TR> - +<TD><CODE>-ORBclientconnectionhandler</CODE> <EM>MT / ST</EM></TD> +<TD><A name="-ORBclientconnectionhandler"></a> ST means use the +single-threaded client connection handler and MT means use the +multi-threaded client connection handler .</TD></TR> </TABLE> </P> </BLOCKQUOTE> |