iAnywhere.com - -x option

-x option

Function

Sets network protocol and protocol options for MobiLink clients. These are used by the MobiLink synchronization server to listen for synchronization requests.

Syntax

dbmlsrv9 –c "connection-string"
–x protocol[ protocol-options ]...

protocol-options : ( keyword=value;... )

Description

Specify communications protocol through which to communicate with client applications. The default is TCPIP with port 2439.

Note for UltraLite users

If you are using an UltraLite Java application and you are using TLS security, the syntax of -x is slightly different. For details, see Using transport-layer security.

The allowed values of protocol are as follows:

tcpip Accept connections from applications via TCP/IP.
http Accept connections via the standard Web protocol. Client applications can pick their HTTP version and the MobiLink synchronization server adjusts on a per-connection basis.
https Accept connections via a variant of HTTP that handles secure transactions. The HTTPS stream implements HTTP over SSL/TLS using RSA encryption, and is compatible with any other HTTPS server.
https_fips Accept connections using the HTTPS protocol and FIPS-approved algorithms for encryption. HTTPS_FIPS uses separate FIPS 140-2 certified software. Servers using rsa_tls are compatible with clients using rsa_tls_fips, and servers using rsa_tls_fips are compatible with clients using rsa_tls. rsa_tls_fips can only be used with Adaptive Server Anywhere databases on Windows.

Optionally, you can also specify network protocol options, in the form option=value. You should separate multiple options with semicolons. Which options you specify depends on the protocol you choose.

TCP/IP options If you specify the tcpip protocol, you can optionally specify the following protocol options:

backlog=number-of-connections
The maximum number of remote connections before MobiLink should reject new synchronization requests, causing synchronization to fail on the client side. By specifying a backlog size, you can prevent clients from waiting to synchronize when the server is busy. If you do not specify a backlog size, clients will attempt to synchronize regardless of the size of the backlog.
host=hostname
The host name or IP number on which the MobiLink synchronization server should listen. The default value is localhost.
ignore=hostname A host name or IP number that will be ignored by the MobiLink synchronization server if it makes a connection. This option allows you to ignore requests from load balancers at the lowest possible level, preventing excessive output in the MobiLink server log and MobiLink Monitor output files. You can specify multiple hosts to ignore; for example -x tcpip(ignore=lb1;ignore=123.45.67.89).
liveness_timeout=n The amount of time, in seconds, after the last communication with a client before MobiLink aborts the synchronization. A value of 0 means that there is no timeout. This option is only effective if download acknowledgement on the client is set to off (the default). The default is 120 seconds.
port=portnumber The socket port number on which the MobiLink synchronization server should listen. The default port is 2439, which is the IANA registered port number for the MobiLink synchronization server.

security=cipher(keyword=value;...) All communication through this connection is to be encrypted and authenticated using transport-layer security. The cipher can be one of ecc_tls, rsa_tls, or rsa_tls_fips, for elliptic-curve encryption, RSA encryption, or RSA encryption that is FIPS-approved, respectively. rsa_tls_fips uses separate FIPS 140-2 certified software from Certicom but is compatible with clients using https (and version 9.0.2 or later). rsa_tls_fips can only be used with Adaptive Server Anywhere clients on Windows.

For backwards compatibility, ecc_tls can also be specified as certicom_tls.

The security parameters are certificate (the path and file name of the certificate that is to be used for server authentication), and certificate_password. You must use a certificate that matches the cipher suite you choose.

For more information, see Starting the MobiLink synchronization server with transport-layer security.

Separately licensable option required

Transport-layer security requires that you obtain the separately-licensable SQL Anywhere Studio security option and is subject to export regulations.

To order this component, see Separately-licensable components.

HTTP options If you specify the http protocol, you can optionally specify the following protocol options:
- backlog=number-of-connections
  The maximum number of remote connections before MobiLink should reject new synchronization requests, causing synchronization to fail on the client side. By specifying a backlog size, you can prevent clients from waiting to synchronize when the server is busy. If you do not specify a backlog size, clients will attempt to synchronize regardless of the size of the backlog.
