doc/opsplitter.html (145f2b9) - Blinker · BlinkenArea

opsplitter.html

<html>
  <head>
    <title>Blinker - Operator Connection Splitter</title>
  </head>
  <body>
    <h1>Blinker - Operator Connection Splitter</h1>
    <p>
      The operator connection splitter is a module to accept operator
      connections and allow the operator to select one of several
      modules to connect to by dialing a further number of the form
      <code>*12345678#</code>.
      When the called module closes the connection, the operator
      is connected to the splitter again and can select the next
      module to connect to.
      The empty number <code>*#</code> closes the incoming connection.
    </p>
    <h2>Configuration</h2>
    <p>
      The configuration of the operator connection splitter module
      with name <code>NAME</code> is located in the
      <code>opsplitters/NAME</code> subdirectory.
    </p>
    <h3>Sound File</h3>
    <p>
      While an operator is connected to the splitter module (e.g. via
      a phone connection), a sound file can be requested to be played.
      (In case of the phone connection, this file is located on the
      phone server.)
      The name of the sound to request is contained in the file
      <code>sound</code>.
      If this file does not exists, no sound is requested to be played.
    </p>
    <h3>Maximum Number of Connections</h3>
    <p>
      The maximum number of simultaneous connections can be limited
      by writing the limit to the file <code>maxconn</code>.
      If this file does not exists, the number of simultaneous connections
      is not limited.
    </p>
    <h3>Single Mode</h3>
    <p>
      In single mode, the operator connection splitter module makes sure that
      all outgoing connections go to the same target module (.
      The first connection works as usual.
      Additional connections are directly forwarded to the module chosen
      by the first connection.
      If no module has been selected by the first connection, no further
      incoming connections are accepted.
      <br>
      Single mode can be enabled by writing <code>true</code> to the file
      <code>single</code>.
    </p>
    <h3>Extensions / Phone Numbers</h3>
    <p>
      The virtual extensions (i.e. phone numbers) that can be called
      by dialing a number of the form <code>*12345678#</code>
      are configured in the subdirectory <code>extensions</code>.
      <br>
      Each extension is configured in its own subdirectory.
      E.g. the configuration for the number mentioned above
      resides in the subdirectory <code>extensions/12345678</code>.
    </p>
    <p>
      The configuration inside an extension consists of the following
      settings:
    </p>
    <h4>Target Operator Connection Slot</h4>
    <p>
      The file <code>target</code> contains the name of the operator interface to
      contact via an operator connection if the extension is called.
    </p>
    <h2>Operator Connection Interface</h2>
    <p>
    The name of the operator connection interface provided by this module
    is the module name, i.e., <code>opsplitters/NAME</code>.
    </p>
  </body>
</html>

Blinker

rename "module" to "target"