complexType "client"

Namespace: | http://www.terracotta.org/config
Content: | complex, 3 elements
Defined: | globally in terracotta-4.xsd, see XML source
Includes: | definitions of 3 elements
Used: | at 1 location

XML Representation Summary
<...>
Content: | modules? × logs? × dso?
</...>

Content Elements (3):

  dso (type dso-client-data), logs (type path), | modules (type modules)

All Direct / Indirect Based Elements (1):

  clients (type client) |

Known Usage Locations

- As direct type of elements (1):

  clients (type client) |

Annotation
This section contains settings that affect all clients that connect to the system. Note that while these settings are applied uniformly across all clients, this does not prevent you from applying different settings to various clients. There are two ways of doing this: - Certain parameters ('logs', below) undergo parameter expansion before being used by the client. This allows you to use various predefined substitutions (like '%h' for host), or a general one (%(myprop) to use the value of Java system property 'myprop'), for these values; expansions are carried out in each client's JVM independently. - For each client to have its own configuration you can set 'tc.config' to the configuration file. If the configuration model is production then the 'application' section for all of the clients comes from the application section of the server's config file.
XML Source

<xs:complexType name="client"> <xs:annotation> <xs:documentation> This section contains settings that affect all clients that connect to the system. Note that while these settings are applied uniformly across all clients, this does not prevent you from applying different settings to various clients. There are two ways of doing this: - Certain parameters ('logs', below) undergo parameter expansion before being used by the client. This allows you to use various predefined substitutions (like '%h' for host), or a general one (%(myprop) to use the value of Java system property 'myprop'), for these values; expansions are carried out in each client's JVM independently. - For each client to have its own configuration you can set 'tc.config' to the configuration file. If the configuration model is production then the 'application' section for all of the clients comes from the application section of the server's config file. </xs:documentation> </xs:annotation> <xs:all> <xs:element minOccurs="0" name="modules" type="modules"> <xs:annotation> <xs:documentation> This section contains the list of modules to use in the client. </xs:documentation> </xs:annotation> </xs:element> <xs:element default="logs-%i" minOccurs="0" name="logs" type="path"> <xs:annotation> <xs:documentation> Where should the client write its log files? This value undergoes parameter substitution before being used; thus, a value like 'client-logs-%h' would expand to 'client-logs-banana' if running on host 'banana'. If this is a relative path, then it is interpreted relative to the current working directory of the client (that is, the directory you were in when you started the program that uses Terracotta services). It is thus recommended that you specify an absolute path here. Default: 'logs-%i'; this places the logs in a directory relative to the directory you were in when you invoked the program that uses Terracotta services (your client), and calls that directory, for example, 'logs-10.0.0.57' if the machine that the client is on has assigned IP address 10.0.0.57. </xs:documentation> </xs:annotation> </xs:element> <xs:element minOccurs="0" name="dso" type="dso-client-data"> <xs:annotation> <xs:documentation> This section contains data for Terracotta DSO that's specific to the DSO client only. </xs:documentation> </xs:annotation> </xs:element> </xs:all> </xs:complexType>

Content Element Detail
dso

  This section contains data for Terracotta DSO that's specific to the DSO client only.

  Type: | dso-client-data, complex content
  Defined: | locally, within this complexType

  XML Source

  <xs:element minOccurs="0" name="dso" type="dso-client-data"> <xs:annotation> <xs:documentation> This section contains data for Terracotta DSO that's specific to the DSO client only. </xs:documentation> </xs:annotation> </xs:element>

logs

  Where should the client write its log files? This value undergoes parameter substitution before being used; thus, a value like 'client-logs-%h' would expand to 'client-logs-banana' if running on host 'banana'. If this is a relative path, then it is interpreted relative to the current working directory of the client (that is, the directory you were in when you started the program that uses Terracotta services). It is thus recommended that you specify an absolute path here. Default: 'logs-%i'; this places the logs in a directory relative to the directory you were in when you invoked the program that uses Terracotta services (your client), and calls that directory, for example, 'logs-10.0.0.57' if the machine that the client is on has assigned IP address 10.0.0.57.

  Type: | path, simple content
  Default: | "logs-%i"
  Defined: | locally, within this complexType

  XML Source

  <xs:element default="logs-%i" minOccurs="0" name="logs" type="path"> <xs:annotation> <xs:documentation> Where should the client write its log files? This value undergoes parameter substitution before being used; thus, a value like 'client-logs-%h' would expand to 'client-logs-banana' if running on host 'banana'. If this is a relative path, then it is interpreted relative to the current working directory of the client (that is, the directory you were in when you started the program that uses Terracotta services). It is thus recommended that you specify an absolute path here. Default: 'logs-%i'; this places the logs in a directory relative to the directory you were in when you invoked the program that uses Terracotta services (your client), and calls that directory, for example, 'logs-10.0.0.57' if the machine that the client is on has assigned IP address 10.0.0.57. </xs:documentation> </xs:annotation> </xs:element>

modules

  This section contains the list of modules to use in the client.

  Type: | modules, complex content
  Defined: | locally, within this complexType

  XML Source

  <xs:element minOccurs="0" name="modules" type="modules"> <xs:annotation> <xs:documentation> This section contains the list of modules to use in the client. </xs:documentation> </xs:annotation> </xs:element>

XML Schema documentation generated with DocFlex/XML (Kit) v1.6.2 DocFlex/XML is a powerful template-driven documentation and report generator from any data stored in XML files. Based on an innovative technology developed by FILIGRIS WORKS, this new tool offers virtuoso data querying and formatting capabilities not found in anything else! Need to convert your XML data into a clear nice-looking documentation or reports? Web-ready hypertext HTML or printable MS Word / OpenOffice.org friendly RTF? DocFlex/XML may be a cheap, quick and effective solution exactly for this task! Have questions? Not sure how to use it? Just send us e-mail to contact@filigris.com and we are always happy to help you! See also our services at www.filigris.com