Section 7: FMS Connection Polling
[flixpub_conf.js]

FMS connection polling configuration settings. More...

Variables
var	flixpub_fmsmon_enable
	Enable FMS connection polling. [bool].
var	flixpub_fmsmon_poll_delay
	Delay between polling attempts [number, milliseconds].
var	flixpub_fmsmon_poll_timeout
	Polling timeout [number, milliseconds].
var	flixpub_fmsmon_poll_func
	Polling function name [string].
var	flixpub_fmsmon_poll_args
	Arguments for polling function [Array].

---

Detailed Description

This section details the parameters that control the reference application's ability to poll the connection to the remote FMS.

---

Variable Documentation

var flixpub_fmsmon_enable

Setting flixpub_fmsmon_enable to true to enables FMS connection polling.

Precondition:

Polling requires the presence of a function in the server side action script that returns at least 1 byte of data to the plug-in.

See also:

flixpub_fmsmon_poll_delay
flixpub_fmsmon_poll_timeout
flixpub_fmsmon_poll_func

var flixpub_fmsmon_poll_delay

flixpub_fmsmon_poll_delay controls the number milliseconds the plug-in waits between polling attempts.

Note:

Polling attempts will be flixpub_fmsmon_poll_delay + flixpub_fmsmon_poll_timeout milliseconds apart when a timeout occurs.

var flixpub_fmsmon_poll_timeout

flixpub_fmsmon_poll_timeout controls the number of milliseconds the plug-ins wait for a response from the server side action script function before a timeout occurs

Note:

Polling attempts will be flixpub_fmsmon_poll_delay + flixpub_fmsmon_poll_timeout milliseconds apart when a timeout occurs.

var flixpub_fmsmon_poll_func

Name of the server side action script function the plug-in should call for connection monitoring.

Action Script Example

The following is a basic example of setting up the server side action script function.

      function client_ping()
      {
          // just some logging
          trace("ping: flixpub client polled");

          // response message
          var s = "this must not be empty";

          // Client.call the flixpub plug-in
          this.call("make_up_any_name_you_want", null, s);

          // just some logging
          trace("called client fn with {" + s + "}");
      }

      // prototype the function
      Client.prototype.ping = client_ping;

Note:

• The above example assumes flixpub_fmsmon_poll_func is set to "ping".
• The plug-ins will pass args to the function if they are specified.

See also:

flixpub_fmsmon_poll_args.

var flixpub_fmsmon_poll_args

Strings added to the flixpub_fmsmon_poll_args array will be passed to the FMS action script function as individual arguments in array order.

See also:

flixpub_fmsmon_poll_func

---