43 lines
16 KiB
HTML
43 lines
16 KiB
HTML
|
<html><head><meta http-equiv="X-UA-Compatible" content="IE=edge" /><link rel="shortcut icon" href="../icons/favicon.ico" /><link rel="stylesheet" type="text/css" href="../styles/branding.css" /><link rel="stylesheet" type="text/css" href="../styles/branding-en-US.css" /><script type="text/javascript" src="../scripts/branding.js"> </script><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>ManagerConnection Properties</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="ManagerConnection class, properties" /><meta name="Microsoft.Help.Id" content="Properties.T:AsterNET.Manager.ManagerConnection" /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="AsterNET.Manager" /><meta name="file" content="Properties_T_AsterNET_Manager_ManagerConnection" /><meta name="guid" content="Properties_T_AsterNET_Manager_ManagerConnection" /><link rel="stylesheet" type="text/css" href="../styles/branding-Website.css" /><script type="text/javascript" src="../scripts/jquery-1.11.0.min.js"></script><script type="text/javascript" src="../scripts/branding-Website.js"></script></head><body onload="OnLoad('cs')"><input type="hidden" id="userDataCache" class="userDataStyle" /><div class="pageHeader" id="PageHeader">AsterNet Class Library (Sandcastle documentation)<form id="SearchForm" method="get" action="#" onsubmit="javascript:TransferToSearchPage(); return false;"><input id="SearchTextBox" type="text" maxlength="200" /><button id="SearchButton" type="submit"></button></form></div><div class="pageBody"><div class="leftNav" id="leftNav"><div id="tocNav"><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="79b6241e-05a3-441c-b6a1-51f2b5b7f265.htm" title="AsterNet Class Library (Sandcastle documentation)" tocid="roottoc">AsterNet Class Library (Sandcastle documentation)</a></div><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="N_AsterNET_Manager.htm" title="AsterNET.Manager" tocid="N_AsterNET_Manager">AsterNET.Manager</a></div><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_Manager_ManagerConnection.htm" title="ManagerConnection Class" tocid="T_AsterNET_Manager_ManagerConnection">ManagerConnection Class</a></div><div class="toclevel1 current" data-toclevel="1" data-childrenloaded="true"><a class="tocExpanded" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="Properties_T_AsterNET_Manager_ManagerConnection.htm" title="ManagerConnection Properties" tocid="Properties_T_AsterNET_Manager_ManagerConnection">ManagerConnection Properties</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_ManagerConnection_AsteriskVersion.htm" title="AsteriskVersion Property " tocid="P_AsterNET_Manager_ManagerConnection_AsteriskVersion">AsteriskVersion Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_ManagerConnection_DefaultEventTimeout.htm" title="DefaultEventTimeout Property " tocid="P_AsterNET_Manager_ManagerConnection_DefaultEventTimeout">DefaultEventTimeout Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_ManagerConnection_DefaultResponseTimeout.htm" title="DefaultResponseTimeout Property " tocid="P_AsterNET_Manager_ManagerConnection_DefaultResponseTimeout">DefaultResponseTimeout Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="P_AsterNET_Manager_ManagerConnection_FireAllEvents.htm" title="FireAllEvents Property " tocid="P_AsterNET_Manager_ManagerConnection_FireAllEvents">FireAllEvents Property </a></div><div class="toclevel2" data-toclevel="2"><a data-tochas
|
|||
|
|
|
|||
|
|
</th><th>Name</th><th>Description</th></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_ManagerConnection_AsteriskVersion.htm">AsteriskVersion</a></td><td /></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_ManagerConnection_DefaultEventTimeout.htm">DefaultEventTimeout</a></td><td><div class="summary"> Sets the time in milliseconds the synchronous method
|
|||
|
|
will wait for a response and the last response event before throwing a TimeoutException.<br />
|
|||
|
|
Default is 5000.
|
|||
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_ManagerConnection_DefaultResponseTimeout.htm">DefaultResponseTimeout</a></td><td><div class="summary"> Sets the time in milliseconds the synchronous method
|
|||
|
|
will wait for a response before throwing a TimeoutException.<br />
|
|||
|
|
Default is 2000.
|
|||
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_ManagerConnection_FireAllEvents.htm">FireAllEvents</a></td><td><div class="summary">
|
|||
|
|
If this property set to <b>true</b> then ManagerConnection send all unassigned events to UnhandledEvent handler,<br />
|
|||
|
|
if set to <b>false</b> then all unassgned events lost and send only UnhandledEvent.<br />
|
|||
|
|
Default: <b>false</b></div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_ManagerConnection_Hostname.htm">Hostname</a></td><td><div class="summary"> Sets the hostname of the asterisk server to connect to.<br />
|
|||
|
|
Default is localhost.
|
|||
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_ManagerConnection_KeepAlive.htm">KeepAlive</a></td><td><div class="summary">
|
|||
|
|
Should we attempt to reconnect when the connection is lost?<br />
|
|||
|
|
This is set to true after successful login and to false after logoff or after an authentication failure when keepAliveAfterAuthenticationFailure is false.
|
|||
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_ManagerConnection_KeepAliveAfterAuthenticationFailure.htm">KeepAliveAfterAuthenticationFailure</a></td><td><div class="summary"> Set to true to try reconnecting to ther asterisk serve
|
|||
|
|
even if the reconnection attempt threw an AuthenticationFailedException.<br />
|
|||
|
|
Default is false.
|
|||
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_ManagerConnection_Password.htm">Password</a></td><td><div class="summary">
|
|||
|
|
Sets the password to use to connect to the asterisk server. This is the
|
|||
|
|
password specified in asterisk's manager.conf file.
|
|||
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_ManagerConnection_PingInterval.htm">PingInterval</a></td><td><div class="summary">
|
|||
|
|
Timeout from Ping to Pong. If no Pong received send Disconnect event. Set to zero to disable.
|
|||
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_ManagerConnection_Port.htm">Port</a></td><td><div class="summary">
|
|||
|
|
Sets the port to use to connect to the asterisk server. This is the port
|
|||
|
|
specified in asterisk's manager.conf file.<br />
|
|||
|
|
Default is 5038.
|
|||
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_ManagerConnection_ReconnectIntervalFast.htm">ReconnectIntervalFast</a></td><td><div class="summary"> Default Fast Reconnect interval in milliseconds.</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_ManagerConnection_ReconnectIntervalMax.htm">ReconnectIntervalMax</a></td><td><div class="summary"> Default Slow Reconnect interval in milliseconds.</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_ManagerConnection_ReconnectRetryFast.htm">ReconnectRetryFast</a></td><td><div class="summary">
|
|||
|
|
Default Fast Reconnect retry counter.
|
|||
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_ManagerConnection_ReconnectRetryMax.htm">ReconnectRetryMax</a></td><td><div class="summary"> Default Maximum Reconnect retry counter.</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_ManagerConnection_SleepTime.htm">SleepTime</a></td><td><div class="summary"> Sets the time in milliseconds the synchronous methods
|
|||
|
|
SendAction(Action.ManagerAction) and
|
|||
|
|
SendAction(Action.ManagerAction, long) will sleep between two checks
|
|||
|
|
for the arrival of a response. This value should be rather small.<br />
|
|||
|
|
The sleepTime attribute is also used when checking for the protocol
|
|||
|
|
identifer.<br />
|
|||
|
|
Default is 50.
|
|||
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_ManagerConnection_SocketEncoding.htm">SocketEncoding</a></td><td><div class="summary">
|
|||
|
|
Socket Encoding - default ASCII
|
|||
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_ManagerConnection_Username.htm">Username</a></td><td><div class="summary">
|
|||
|
|
Sets the username to use to connect to the asterisk server. This is the
|
|||
|
|
username specified in asterisk's manager.conf file.
|
|||
|
|
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_AsterNET_Manager_ManagerConnection_Version.htm">Version</a></td><td /></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion" id="seeAlsoSection"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID1RB')" onkeypress="SectionExpandCollapse_CheckKey('ID1RB', event)" tabindex="0"><img id="ID1RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />See Also</span></div><div id="ID1RBSection" class="collapsibleSection"><h4 class="subHeading">Reference</h4><div class="seeAlsoStyle"><a href="T_AsterNET_Manager_ManagerConnection.htm">ManagerConnection Class</a></div><div class="seeAlsoStyle"><a href="N_AsterNET_Manager.htm">AsterNET.Manager Namespace</a></div></div></div></div><div id="pageFooter" class="pageFooter"> </div></body></html>
|