- buffer_size=number
  The maximum body size for an HTTP message sent from MobiLink server, in bytes. Changing the option will decrease or increase the amount of memory allocated for sending HTTP messages. The default is 65 535 bytes.
- contd_timeout=seconds
  The number of seconds the MobiLink synchronization server waits to receive the next part of a partially completed synchronization before the synchronization is abandoned. You can tune this option to free MobiLink worker threads when the wait time indicates that the client will never continue the connection. The default value is 30 seconds.
- host=hostname The host name or IP number on which the MobiLink synchronization server should listen. The default value is localhost.
- port=portnumber The socket port number on which the MobiLink synchronization server should listen. The port number must be a decimal number that matches the port the MobiLink synchronization server is setup to monitor. The default port is 80.
- unknown_timeout=seconds The number of seconds the MobiLink synchronization server waits to receive HTTP headers on a new connection before the synchronization is abandoned. You can tune this option to free MobiLink worker threads when the wait time indicates that a network failure has occurred. The default value is 30 seconds.
- url_suffix=suffix The suffix to add to the URL on the first line of each HTTP request. This parameter can be used to help ensure that a particular client connects to the intended server. Values must match or synchronization will not be successful.
- version=http-version The MobiLink synchronization server automatically detects the HTTP version used by a client. This parameter is a string specifying the default version of HTTP to use in case the server cannot detect the method used by the client. You have a choice of 1.0 or 1.1. The default value is 1.1.

HTTPS or HTTPS_FIPS options The https communication stream uses RSA digital certificates for transport-layer security. The https_fips stream uses separate FIPS 140-2 certified software but is compatible with https.

For more information, see Starting the MobiLink synchronization server with transport-layer security.

Separately licensable option required

Transport-layer security requires that you obtain a separately-licensable SQL Anywhere Studio security option and is subject to export regulations.

To order this component, see Separately-licensable components.

If you specify the https protocol, you can optionally specify the following protocol options:

backlog=number-of-connections
The maximum number of remote connections before MobiLink should reject new synchronization requests, causing synchronization to fail on the client side. By specifying a backlog size, you can prevent clients from waiting to synchronize when the server is busy. If you do not specify a backlog size, clients will attempt to synchronize regardless of the size of the backlog.
buffer_size=number The maximum body size for an HTTPS message sent from MobiLink server, in bytes. Changing the option will decrease or increase the amount of memory allocated for sending HTTPS messages. The default is 65 535 bytes.
contd_timeout=seconds
The number of seconds the MobiLink synchronization server waits to receive the next part of a partially completed synchronization before the synchronization is abandoned. You can tune this option to free MobiLink worker threads when the wait time indicates that the client will never continue the connection. The default value is 30 seconds.
host=hostname The host name or IP number on which the MobiLink synchronization server should listen. The default value is localhost.
port=portnumber
The socket port number on which the MobiLink synchronization server should listen. The port number must be a decimal number that matches the port the MobiLink synchronization server is setup to monitor. The default port is 443.
certificate The path and file name of the certificate that is to be used for server authentication. This must be an RSA certificate.
certificate_password An optional parameter that specifies a password for the certificate.
For more information about security, see MobiLink Transport-Layer Security.
unknown_timeout=seconds The number of seconds the MobiLink synchronization server waits to receive HTTP headers on a new connection before the synchronization is abandoned. You can tune this option to free MobiLink worker threads when the wait time indicates that a network failure has occurred. The default value is 30 seconds.
url_suffix=suffix The suffix to add to the URL on the first line of each HTTP request. This parameter can be used to help ensure that a particular client connects to the intended server. Values must match or synchronization will not be successful.
version=http-version The MobiLink synchronization server automatically detects the HTTP version used by a client. This parameter is a string specifying the default version of HTTP to use in case the server cannot detect the method used by the client. You have a choice of 1.0 or 1.1. The default value is 1.1.

Examples

The following command line sets the backlog size to 10 connections.

dbmlsrv9 -c dsn=asa90sample;uid=DBA;pwd=SQL -x http(backlog=10)