123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334 |
- <!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
- <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
- <meta charset="utf-8">
- <title>OSS_SNMP » \OSS_SNMP\MIBS\Asterisk\Channels</title>
- <meta name="author" content="Mike van Riel">
- <meta name="description" content="">
- <link href="../css/template.css" rel="stylesheet" media="all">
- <script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
- <link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
- <link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
- <link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
- </head>
- <body>
- <div class="navbar navbar-fixed-top">
- <div class="navbar-inner"><div class="container">
- <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">OSS_SNMP</a><div class="nav-collapse"><ul class="nav">
- <li class="dropdown">
- <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
- API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
- <li><a>Namespaces</a></li>
- <li><a href="../namespaces/OSS.html"><i class="icon-th"></i> OSS</a></li>
- <li><a href="../namespaces/OSS_SNMP.html"><i class="icon-th"></i> OSS_SNMP</a></li>
- </ul>
- </li>
- <li class="dropdown" id="charts-menu">
- <a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
- Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
- </li>
- <li class="dropdown" id="reports-menu">
- <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
- Reports <b class="caret"></b></a><ul class="dropdown-menu">
- <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
- <span class="label label-info">32</span></a></li>
- <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
- <ul><li>todo
- <span class="label label-info">1</span>
- </li></ul></a></li>
- <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
- <span class="label label-info">0</span></a></li>
- </ul>
- </li>
- </ul></div>
- </div></div>
- <div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div>
- </div>
- <div id="___" class="container">
- <noscript><div class="alert alert-warning">
- Javascript is disabled; several features are only available
- if Javascript is enabled.
- </div></noscript>
- <div class="row">
- <div class="span4">
- <span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
- <button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
- </div>
- <ul class="side-nav nav nav-list">
- <li class="nav-header">
- <i class="icon-custom icon-method"></i> Methods</li>
- <li class="method public "><a href="#active" title="active :: Returns the current number of active channels."><span class="description">Returns the current number of active channels.</span><pre>active()</pre></a></li>
- <li class="method public "><a href="#activeCalls" title="activeCalls :: Array of active calls on supported channels"><span class="description">Array of active calls on supported channels</span><pre>activeCalls()</pre></a></li>
- <li class="method public "><a href="#bridged" title="bridged :: Number of channels currently in a bridged state."><span class="description">Number of channels currently in a bridged state.</span><pre>bridged()</pre></a></li>
- <li class="method public "><a href="#descriptions" title="descriptions :: Array of supported channel type descriptions"><span class="description">Array of supported channel type descriptions</span><pre>descriptions()</pre></a></li>
- <li class="method public "><a href="#details" title="details :: Utility function to gather channel details together in an associative array."><span class="description">Utility function to gather channel details together in an associative array.</span><pre>details()</pre></a></li>
- <li class="method public "><a href="#deviceStates" title="deviceStates :: Array of supported channel type device state capability"><span class="description">Array of supported channel type device state capability</span><pre>deviceStates()</pre></a></li>
- <li class="method public "><a href="#names" title="names :: Array of supported channel type names"><span class="description">Array of supported channel type names</span><pre>names()</pre></a></li>
- <li class="method public "><a href="#progressIndications" title="progressIndications :: Array of supported channel type progress indication capability"><span class="description">Array of supported channel type progress indication capability</span><pre>progressIndications()</pre></a></li>
- <li class="method public "><a href="#supported" title="supported :: Returns the number of channel types (technologies) supported."><span class="description">Returns the number of channel types (technologies) supported.</span><pre>supported()</pre></a></li>
- <li class="method public "><a href="#transfers" title="transfers :: Array of supported channel type transfer capability"><span class="description">Array of supported channel type transfer capability</span><pre>transfers()</pre></a></li>
- <li class="nav-header">
- <i class="icon-custom icon-constant"></i> Constants</li>
- <li class="constant "><a href="#OID_ASTERISK_CHANNELS_ACTIVE" title="OID_ASTERISK_CHANNELS_ACTIVE :: "><span class="description">OID_ASTERISK_CHANNELS_ACTIVE</span><pre>OID_ASTERISK_CHANNELS_ACTIVE</pre></a></li>
- <li class="constant "><a href="#OID_ASTERISK_CHANNELS_BRIDGED" title="OID_ASTERISK_CHANNELS_BRIDGED :: "><span class="description">OID_ASTERISK_CHANNELS_BRIDGED</span><pre>OID_ASTERISK_CHANNELS_BRIDGED</pre></a></li>
- <li class="constant "><a href="#OID_ASTERISK_CHANNELS_SUPPORTED" title="OID_ASTERISK_CHANNELS_SUPPORTED :: "><span class="description">OID_ASTERISK_CHANNELS_SUPPORTED</span><pre>OID_ASTERISK_CHANNELS_SUPPORTED</pre></a></li>
- <li class="constant "><a href="#OID_ASTERISK_CHANNEL_TYPE_CHANNELS" title="OID_ASTERISK_CHANNEL_TYPE_CHANNELS :: "><span class="description">OID_ASTERISK_CHANNEL_TYPE_CHANNELS</span><pre>OID_ASTERISK_CHANNEL_TYPE_CHANNELS</pre></a></li>
- <li class="constant "><a href="#OID_ASTERISK_CHANNEL_TYPE_DESCRIPTION" title="OID_ASTERISK_CHANNEL_TYPE_DESCRIPTION :: "><span class="description">OID_ASTERISK_CHANNEL_TYPE_DESCRIPTION</span><pre>OID_ASTERISK_CHANNEL_TYPE_DESCRIPTION</pre></a></li>
- <li class="constant "><a href="#OID_ASTERISK_CHANNEL_TYPE_INDICATION" title="OID_ASTERISK_CHANNEL_TYPE_INDICATION :: "><span class="description">OID_ASTERISK_CHANNEL_TYPE_INDICATION</span><pre>OID_ASTERISK_CHANNEL_TYPE_INDICATION</pre></a></li>
- <li class="constant "><a href="#OID_ASTERISK_CHANNEL_TYPE_NAME" title="OID_ASTERISK_CHANNEL_TYPE_NAME :: "><span class="description">OID_ASTERISK_CHANNEL_TYPE_NAME</span><pre>OID_ASTERISK_CHANNEL_TYPE_NAME</pre></a></li>
- <li class="constant "><a href="#OID_ASTERISK_CHANNEL_TYPE_STATE" title="OID_ASTERISK_CHANNEL_TYPE_STATE :: "><span class="description">OID_ASTERISK_CHANNEL_TYPE_STATE</span><pre>OID_ASTERISK_CHANNEL_TYPE_STATE</pre></a></li>
- <li class="constant "><a href="#OID_ASTERISK_CHANNEL_TYPE_TRANSFER" title="OID_ASTERISK_CHANNEL_TYPE_TRANSFER :: "><span class="description">OID_ASTERISK_CHANNEL_TYPE_TRANSFER</span><pre>OID_ASTERISK_CHANNEL_TYPE_TRANSFER</pre></a></li>
- </ul>
- </div>
- <div class="span8">
- <a name="%5COSS_SNMP%5CMIBS%5CAsterisk%5CChannels" id="\OSS_SNMP\MIBS\Asterisk\Channels"></a><ul class="breadcrumb">
- <li>
- <a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
- </li>
- <li><a href="../namespaces/OSS_SNMP.html">OSS_SNMP</a></li>
- <span class="divider">\</span><li><a href="../namespaces/OSS_SNMP.MIBS.html">MIBS</a></li>
- <span class="divider">\</span><li><a href="../namespaces/OSS_SNMP.MIBS.Asterisk.html">Asterisk</a></li>
- <li class="active">
- <span class="divider">\</span><a href="../classes/OSS_SNMP.MIBS.Asterisk.Channels.html">Channels</a>
- </li>
- </ul>
- <div href="../classes/OSS_SNMP.MIBS.Asterisk.Channels.html" class="element class">
- <p class="short_description">A class for performing SNMP V2 queries on Asterisk</p>
- <div class="details">
- <p class="long_description"></p>
- <table class="table table-bordered">
- <tr>
- <th>see</th>
- <td>\OSS_SNMP\MIBS\Asterisk\https://wiki.asterisk.org/wiki/display/AST/Asterisk+MIB+Definitions</td>
- </tr>
- <tr>
- <th>copyright</th>
- <td>Copyright (c) 2012, Open Source Solutions Limited, Dublin, Ireland</td>
- </tr>
- <tr>
- <th>author</th>
- <td><a href="mailto:barry@opensolutions.ie">Barry O'Donovan</a></td>
- </tr>
- </table>
- <h3>
- <i class="icon-custom icon-method"></i> Methods</h3>
- <a name="active" id="active"></a><div class="element clickable method public active" data-toggle="collapse" data-target=".active .collapse">
- <h2>Returns the current number of active channels.</h2>
- <pre>active() : int</pre>
- <div class="labels"></div>
- <div class="row collapse"><div class="detail-description">
- <p class="long_description"><blockquote>
- <p>Current number of active channels.</p>
- </blockquote></p>
- <h3>Returns</h3>
- <div class="subelement response">
- <code>int</code>The current number of active channels.</div>
- </div></div>
- </div>
- <a name="activeCalls" id="activeCalls"></a><div class="element clickable method public activeCalls" data-toggle="collapse" data-target=".activeCalls .collapse">
- <h2>Array of active calls on supported channels</h2>
- <pre>activeCalls() : array</pre>
- <div class="labels"></div>
- <div class="row collapse"><div class="detail-description">
- <p class="long_description"><blockquote>
- <p>Number of active channels using the current technology.</p>
- </blockquote></p>
- <h3>Returns</h3>
- <div class="subelement response">
- <code>array</code>Active calls on supported channels</div>
- </div></div>
- </div>
- <a name="bridged" id="bridged"></a><div class="element clickable method public bridged" data-toggle="collapse" data-target=".bridged .collapse">
- <h2>Number of channels currently in a bridged state.</h2>
- <pre>bridged() : int</pre>
- <div class="labels"></div>
- <div class="row collapse"><div class="detail-description">
- <p class="long_description"><blockquote>
- <p>Number of channels currently in a bridged state.</p>
- </blockquote></p>
- <h3>Returns</h3>
- <div class="subelement response">
- <code>int</code>Array of active calls on supported channels</div>
- </div></div>
- </div>
- <a name="descriptions" id="descriptions"></a><div class="element clickable method public descriptions" data-toggle="collapse" data-target=".descriptions .collapse">
- <h2>Array of supported channel type descriptions</h2>
- <pre>descriptions() : array</pre>
- <div class="labels"></div>
- <div class="row collapse"><div class="detail-description">
- <p class="long_description"><blockquote>
- <p>Description of the channel type (technology).</p>
- </blockquote></p>
- <h3>Returns</h3>
- <div class="subelement response">
- <code>array</code>Supported channel type descriptions</div>
- </div></div>
- </div>
- <a name="details" id="details"></a><div class="element clickable method public details" data-toggle="collapse" data-target=".details .collapse">
- <h2>Utility function to gather channel details together in an associative array.</h2>
- <pre>details(bool $useIndex) : array</pre>
- <div class="labels"></div>
- <div class="row collapse"><div class="detail-description">
- <p class="long_description"><p>Returns an array of support channel types. For example:</p>
- <pre><code>Array
- (
- ....
- [SIP] => Array
- (
- [name] => SIP
- [index] => 5
- [description] => Session Initiation Protocol (SIP)
- [hasDeviceState] => 1
- [hasProgressIndications] => 1
- [canTransfer] => 1
- [activeCalls] => 0
- )
- ....
- )
- </code></pre>
- <p>If you chose to index by SNMP table entries, the above element would be indexed with <code>5</code> rather than <code>SIP</code>.</p></p>
- <h3>Parameters</h3>
- <div class="subelement argument">
- <h4>$useIndex</h4>
- <code>bool</code><p>If true, the array is indexed using the SNMP table index rather than the unique channel type name</p></div>
- <h3>Returns</h3>
- <div class="subelement response">
- <code>array</code>Channel details as an associative array</div>
- </div></div>
- </div>
- <a name="deviceStates" id="deviceStates"></a><div class="element clickable method public deviceStates" data-toggle="collapse" data-target=".deviceStates .collapse">
- <h2>Array of supported channel type device state capability</h2>
- <pre>deviceStates() : array</pre>
- <div class="labels"></div>
- <div class="row collapse"><div class="detail-description">
- <p class="long_description"><blockquote>
- <p>Whether the current technology can hold device states.</p>
- </blockquote></p>
- <h3>Returns</h3>
- <div class="subelement response">
- <code>array</code>Whether the current technology can hold device states.</div>
- </div></div>
- </div>
- <a name="names" id="names"></a><div class="element clickable method public names" data-toggle="collapse" data-target=".names .collapse">
- <h2>Array of supported channel type names</h2>
- <pre>names() : array</pre>
- <div class="labels"></div>
- <div class="row collapse"><div class="detail-description">
- <p class="long_description"><blockquote>
- <p>Unique name of the technology we are describing.</p>
- </blockquote></p>
- <h3>Returns</h3>
- <div class="subelement response">
- <code>array</code>Supported channel type names</div>
- </div></div>
- </div>
- <a name="progressIndications" id="progressIndications"></a><div class="element clickable method public progressIndications" data-toggle="collapse" data-target=".progressIndications .collapse">
- <h2>Array of supported channel type progress indication capability</h2>
- <pre>progressIndications() : array</pre>
- <div class="labels"></div>
- <div class="row collapse"><div class="detail-description">
- <p class="long_description"><blockquote>
- <p>Whether the current technology supports progress indication.</p>
- </blockquote></p>
- <h3>Returns</h3>
- <div class="subelement response">
- <code>array</code>Whether the current technology supports progress indication.</div>
- </div></div>
- </div>
- <a name="supported" id="supported"></a><div class="element clickable method public supported" data-toggle="collapse" data-target=".supported .collapse">
- <h2>Returns the number of channel types (technologies) supported.</h2>
- <pre>supported() : int</pre>
- <div class="labels"></div>
- <div class="row collapse"><div class="detail-description">
- <p class="long_description"><blockquote>
- <p>Number of channel types (technologies) supported.</p>
- </blockquote></p>
- <h3>Returns</h3>
- <div class="subelement response">
- <code>int</code>The number of channel types (technologies) supported.</div>
- </div></div>
- </div>
- <a name="transfers" id="transfers"></a><div class="element clickable method public transfers" data-toggle="collapse" data-target=".transfers .collapse">
- <h2>Array of supported channel type transfer capability</h2>
- <pre>transfers() : array</pre>
- <div class="labels"></div>
- <div class="row collapse"><div class="detail-description">
- <p class="long_description"><blockquote>
- <p>Whether the current technology supports transfers, where
- Asterisk can get out from inbetween two bridged channels.</p>
- </blockquote></p>
- <h3>Returns</h3>
- <div class="subelement response">
- <code>array</code>Whether the current technology transfers</div>
- </div></div>
- </div>
- <h3>
- <i class="icon-custom icon-constant"></i> Constants</h3>
- <a name="OID_ASTERISK_CHANNELS_ACTIVE" id="OID_ASTERISK_CHANNELS_ACTIVE"> </a><div class="element clickable constant OID_ASTERISK_CHANNELS_ACTIVE" data-toggle="collapse" data-target=".OID_ASTERISK_CHANNELS_ACTIVE .collapse">
- <h2>OID_ASTERISK_CHANNELS_ACTIVE</h2>
- <pre>OID_ASTERISK_CHANNELS_ACTIVE </pre>
- <div class="labels"></div>
- <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
- </div>
- <a name="OID_ASTERISK_CHANNELS_BRIDGED" id="OID_ASTERISK_CHANNELS_BRIDGED"> </a><div class="element clickable constant OID_ASTERISK_CHANNELS_BRIDGED" data-toggle="collapse" data-target=".OID_ASTERISK_CHANNELS_BRIDGED .collapse">
- <h2>OID_ASTERISK_CHANNELS_BRIDGED</h2>
- <pre>OID_ASTERISK_CHANNELS_BRIDGED </pre>
- <div class="labels"></div>
- <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
- </div>
- <a name="OID_ASTERISK_CHANNELS_SUPPORTED" id="OID_ASTERISK_CHANNELS_SUPPORTED"> </a><div class="element clickable constant OID_ASTERISK_CHANNELS_SUPPORTED" data-toggle="collapse" data-target=".OID_ASTERISK_CHANNELS_SUPPORTED .collapse">
- <h2>OID_ASTERISK_CHANNELS_SUPPORTED</h2>
- <pre>OID_ASTERISK_CHANNELS_SUPPORTED </pre>
- <div class="labels"></div>
- <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
- </div>
- <a name="OID_ASTERISK_CHANNEL_TYPE_CHANNELS" id="OID_ASTERISK_CHANNEL_TYPE_CHANNELS"> </a><div class="element clickable constant OID_ASTERISK_CHANNEL_TYPE_CHANNELS" data-toggle="collapse" data-target=".OID_ASTERISK_CHANNEL_TYPE_CHANNELS .collapse">
- <h2>OID_ASTERISK_CHANNEL_TYPE_CHANNELS</h2>
- <pre>OID_ASTERISK_CHANNEL_TYPE_CHANNELS </pre>
- <div class="labels"></div>
- <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
- </div>
- <a name="OID_ASTERISK_CHANNEL_TYPE_DESCRIPTION" id="OID_ASTERISK_CHANNEL_TYPE_DESCRIPTION"> </a><div class="element clickable constant OID_ASTERISK_CHANNEL_TYPE_DESCRIPTION" data-toggle="collapse" data-target=".OID_ASTERISK_CHANNEL_TYPE_DESCRIPTION .collapse">
- <h2>OID_ASTERISK_CHANNEL_TYPE_DESCRIPTION</h2>
- <pre>OID_ASTERISK_CHANNEL_TYPE_DESCRIPTION </pre>
- <div class="labels"></div>
- <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
- </div>
- <a name="OID_ASTERISK_CHANNEL_TYPE_INDICATION" id="OID_ASTERISK_CHANNEL_TYPE_INDICATION"> </a><div class="element clickable constant OID_ASTERISK_CHANNEL_TYPE_INDICATION" data-toggle="collapse" data-target=".OID_ASTERISK_CHANNEL_TYPE_INDICATION .collapse">
- <h2>OID_ASTERISK_CHANNEL_TYPE_INDICATION</h2>
- <pre>OID_ASTERISK_CHANNEL_TYPE_INDICATION </pre>
- <div class="labels"></div>
- <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
- </div>
- <a name="OID_ASTERISK_CHANNEL_TYPE_NAME" id="OID_ASTERISK_CHANNEL_TYPE_NAME"> </a><div class="element clickable constant OID_ASTERISK_CHANNEL_TYPE_NAME" data-toggle="collapse" data-target=".OID_ASTERISK_CHANNEL_TYPE_NAME .collapse">
- <h2>OID_ASTERISK_CHANNEL_TYPE_NAME</h2>
- <pre>OID_ASTERISK_CHANNEL_TYPE_NAME </pre>
- <div class="labels"></div>
- <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
- </div>
- <a name="OID_ASTERISK_CHANNEL_TYPE_STATE" id="OID_ASTERISK_CHANNEL_TYPE_STATE"> </a><div class="element clickable constant OID_ASTERISK_CHANNEL_TYPE_STATE" data-toggle="collapse" data-target=".OID_ASTERISK_CHANNEL_TYPE_STATE .collapse">
- <h2>OID_ASTERISK_CHANNEL_TYPE_STATE</h2>
- <pre>OID_ASTERISK_CHANNEL_TYPE_STATE </pre>
- <div class="labels"></div>
- <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
- </div>
- <a name="OID_ASTERISK_CHANNEL_TYPE_TRANSFER" id="OID_ASTERISK_CHANNEL_TYPE_TRANSFER"> </a><div class="element clickable constant OID_ASTERISK_CHANNEL_TYPE_TRANSFER" data-toggle="collapse" data-target=".OID_ASTERISK_CHANNEL_TYPE_TRANSFER .collapse">
- <h2>OID_ASTERISK_CHANNEL_TYPE_TRANSFER</h2>
- <pre>OID_ASTERISK_CHANNEL_TYPE_TRANSFER </pre>
- <div class="labels"></div>
- <div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
- </div>
- </div>
- </div>
- </div>
- </div>
- <div class="row"><footer class="span12">
- Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
- Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a5</a> and<br>
- generated on 2012-06-20T19:41:09+01:00.<br></footer></div>
- </div>
- </body>
- </html>
|