<html>
<head>
<base href="https://docs.jboss.org/author">
<link rel="stylesheet" href="/author/s/en/2172/19/5/_/styles/combined.css?spaceKey=TEIID&forWysiwyg=true" type="text/css">
</head>
<body style="background: white;" bgcolor="white" class="email-body">
<div id="pageContent">
<div id="notificationFormat">
<div class="wiki-content">
<div class="email">
<h2><a href="https://docs.jboss.org/author/display/TEIID/Additional+Socket+Client+Settings">Additional Socket Client Settings</a></h2>
<h4>Page <b>edited</b> by <a href="https://docs.jboss.org/author/display/~kylin">Kylin Soong</a>
</h4>
<br/>
<h4>Changes (2)</h4>
<div id="page-diffs">
<table class="diff" cellpadding="0" cellspacing="0">
<tr><td class="diff-changed-lines" >A <span class="diff-deleted-words"style="color:#999;background-color:#fdd;text-decoration:line-through;">"teiid\-client\-settings.properties"</span> <span class="diff-added-words"style="background-color: #dfd;">"teiid-client-settings.properties"</span> file can be used to configure Teiid low level and [SSL|TEIID:SSL Client Connections] socket connection properties. Currently only a single properties file is expected per driver/classloader combination. A sample <span class="diff-deleted-words"style="color:#999;background-color:#fdd;text-decoration:line-through;">"teiid\-client\-settings.properties"</span> <span class="diff-added-words"style="background-color: #dfd;">"teiid-client-settings.properties"</span> file can be found inside the <span class="diff-deleted-words"style="color:#999;background-color:#fdd;text-decoration:line-through;">"teiid\-<version>\-client.jar"</span> <span class="diff-added-words"style="background-color: #dfd;">"teiid-<version>-client.jar"</span> file at the root called "teiid-client-settings.orig.properties". To customize the settings, extract this file, make a copy, change the property values accordingly, and place this file in the client application's classpath before the <span class="diff-deleted-words"style="color:#999;background-color:#fdd;text-decoration:line-through;">"teiid\-<version>\-client.jar"</span> <span class="diff-added-words"style="background-color: #dfd;">"teiid-<version>-client.jar"</span> file. Typically clients will not need to adjust the non-SSL properties. For reference the properties are: <br></td></tr>
<tr><td class="diff-unchanged" > <br> <br></td></tr>
<tr><td class="diff-snipped" >...<br></td></tr>
<tr><td class="diff-unchanged" ># a server ping may be treated as an error. <br># <br></td></tr>
<tr><td class="diff-unchanged" ># This is the lower bound for all other timeouts <br></td></tr>
<tr><td class="diff-unchanged" ># the JDBC login timeout. <br># <br></td></tr>
<tr><td class="diff-unchanged" ># Typically this should be left at the default of 1000 <br></td></tr>
<tr><td class="diff-unchanged" ># (1 second). Setting this value too low may cause read <br># errors. <br></td></tr>
<tr><td class="diff-snipped" >...<br></td></tr>
<tr><td class="diff-unchanged" ># socket to a particular cluster member with <br># client encryption and or SSL already established. <br></td></tr>
<tr><td class="diff-unchanged" ># <br></td></tr>
<tr><td class="diff-unchanged" ># Caching instances helps in 2 circumstances: <br># - when Connection pooling is not being used. <br># - load-balancing performance to a cluster <br># when using Connection pooling of the DataSource. <br></td></tr>
<tr><td class="diff-unchanged" ># <br></td></tr>
<tr><td class="diff-unchanged" ># This value should typically be a multiple of the <br></td></tr>
<tr><td class="diff-unchanged" ># cluster size. <br></td></tr>
<tr><td class="diff-unchanged" ># <br># Set to 0 to disable instance caching. <br></td></tr>
<tr><td class="diff-snipped" >...<br></td></tr>
<tr><td class="diff-unchanged" >org.teiid.sockets.maxObjectSize=33554432 <br> <br></td></tr>
<tr><td class="diff-added-lines" style="background-color: #dfd;"> <br># <br># Set to true to disable client ping <br># Default value is 'false' that means client ping are enable. The client ping guaranteed that the client session <br># have a relevant active server session(server hung, networking limited, connection reset will cause server session lose). <br># Usually, if the client have load balancing logic, the client ping is necessary <br># <br> <br> <br>org.teiid.sockets.DisablePing=false <br></td></tr>
<tr><td class="diff-unchanged" >{code} <br></td></tr>
</table>
</div> <h4>Full Content</h4>
<div class="notificationGreySide">
<p>A "teiid-client-settings.properties" file can be used to configure Teiid low level and <a href="/author/display/TEIID/SSL+Client+Connections" title="SSL Client Connections">SSL</a> socket connection properties. Currently only a single properties file is expected per driver/classloader combination. A sample "teiid-client-settings.properties" file can be found inside the "teiid-<version><del>client.jar" file at the root called "teiid-client-settings.orig.properties". To customize the settings, extract this file, make a copy, change the property values accordingly, and place this file in the client application's classpath before the "teiid</del><version>-client.jar" file. Typically clients will not need to adjust the non-SSL properties. For reference the properties are:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="theme: Confluence; brush: java; gutter: false" style="font-size:12px; font-family: ConfluenceInstalledFont,monospace;">
########################################
# Misc Socket Configuration
########################################
#
# The time in milliseconds for socket timeouts.
# Timeouts during the initialization, handshake, or
# a server ping may be treated as an error.
#
# This is the lower bound for all other timeouts
# the JDBC login timeout.
#
# Typically this should be left at the default of 1000
# (1 second). Setting this value too low may cause read
# errors.
#
org.teiid.sockets.soTimeout=1000
#
# The max number of cached server instances
# to reuse. A server instance is a connected
# socket to a particular cluster member with
# client encryption and or SSL already established.
#
# Caching instances helps in 2 circumstances:
# - when Connection pooling is not being used.
# - load-balancing performance to a cluster
# when using Connection pooling of the DataSource.
#
# This value should typically be a multiple of the
# cluster size.
#
# Set to 0 to disable instance caching.
#
org.teiid.sockets.maxCachedInstances=16
#
# Set the max time to live (in milliseconds) for non-execution
# synchronous calls.
#
org.teiid.sockets.synchronousttl=240000
#
# Set the socket receive buffer size (in bytes)
# 0 indicates that the default socket setting will be used.
#
org.teiid.sockets.receiveBufferSize=0
#
# Set the socket send buffer size (in bytes)
# 0 indicates that the default socket setting will be used.
#
org.teiid.sockets.sendBufferSize=0
#
# Set to true to enable Nagle's algorithm to conserve bandwidth
# by minimizing the number of segments that are sent.
#
org.teiid.sockets.conserveBandwidth=false
#
# Maximum number of bytes per server message.
# May need to be increased when using custom types and/or large batch sizes.
#
org.teiid.sockets.maxObjectSize=33554432
#
# Set to true to disable client ping
# Default value is 'false' that means client ping are enable. The client ping guaranteed that the client session
# have a relevant active server session(server hung, networking limited, connection reset will cause server session lose).
# Usually, if the client have load balancing logic, the client ping is necessary
#
org.teiid.sockets.DisablePing=false
</pre>
</div></div>
</div>
<div id="commentsSection" class="wiki-content pageSection">
<div style="float: right;" class="grey">
<a href="https://docs.jboss.org/author/users/removespacenotification.action?spaceKey=TEIID">Stop watching space</a>
<span style="padding: 0px 5px;">|</span>
<a href="https://docs.jboss.org/author/users/editmyemailsettings.action">Change email notification preferences</a>
</div>
<a href="https://docs.jboss.org/author/display/TEIID/Additional+Socket+Client+Settings">View Online</a>
|
<a href="https://docs.jboss.org/author/pages/diffpagesbyversion.action?pageId=72941739&revisedVersion=4&originalVersion=3">View Changes</a>
|
<a href="https://docs.jboss.org/author/display/TEIID/Additional+Socket+Client+Settings?showComments=true&showCommentArea=true#addcomment">Add Comment</a>
</div>
</div>
</div>
</div>
</div>
</body>
</html>