Adaptor.xml file

The Adaptor.xml file is the configuration file for individual network adaptors. It determines the number of threads that can be used by the adaptor, the communications ports the adaptor binds to, and the IP addresses or domains from which the adaptor can accept connections.

You can also implement SSL with the Adaptor.xml file, if you want to use different digital certificates for different adaptors.

Each adaptor has its own directory inside the server's conf directory. The name of the directory is the name of the adaptor. Each adaptor directory must contain an Adaptor.xml file.

For example, the default adaptor included with the server at installation is named _defaultRoot_, and its directory is found in the conf/ directory. To change an adaptor's settings, edit the elements in its Adaptor.xml file.

To see the element structure and default values in the Adaptor.xml file, see the Adaptor.xml file installed with Adobe Flash Media Server in the RootInstall/conf/_defaultRoot_ directory.

Summary of elements

Adaptor.xml element	Description
`Adaptor`	Root element; contains all the other adaptor configuration elements.
`Allow`	Identifies the specific hosts from which clients can connect to the server.
`Deny`	Identifies those hosts whose clients' attempts to connect to the server(s) will be rejected.
`Edge`	Identifies an edge to configure for HTTP tunneling.
`Enable`	Enables or disables tunneling connections into this application.
`EnableAltVhost`	Determines if an alternate virtual host may be specified as a part of the RTMP URL as query parameter.
`HostPort`	Specifies the IP address and port(s) to bind to.
`HostPortList`	Container element; comprised of a list of `HostPort` elements.
`HTTPIdent`	Configures the server to respond to or reject an HTTP identification request from a client.
`HTTPIdent2`	Configures the server to respond to or reject a special HTTP request from a client before attempting an RTMPT connection to Flash Media Server.
`HTTPNull`	Configures the server to respond to or reject an HTTP GET request for the "/" resource from a client.
`HTTPTunnel`	Container element; the elements in this section configure the incoming HTTP tunneling connections.
`HTTPUserInfo`	Container element; the elements in this section configure the absolute path to XML files and the cache settings.
`IdleAckInterval`	Specifies the maximum time the server may wait before it returns an `ack` (acknowledgement code) for a client idle post.
`IdlePostInterval`	Specifies the interval at which the client should send idle posts to the server to indicate that the player has no data to send.
`IdleTimeout`	Specifies the maximum inactivity time, in seconds, for a tunnel session before it is closed.
`MaxFailures`	Specifies the maximum number of failures an edge server may incur before restarting.
`MaxSize`	Specifies maximum number of HTTP requests the server keeps in the cache.
`MaxWriteDelay`	Specifies how long the server waits for a write.
`MimeType`	Specifies the default MIME type header sent on tunnel responses.
`NeedClose`	Specifies whether HTTP 1.0 non-keepalive connections are to be closed once the response is written.
`NodeID`	Specifies a unique node identification to support the implementation of load balancers.
`Order`	Specifies the order in which to evaluate the `Allow` and `Deny` elements.
`Path`	Specifies the absolute path of the folder where the server looks for XML files supported by HTTPUserInfo.
`RecoveryTime`	Specifies the wait time for an edge server to pause after failing, before it restarts.
`Redirect`	Specifies whether or not the adaptor redirects unknown requests to an external server.
`ResourceLimits`	Container element; contains elements that configure the resources for an edge server.
`RTMP`	Container element; contains details and configurations for different versions of RTMP.
`RTMPE`	Specifies if enhanced (encrypted) RTMP can be used.
`SetCookie`	Specifies whether the adaptor sets a cookie.
`SSL`	Container element; contains elements to configure Flash Media Server as an SSL (Secure Sockets Layer) client for incoming SSL connections.
`SSLCertificateFile`	Specifies the name of the directory containing one or more CA certificates.
`SSLCertificateKeyFile`	Specifies the name of a file that contains one or more CA certificates in the PEM encryption format.
`SSLCipherSuite`	Specifies the encryption ciphers that Flash Media Server uses to secure incoming connections.
`SSLPassPhrase`	Specifies the passphrase to use for decrypting the private key file. If the private key file is not encrypted, leave this tag empty.
`SSLServerCtx`	Container element; contains elements to configure Flash Media Server as an SSL (Secure Sockets Layer) client for incoming SSL connections.
`SSLSessionTimeout`	This element specifies in minutes how long a SSL session remains valid.
`UpdateInterval`	Specifies how often the server refreshes the cache content for HTTPUserInfo, in milliseconds.
`WriteBufferSize`	Specifies the size in kilobytes of the write buffer.

Send me an e-mail when comments are added to this page | Comment Report