diff options
| -rw-r--r-- | cpp/doc/Makefile | 4 | ||||
| -rw-r--r-- | cpp/doc/Properties.sgml | 1419 | ||||
| -rw-r--r-- | cpp/slice/IcePatch2/FileServer.ice | 5 |
3 files changed, 6 insertions, 1422 deletions
diff --git a/cpp/doc/Makefile b/cpp/doc/Makefile index 15242003a1c..bf35a7c2a7c 100644 --- a/cpp/doc/Makefile +++ b/cpp/doc/Makefile @@ -21,9 +21,9 @@ SLICEFILES = $(wildcard ../slice/Ice/*.ice) \ $(wildcard ../slice/IceBox/*.ice) \ $(wildcard ../slice/IcePack/*.ice) \ $(wildcard ../slice/IceSSL/*.ice) \ - $(wildcard ../slice/Glacier/*.ice) \ + $(wildcard ../slice/Glacier2/*.ice) \ $(wildcard ../slice/IceStorm/*.ice) \ - $(wildcard ../slice/IcePatch/*.ice) + $(wildcard ../slice/IcePatch2/*.ice) include $(top_srcdir)/config/Make.rules diff --git a/cpp/doc/Properties.sgml b/cpp/doc/Properties.sgml index 76c59c1aa73..69d3479d121 100644 --- a/cpp/doc/Properties.sgml +++ b/cpp/doc/Properties.sgml @@ -697,7 +697,7 @@ Ice.Default.Router=<replaceable>router</replaceable> <title>Description</title> <para> Specifies the default router for all proxies. The value is a -stringified proxy to the &Glacier; router control interface. +stringified proxy to the &Glacier2; router control interface. The default router can be overridden on a proxy using the <literal>ice_router()</literal> operation. The default value is no router. @@ -3179,1423 +3179,6 @@ the &IceStorm; administration tool, and may also be used by applications. </section> <!-- ********************************************************************** --> -<section><title>&Glacier; Router Properties</title> -<!-- ********************************************************************** --> - -<section><title>Glacier.Router.AdapterId, Glacier.Router.Client.AdapterId, Glacier.Router.Server.AdapterId</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Router.AdapterId=<replaceable>id</replaceable> -Glacier.Router.Client.AdapterId=<replaceable>id</replaceable> -Glacier.Router.Server.AdapterId=<replaceable>id</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -Defines the value of the property -<link linkend="adapter.AdapterId"><replaceable>adapter</replaceable>.AdapterId</link> -for the object adapters named <literal>Glacier.Router</literal>, <literal>Glacier.Router.Client</literal> and -<literal>Glacier.Router.Server</literal>. -</para> -</section> -</section> - -<section><title>Glacier.Router.Endpoints, Glacier.Router.Client.Endpoints, Glacier.Router.Server.Endpoints</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Router.Endpoints=<replaceable>endpoints</replaceable> -Glacier.Router.Client.Endpoints=<replaceable>endpoints</replaceable> -Glacier.Router.Server.Endpoints=<replaceable>endpoints</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -Defines the endpoints of the &Glacier; router control interface, the -client interface, and the server interface. The router endpoints and -the client endpoints must be accessible to Glacier clients from which -the router forwards requests, and to which the router sends -callbacks. The server endpoints must be accessible to Glacier servers -to which the router forwards requests, and from which the router -accepts callbacks for the client. -</para> -</section> -</section> - -<section><title>Glacier.Router.PublishedEndpoints, Glacier.Router.Client.PublishedEndpoints, Glacier.Router.Server.PublishedEndpoints</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Router.PublishedEndpoints=<replaceable>endpoints</replaceable> -Glacier.Router.Client.PublishedEndpoints=<replaceable>endpoints</replaceable> -Glacier.Router.Server.PublishedEndpoints=<replaceable>endpoints</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -Defines the published endpoints of the &Glacier; router control interface, the -client interface, and the server interface. The router endpoints and -the client endpoints must be accessible to Glacier clients from which -the router forwards requests, and to which the router sends -callbacks. The server endpoints must be accessible to Glacier servers -to which the router forwards requests, and from which the router -accepts callbacks for the client. -Refer to the description of the object adapter property -<link linkend="adapter.PublishedEndpoints"><replaceable>adapter</replaceable>.PublishedEndpoints</link> -for more information. -</para> -</section> -</section> - -<section><title>Glacier.Router.Identity</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Router.Identity=<replaceable>identity</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -The identity of the router control interface. If not specified, the -default value <literal>router</literal> is used. -</para> -</section> -</section> - -<section><title>Glacier.Router.PrintProxyOnFd</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Router.PrintProxyOnFd=<replaceable>fd</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -If set, print the stringified router proxy on the filedescriptor -<replaceable>fd</replaceable>, and close this filedescriptor. (Unix -only.) -<note><para> This operation is intended to be used by the &Glacier; -router starter only. It should not be set manually. -</para></note> -</para> -</section> -</section> - -<section><title>Glacier.Router.Trace.Client</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Router.Trace.Client=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -The client interface trace level: -<informaltable> -<tgroup cols=2> -<tbody> -<row> -<entry>0</entry> -<entry>No client interface trace. (default)</entry> -</row> -<row> -<entry>1</entry> -<entry>Trace exceptions during request forwarding from the client to -the server.</entry> -</row> -<row> -<entry>2</entry> -<entry>Also trace detailed forward routing information from -the client to the server. -</entry> -</row> -</tbody> -</tgroup> -</informaltable> -</para> -</section> -</section> - -<section><title>Glacier.Router.Trace.Server</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Router.Trace.Server=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -The server interface trace level: -<informaltable> -<tgroup cols=2> -<tbody> -<row> -<entry>0</entry> -<entry>No server interface trace. (default)</entry> -</row> -<row> -<entry>1</entry> -<entry>Trace exceptions during callbacks from the server back -to the client.</entry> -</row> -<row> -<entry>2</entry> -<entry>Also trace detailed reverse routing information for -callbacks from the server to the client. -</entry> -</row> -</tbody> -</tgroup> -</informaltable> -</para> -</section> -</section> - -<section><title>Glacier.Router.Trace.RoutingTable</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Router.Trace.RoutingTable=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -The routing table trace level: -<informaltable> -<tgroup cols=2> -<tbody> -<row> -<entry>0</entry> -<entry>No routing table trace. (default)</entry> -</row> -<row> -<entry>1</entry> -<entry>Trace additions to the &Glacier; routing table. -</entry> -</row> -</tbody> -</tgroup> -</informaltable> -</para> -</section> -</section> - -<section><title>Glacier.Router.Trace.Throttle</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Router.Trace.Throttle=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -The request throttle trace level: -<informaltable> -<tgroup cols=2> -<tbody> -<row> -<entry>0</entry> -<entry>No request throttle tracing. (default)</entry> -</row> -<row> -<entry>1</entry> -<entry>Trace throttled requests.</entry> -</row> -</tbody> -</tgroup> -</informaltable> -</para> -</section> -</section> - -<section><title>Glacier.Router.Client.ForwardContext, Glacier.Router.Server.ForwardContext</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Router.Client.ForwardContext=<replaceable>num</replaceable> -Glacier.Router.Server.ForwardContext=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -If <replaceable>num</replaceable> is set to a value larger than zero, -the context parameter is forwarded unmodified as received from the -client or server, respectively. Otherwise an empty context is -forwarded. Default is no context forwarding. -</para> -</section> -</section> - -<section><title>Glacier.Router.Client.SleepTime, Glacier.Router.Server.SleepTime</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Router.Client.SleepTime=<replaceable>num</replaceable> -Glacier.Router.Server.SleepTime=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -<replaceable>num</replaceable> is the sleep time (delay) in -milliseconds after a request or message batch has been forwarded. The -default value is zero, meaning no delay. Setting these values avoids -message flooding. This is useful to avoid denial-of-service attacks, -or to allow a minimum time for collecting messages for batching. -</para> -</section> -</section> - -<section><title>Glacier.Router.Client.Throttle.Twoways, Glacier.Router.Server.Throttle.Twoways</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Router.Client.Throttle.Twoways=<replaceable>num</replaceable> -Glacier.Router.Server.Throttle.Twoways=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -<replaceable>num</replaceable> is the maximum number of twoway -requests that the router forwards simultaneously. The default is -zero, meaning no limit. Enabling twoway message throttling is -useful to prevent a router from consuming too many resources of -backend services. -</para> -</section> -</section> - -<section><title>Glacier.Router.SessionManager</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Router.SessionManager=<replaceable>proxy</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -A stringified proxy to a session manager. If not specified, it is not -possible to use the <literal>Router::createSession()</literal> method. -</para> -</section> -</section> - -<section><title>Glacier.Router.UserId</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Router.UserId=<replaceable>name</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -The authenticated user id. This is usually passed from the &Glacier; -router starter. The user id is used as an argument to -<literal>Router::createSession()</literal>. -</para> -</section> -</section> - -<section><title>Glacier.Router.AllowCategories</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Router.AllowCategories=<replaceable>list</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -A white space separated list of categories. If this property is set, -then requests are only permitted to &Ice; objects with an identity -that matches one of the categories from this list. -</para> -</section> -</section> - -<section><title>Glacier.Router.AcceptCert</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Router.AcceptCert=<replaceable>base64 encoded certificate string</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -A base64 encoded certificate (which can be obtained by calling certToBase64() -on an existing IceSSL::RSAKeyPair). - -The &Glacier; Router uses this certificate, when in SSL mode, to restrict -those clients that may connect to it. Only clients that use this certificate -may connect; others are rejected. -</para> -</section> -</section> - -<section><title>Glacier.Router.ThreadPool.Size</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Router.ThreadPool.Size=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -Defines the value of the property -<link linkend="threadpool.Size"><replaceable>adapter</replaceable>.ThreadPool.Size</link> -for the object adapter named <literal>Glacier.Router</literal>. -</para> -</section> -</section> - -<section><title>Glacier.Router.ThreadPool.SizeMax</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Router.ThreadPool.SizeMax=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -Defines the value of the property -<link linkend="threadpool.SizeMax"><replaceable>adapter</replaceable>.ThreadPool.SizeMax</link> -for the object adapter named <literal>Glacier.Router</literal>. -</para> -</section> -</section> - -<section><title>Glacier.Router.ThreadPool.SizeWarn</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Router.ThreadPool.SizeWarn=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -Defines the value of the property -<link linkend="threadpool.SizeWarn"><replaceable>adapter</replaceable>.ThreadPool.SizeWarn</link> -for the object adapter named <literal>Glacier.Router</literal>. -</para> -</section> -</section> - -<section><title>Glacier.Router.Client.ThreadPool.Size</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Router.Client.ThreadPool.Size=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -Defines the value of the property -<link linkend="threadpool.Size"><replaceable>adapter</replaceable>.ThreadPool.Size</link> -for the object adapter named <literal>Glacier.Router.Client</literal>. -</para> -</section> -</section> - -<section><title>Glacier.Router.Client.ThreadPool.SizeMax</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Router.Client.ThreadPool.SizeMax=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -Defines the value of the property -<link linkend="threadpool.SizeMax"><replaceable>adapter</replaceable>.ThreadPool.SizeMax</link> -for the object adapter named <literal>Glacier.Router.Client</literal>. -</para> -</section> -</section> - -<section><title>Glacier.Router.Client.ThreadPool.SizeWarn</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Router.Client.ThreadPool.SizeWarn=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -Defines the value of the property -<link linkend="threadpool.SizeWarn"><replaceable>adapter</replaceable>.ThreadPool.SizeWarn</link> -for the object adapter named <literal>Glacier.Router.Client</literal>. -</para> -</section> -</section> - -<section><title>Glacier.Router.Server.ThreadPool.Size</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Router.Server.ThreadPool.Size=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -Defines the value of the property -<link linkend="threadpool.Size"><replaceable>adapter</replaceable>.ThreadPool.Size</link> -for the object adapter named <literal>Glacier.Router.Server</literal>. -</para> -</section> -</section> - -<section><title>Glacier.Router.Server.ThreadPool.SizeMax</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Router.Server.ThreadPool.SizeMax=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -Defines the value of the property -<link linkend="threadpool.SizeMax"><replaceable>adapter</replaceable>.ThreadPool.SizeMax</link> -for the object adapter named <literal>Glacier.Router.Server</literal>. -</para> -</section> -</section> - -<section><title>Glacier.Router.Server.ThreadPool.SizeWarn</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Router.Server.ThreadPool.SizeWarn=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -Defines the value of the property -<link linkend="threadpool.SizeWarn"><replaceable>adapter</replaceable>.ThreadPool.SizeWarn</link> -for the object adapter named <literal>Glacier.Router.Server</literal>. -</para> -</section> -</section> - - -</section> - -<!-- ********************************************************************** --> -<section><title>&Glacier; Router Starter Properties</title> -<!-- ********************************************************************** --> - -<section><title>Glacier.Starter.AdapterId</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Starter.AdapterId=<replaceable>id</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -Defines the value of the property -<link linkend="adapter.AdapterId"><replaceable>adapter</replaceable>.AdapterId</link> -for the object adapter named <literal>Glacier.Starter</literal>. -</para> -</section> -</section> - -<section><title>Glacier.Starter.Endpoints</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Starter.Endpoints=<replaceable>endpoints</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -Defines the endpoints of the &Glacier; router starter. -</para> -</section> -</section> - -<section><title>Glacier.Starter.PublishedEndpoints</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Starter.PublishedEndpoints=<replaceable>endpoints</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -Defines the published endpoints of the &Glacier; router starter. -Refer to the description of the object adapter property -<link linkend="adapter.PublishedEndpoints"><replaceable>adapter</replaceable>.PublishedEndpoints</link> -for more information. -</para> -</section> -</section> - -<section><title>Glacier.Starter.ThreadPool.Size</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Starter.ThreadPool.Size=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -Defines the value of the property -<link linkend="threadpool.Size"><replaceable>adapter</replaceable>.ThreadPool.Size</link> -for the object adapter named <literal>Glacier.Starter</literal>. -</para> -</section> -</section> - -<section><title>Glacier.Starter.ThreadPool.SizeMax</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Starter.ThreadPool.SizeMax=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -Defines the value of the property -<link linkend="threadpool.SizeMax"><replaceable>adapter</replaceable>.ThreadPool.SizeMax</link> -for the object adapter named <literal>Glacier.Starter</literal>. -</para> -</section> -</section> - -<section><title>Glacier.Starter.ThreadPool.SizeWarn</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Starter.ThreadPool.SizeWarn=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -Defines the value of the property -<link linkend="threadpool.SizeWarn"><replaceable>adapter</replaceable>.ThreadPool.SizeWarn</link> -for the object adapter named <literal>Glacier.Starter</literal>. -</para> -</section> -</section> - -<section><title>Glacier.Starter.PermissionsVerifier</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Starter.PermissionsVerifier=<replaceable>proxy</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -If set, the specified permissions verifier is used. If not set, a -built-in <literal>crypt</literal>-based verifier is used. -</para> -</section> -</section> - -<section><title>Glacier.Starter.CryptPasswords</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Starter.CryptPasswords=<replaceable>file</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -The pathname of the file that contains user-id / password pairs, with -the passwords being encrypted by the <literal>crypt</literal> -algorithm. The default pathname is -"<literal>passwords</literal>". This file is only used for the -built-in <literal>crypt</literal>-based password verifier, meaning -that the property is ignored if -<literal>Glacier.Starter.PasswordVerifier</literal> is set. -</para> -</section> -</section> - -<section><title>Glacier.Starter.RouterPath</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Starter.RouterPath=<replaceable>path</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -Sets the path of the &Glacier; router executable to be started. The -default is <literal>glacier</literal>. -</para> -</section> -</section> - -<section><title>Glacier.Starter.PropertiesOverride</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Starter.PropertiesOverride=<replaceable>overrides</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -By default, the &Glacier; router starter starts new routers with the -exact same property set as for the router -starter. <replaceable>overrides</replaceable> can contain a list -of properties for the router, which are used in addition to the router -starter's properties, or which override the router starter's properties. -The property definitions should be separated by white space. -</para> -<para> -For example, in many cases it is desirable to set the property -<literal>Ice.ServerIdleTime</literal> for the router, but not for the -router starter. For an idle time of 60 seconds, this can be done by setting -<literal>Glacier.Starter.PropertiesOverride=Ice.ServerIdleTime=60</literal>. -</para> -</section> -</section> - -<section><title>Glacier.Starter.StartupTimeout</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Starter.StartupTimeout=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -<replaceable>num</replaceable> is the number of seconds the &Glacier; -router starter waits for the router to start up. If this timeout -expires, a <literal>Glacier::CannotStartRouterException</literal> is -returned to the caller. The default value is 10 seconds. Timeout -values smaller than one second are silently changed to 1 second. (Unix -only.) -</para> -</section> -</section> - -<section><title>Glacier.Starter.AddUserToAllowCategories</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Starter.AddUserToAllowCategories=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -Control the addition of the user id authenticated by the &Glacier; router -starter to the <literal>Glacier.Router.AllowCategories</literal> property -upon router startup: -<informaltable> -<tgroup cols=2> -<tbody> -<row> -<entry>0</entry> -<entry>Do not add user id. (default)</entry> -</row> -<row> -<entry>1</entry> -<entry>Add user id.</entry> -</row> -<row> -<entry>2</entry> -<entry>Add user id with prepended underscore.</entry> -</row> -</tbody> -</tgroup> -</informaltable> -</para> -</section> -</section> - -<section><title>Glacier.Starter.Trace</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Starter.Trace=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -The router starter trace level: -<informaltable> -<tgroup cols=2> -<tbody> -<row> -<entry>0</entry> -<entry>No router starter trace. (default)</entry> -</row> -<row> -<entry>1</entry> -<entry>Trace router startup exceptions. -</entry> -</row> -<row> -<entry>2</entry> -<entry>Also trace each successful router startup. -</entry> -</row> -</tbody> -</tgroup> -</informaltable> -</para> -</section> -</section> - -<section><title>Glacier.Starter.Certificate.Country</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Starter.Certificate.Country=<replaceable>country code</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -This property specifies the country code portion of the Distinguished Name -(DN) values that are placed into certificates generated by the Glacier -Router Starter for client applications and the Glacier Router itself. -Examples of valid values for this field are "US" for the United States and -"CA" for Canada. The default value is "US". -</para> -</section> -</section> - -<section><title>Glacier.Starter.Certificate.StateProvince</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Starter.Certificate.StateProvince=<replaceable>state/province code</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -This property specifies the state or province code portion of the -Distinguished Name (DN) values that are placed into certificates generated -by the Glacier Router Starter for client applications and the Glacier Router -itself. Examples of valid values for this field are "CA" for California and -"British Columbia" for British Columbia, Canada. The default value is "DC". -</para> -</section> -</section> - -<section><title>Glacier.Starter.Certificate.Locality</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Starter.Certificate.Locality=<replaceable>city or town name</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -This property specifies the locality portion of the Distinguished Name (DN) -values that are placed into certificates generated by the Glacier Router -Starter for client applications and the Glacier Router itself. The locality -is usually the name of the city or town. The default value is "Washington". -</para> -</section> -</section> - -<section><title>Glacier.Starter.Certificate.Organization</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Starter.Certificate.Organization=<replaceable>organization or company name</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -This property specifies the organization portion of the Distinguished Name -(DN) values that are placed into certificates generated by the Glacier -Router Starter for client applications and the Glacier Router itself. The -organization is usually the name of the company or organization to which -the certificate has been granted. The default value is "Some Company Inc.". -</para> -</section> -</section> - -<section><title>Glacier.Starter.Certificate.OrganizationalUnit</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Starter.Certificate.OrganizationalUnit=<replaceable>department</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -This property specifies the organizational unit portion of the Distinguished -Name (DN) values are placed into certificates generated by the -Glacier Router Starter for client applications and the Glacier Router itself. -The organization unit is usually the name of the department within the -company or organization structure to which the certificate has been -granted. The default value is "Sales". -</para> -</section> -</section> - -<section><title>Glacier.Starter.Certificate.CommonName</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Starter.Certificate.CommonName=<replaceable>contact name</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -This property specifies the common name portion of the Distinguished Name -(DN) values that are placed into certificates generated by the Glacier -Router Starter for client applications and the Glacier Router itself. The -common name is usually the name of the contact (a person's name) within -the company and department to which the certificate has been granted. The -default value is "John Doe". -</para> -</section> -</section> - -<section><title>Glacier.Starter.Certificate.BitStrength</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Starter.Certificate.BitStrength=<replaceable>number of bits</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -This property specifies the bit strength that is used in the generation -of certificates by the Glacier Router Starter for client applications and the -Glacier Router itself. This value is the modulus size of the RSA key. -</para> -<para> -Although modulus size is determined by the needs of the particular application, -care should be taken not to specify a size that is too large, as certificate -generation is an expensive operation. Sizes less than 512 bits are not -supported, and sizes that exceed 2048 bits should be chosen with generation -times in mind. The default value is 1024 bits. -</para> -</section> -</section> - -<section><title>Glacier.Starter.Certificate.SecondsValid</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Starter.Certificate.SecondsValid=<replaceable>seconds</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -This property specifies the number of seconds that certificates generated -by the Glacier Router Starter are valid before they expire. The default -value of 1 day (86,400 seconds). -</para> -</section> -</section> - -<section><title>Glacier.Starter.Certificate.IssuedAdjust</title> -<section><title>Synopsis</title> -<synopsis> -Glacier.Starter.Certificate.IssuedAdjust=<replaceable>(+/-) seconds</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -This property adjusts the issued timestamp on dynamically-generated -certificates for the Glacier Router. The default value is 0, which -sets the issued time based on the system time when the certificate is -actually created. Positive values adjust the timestamp into the -future, and negative values adjust the timestamp into the past -by the number of seconds indicated. This adjustment is relative to server -time. -</para> -</section> -</section> - -</section> - -<!-- ********************************************************************** --> -<section><title>&Freeze; Properties</title> -<!-- ********************************************************************** --> - -<section><title>Freeze.DbEnv.<replaceable>env-name</replaceable>.DbCheckpointPeriod</title> -<section><title>Synopsis</title> -<synopsis> -Freeze.DbEnv.<replaceable>env-name</replaceable>.DbCheckpointPeriod=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -Every Berkeley DB environment created by Freeze has an associated thread that checkpoints this environment every -<replaceable>num</replaceable> seconds. If <replaceable>num</replaceable> is less than 0, no checkpoint is performed. -Defaults to 120 seconds. -</para> -</section> -</section> - - -<section><title>Freeze.DbEnv.<replaceable>env-name</replaceable>.DbHome</title> -<section><title>Synopsis</title> -<synopsis> -Freeze.DbEnv.<replaceable>env-name</replaceable>.DbHome=<replaceable>db-home</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -Defines the home directory of this &Freeze; database -environment. Defaults to <replaceable>env-name</replaceable>. -</para> -</section> -</section> - -<section><title>Freeze.DbEnv.<replaceable>env-name</replaceable>.DbPrivate</title> -<section><title>Synopsis</title> -<synopsis> -Freeze.DbEnv.<replaceable>env-name</replaceable>.DbPrivate=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -If <replaceable>num</replaceable> is set to a value larger than zero, -&Freeze; instructs Berkeley DB to use process private memory instead of shared -memory. The default value is 1. Set it to 0 in order to run db_archive (or another Berkeley DB utility) on a running environment. -</para> -</section> -</section> - -<section><title>Freeze.DbEnv.<replaceable>env-name</replaceable>.DbRecoverFatal</title> -<section><title>Synopsis</title> -<synopsis> -Freeze.DbEnv.<replaceable>env-name</replaceable>.DbRecoverFatal=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -If <replaceable>num</replaceable> is set to a value larger than zero, -"fatal" recovery is performed when the environment is opened. The default value is 0. -</para> -</section> -</section> - -<section><title>Freeze.DbEnv.<replaceable>env-name</replaceable>.OldLogsAutoDelete</title> -<section><title>Synopsis</title> -<synopsis> -Freeze.DbEnv.<replaceable>env-name</replaceable>.OldLogsAutoDelete=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -If <replaceable>num</replaceable> is set to a value larger than zero, -old transactional logs no longer in use are deleted after each -periodic checkpoint (see -<literal>Freeze.DbEnv.<replaceable>env-name</replaceable>.DbCheckpointPeriod</literal>). The default value is 1. -</para> -</section> -</section> - -<section><title>Freeze.DbEnv.<replaceable>env-name</replaceable>.PeriodicCheckpointMinSize</title> -<section><title>Synopsis</title> -<synopsis> -Freeze.DbEnv.<replaceable>env-name</replaceable>.PeriodicCheckpointMinSize=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -<replaceable>num</replaceable> is the minimum size in kbytes for the -periodic checkpoint (see -<literal>Freeze.DbEnv.<replaceable>env-name</replaceable>.DbCheckpointPeriod</literal>). -This value is passed to Berkeley DB's checkpoint function. Defaults to -0 (which means no minimum). -</para> -</section> -</section> - - -<section><title>Freeze.Evictor.<replaceable>env-name</replaceable>.<replaceable>filename</replaceable>.MaxTxSize</title> -<section><title>Synopsis</title> -<synopsis> -Freeze.Evictor.<replaceable>env-name</replaceable>.<replaceable>filename</replaceable>.MaxTxSize=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> &Freeze; uses a background thread to save updates -to the database. Transactions are used to save many -facets together. <replaceable>num</replaceable> defines the maximum -number of facets saved per transaction. Defaults to 10 * -SaveSizeTrigger (see <literal>Freeze.Evictor.<replaceable>env-name</replaceable>.<replaceable>filename</replaceable>.SaveSizeTrigger</literal>); if this value is negative, the actual value is set to 100. -</para> -</section> -</section> - -<section><title>Freeze.Evictor.<replaceable>env-name</replaceable>.<replaceable>filename</replaceable>.SavePeriod</title> -<section><title>Synopsis</title> -<synopsis> -Freeze.Evictor.<replaceable>env-name</replaceable>.<replaceable>filename</replaceable>.SavePeriod=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> &Freeze; uses a background thread to save updates -to the database. After <replaceable>num</replaceable> milliseconds -without saving, if there is any facet created, modified or destroyed, this background thread wakes up to -save these facets. When <replaceable>num</replaceable> is 0, there is -no periodic saving. Defaults to 60,000. -</para> -</section> -</section> - - -<section><title>Freeze.Evictor.<replaceable>env-name</replaceable>.<replaceable>filename</replaceable>.SaveSizeTrigger</title> -<section><title>Synopsis</title> -<synopsis> -Freeze.Evictor.<replaceable>env-name</replaceable>.<replaceable>filename</replaceable>.SaveSizeTrigger=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> &Freeze; uses a background thread to save updates -to the database. When <replaceable>num</replaceable> is 0 or positive, -as soon as <replaceable>num</replaceable> or more facets have been -created, modified or destroyed, this background thread wakes up to -save them. When <replaceable>num</replaceable> is negative, there is no size trigger. Defaults to 10. -</para> -</section> -</section> - -<section><title>Freeze.Evictor.<replaceable>env-name</replaceable>.<replaceable>filename</replaceable>.StreamTimeout</title> -<section><title>Synopsis</title> -<synopsis> -Freeze.Evictor.<replaceable>env-name</replaceable>.<replaceable>filename</replaceable>.StreamTimeout=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> When the saving thread saves an object, it needs to lock -this object in order to get a consistent copy of the object's state. If the -lock cannot be acquired within <replaceable>num</replaceable> seconds, -a fatal error is generated. If a fatal error callback was registered -by the appplication, this callback is called; otherwise the program -is terminated immediately. -When <replaceable>num</replaceable> is 0 or negative, there is no -timeout. The default value is 0. -</para> -</section> -</section> - -<section><title>Freeze.Trace.DbEnv</title> -<section><title>Synopsis</title> -<synopsis> -Freeze.Trace.DbEnv=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -The &Freeze; database environment activity trace level: -<informaltable> -<tgroup cols=2> -<tbody> -<row> -<entry>0</entry> -<entry>No database environment activity trace. (default)</entry> -</row> -<row> -<entry>1</entry> -<entry>Trace database open and close.</entry> -</row> -<row> -<entry>2</entry> -<entry>Also trace checkpoints and the removal of old log files.</entry> -</row> -</tbody> -</tgroup> -</informaltable> -</para> -</section> -</section> - -<section><title>Freeze.Trace.Evictor</title> -<section><title>Synopsis</title> -<synopsis> -Freeze.Trace.Evictor=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -The &Freeze; evictor activity trace level: -<informaltable> -<tgroup cols=2> -<tbody> -<row> -<entry>0</entry> -<entry>No evictor activity trace. (default)</entry> -</row> -<row> -<entry>1</entry> -<entry>Trace &Ice; object and facet creation and destruction, facet streaming time, facet saving time, object eviction -(every 50 objects) and evictor deactivation.</entry> -</row> -<row> -<entry>2</entry> -<entry>Also trace object lookups, and all object evictions.</entry> -</row> -<row> -<entry>3</entry> -<entry>Also trace object retrieval from the database.</entry> -</row> -</tbody> -</tgroup> -</informaltable> -</para> -</section> -</section> - -<section><title>Freeze.Trace.Map</title> -<section><title>Synopsis</title> -<synopsis> -Freeze.Trace.Map=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -The &Freeze; map activity trace level: -<informaltable> -<tgroup cols=2> -<tbody> -<row> -<entry>0</entry> -<entry>No map activity trace. (default)</entry> -</row> -<row> -<entry>1</entry> -<entry>Trace database open and close.</entry> -</row> -<row> -<entry>2</entry> -<entry>Also trace iterator and transaction operations, and reference -counting of the underlying database.</entry> -</row> -</tbody> -</tgroup> -</informaltable> -</para> -</section> -</section> - -<section><title>Freeze.Warn.Deadlocks</title> -<section><title>Synopsis</title> -<synopsis> -Freeze.Warn.Deadlocks=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -If <replaceable>num</replaceable> is set to a value larger than zero, -&Freeze; logs a warning message when a deadlock occur. The default value is 0. -</para> -</section> -</section> - -<section><title>Freeze.Warn.CloseInFinalize</title> -<section><title>Synopsis</title> -<synopsis> -Freeze.Warn.CloseInFinalize=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -If <replaceable>num</replaceable> is set to a value larger than zero, -&Freeze; logs a warning message when an application neglects to explicitly -close a map iterator. The default value is 1. (Java only) -</para> -</section> -</section> - - -</section> - -<!-- ********************************************************************** --> -<section><title>&IcePatch2; Properties</title> -<!-- ********************************************************************** --> - -<section><title>IcePatch2.Endpoints</title> -<section><title>Synopsis</title> -<synopsis> -IcePatch2.Endpoints=<replaceable>endpoints</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -Specifies the endpoints of the &IcePatch2; server. This property is required -by both the IcePatch2 server and client. -</para> -</section> -</section> - -<section><title>IcePatch2.Admin.Endpoints</title> -<section><title>Synopsis</title> -<synopsis> -IcePatch2.Admin.Endpoints=<replaceable>endpoints</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -If this property is set, the &IcePatch2; server creates -an additional object of type <literal>IcePatch2::Admin</literal>. -The <literal>shutdown</literal> operation on this interface can be used -to remotely shut down the server. The endpoints specified by this -property should be secured against access from potentially -hostile clients. -</para> -</section> -</section> - -<section><title>IcePatch2.Identity</title> -<section><title>Synopsis</title> -<synopsis> -IcePatch2.Identity=<replaceable>identity</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -This property determines the object ID of the <literal>IcePatch2::FileServer</literal> -singleton object offered by the &IcePatch2; server. The default -value is <literal>IcePatch2/server</literal>. -</para> -</section> -</section> - -<section><title>IcePatch2.AdminIdentity</title> -<section><title>Synopsis</title> -<synopsis> -IcePatch2.AdminIdentity=<replaceable>identity</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -This property determines the object ID of the <literal>IcePatch2::Admin</literal> -singleton object offered by the &IcePatch2; server. The default -value is <literal>IcePatch2/admin</literal>. -</para> -</section> -</section> - -<section><title>IcePatch2.Directory</title> -<section><title>Synopsis</title> -<synopsis> -IcePatch2.Directory=<replaceable>dir</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -The &IcePatch2; server uses this property to determine the data -directory if no data directory is specified on the command line. -</para> -<para> -This property is also read by the <literal>IcePatch2::Patcher</literal> -utility class to determine the data directory. The property -must be set before the class is instantiated. -</para> -</section> -</section> - -<section><title>IcePatch2.MaxReadSize</title> -<section><title>Synopsis</title> -<synopsis> -IcePatch2.MaxReadSize=<replaceable>kilobytes</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -The &IcePatch2; server uses this property to limit the amount -of data that is returned by the <literal>getFileCompressed</literal> -operation. The default value is <literal>256</literal>. -</para> -</section> -</section> - -<section><title>IcePatch2.ChunkSize</title> -<section><title>Synopsis</title> -<synopsis> -IcePatch2.ChunkSize=<replaceable>kilobytes</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -The &IcePatch2; client uses this property to determine -how many kilobytes are retrieved with each call to -<literal>getFileCompressed</literal>. -</para> -<para> -This property is also read by the <literal>IcePatch2::Patcher</literal> -utility class. The property must be set before the class is instantiated. -</para> -<para> -The default value is <literal>100</literal>. -</para> -</section> -</section> - -<section><title>IcePatch2.Remove</title> -<section><title>Synopsis</title> -<synopsis> -IcePatch2.Remove=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -This property determines whether the &IcePatch2; client deletes -files that exist locally, but not on the server. A negative or -zero value prevents removal of files. A value of <literal>1</literal> -enables removal and causes the client to halt with an error if -removal of a file fails. A value of <literal>2</literal> or greater -also enables removal, but causes the client to silently ignore errors -during removal. -</para> -<para> -This property is also read by the <literal>IcePatch2::Patcher</literal> -utility class. The property must be set before the class is instantiated. -</para> -<para> -The default value is <literal>1</literal>. -</para> -</section> -</section> - -<section><title>IcePatch2.Thorough</title> -<section><title>Synopsis</title> -<synopsis> -IcePatch2.Thorough=<replaceable>num</replaceable> -</synopsis> -</section> -<section> -<title>Description</title> -<para> -This property determines whether <literal>IcePatch2::Patcher</literal> -utility class recomputes checksums. Any value greater than zero is interpreted as true. -The property must be set before the class is instantiated. -The default value is <literal>0</literal> (false). -</para> -</section> -</section> - -</section> - -<!-- ********************************************************************** --> <section><title>&Glacier2; Properties</title> <!-- ********************************************************************** --> diff --git a/cpp/slice/IcePatch2/FileServer.ice b/cpp/slice/IcePatch2/FileServer.ice index 1da3cbf51bc..f57b7f6d11e 100644 --- a/cpp/slice/IcePatch2/FileServer.ice +++ b/cpp/slice/IcePatch2/FileServer.ice @@ -65,7 +65,8 @@ interface FileServer * Return the [FileInfoSeq] for the specified partition. If the partion * number is out of range, the operation throws [PartitionOutOfRangException]. * - * @param partition The partition number (in the range <literal>0</literal> to <NumPartitions> - 1</literal>). + * @param partition The partition number (in the range <literal>0</literal> + * to <literal>NumPartitions - 1</literal>). * * @return A sequence containing the [FileInfo] structures for files in the specified partition. **/ @@ -76,7 +77,7 @@ interface FileServer * * Return the checksums for all partitions. * - * @return A sequence containing [NumPartitions] checksums. Partitions + * @return A sequence containing <literal>NumPartitions</literal> checksums. Partitions * with a checksum that differs from the previous checksum for the same partition * contain updated files. Partitions with a checksum that is identical to the * previous checksum do not contain updated files. |