PageRenderTime 36ms CodeModel.GetById 19ms RepoModel.GetById 0ms app.codeStats 0ms

/pms-server/files/Pms/Core/ConnectionProvider-pm.html

https://gitlab.com/p-ms/pms-docs
HTML | 57 lines | 22 code | 30 blank | 5 comment | 0 complexity | fe0cf6c8851f9e06b3852c98b4826380 MD5 | raw file
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
    2. 

  2. 

  3. <html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Pms::Core::ConnectionProvider</title><link rel="stylesheet" type="text/css" href="../../../styles/main.css"><script language=JavaScript src="../../../javascript/main.js"></script><script language=JavaScript src="../../../javascript/prettify.js"></script><script language=JavaScript src="../../../javascript/searchdata.js"></script></head><body class="ContentPage" onLoad="NDOnLoad();prettyPrint();"><script language=JavaScript><!--
    4. 

  4. if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
    5. 

  5. 

  6. <!--  Generated by Natural Docs, version 1.52 -->
    7. 

  7. <!--  http://www.naturaldocs.org  -->
    8. 

  8. 

  9. <!-- saved from url=(0026)http://www.naturaldocs.org -->
    10. 

  10. 

  11. 

  12. 

  13. 

  14. <div id=Content><div class="CClass"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="Pms.Core.ConnectionProvider"></a>Pms::<wbr>Core::<wbr>ConnectionProvider</h1><div class=CBody><div class=ClassHierarchy><table border=0 cellspacing=0 cellpadding=0><tr><td><div class=CHParent><div class=CHEntry><a href="Object-pm.html#Pms.Core.Object" class=LClass id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">Pms::Core::Object</a></div></div></td></tr></table><div class=CHIndent><table border=0 cellspacing=0 cellpadding=0><tr><td><div class=CHCurrent><div class=CHEntry>Pms::Core::ConnectionProvider</div></div></td></tr></table><div class=CHIndent><table border=0 cellspacing=0 cellpadding=0><tr><td><div class=CHChild><div class=CHEntry><a href="../Net/WebSocket/ConnectionProvider-pm.html#Pms.Net.WebSocket.ConnectionProvider" class=LClass >Pms::Net::WebSocket::ConnectionProvider</a></div></div></td></tr></table></div></div></div><h4 class=CHeading>Description</h4><p>Implements the base class for all ConnectionProviders.&nbsp; A ConnectionProvider is a object that can accept incoming connection on a special device for example a Socket or a HTTP Request.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#Pms.Core.ConnectionProvider" >Pms::<wbr>Core::<wbr>ConnectionProvider</a></td><td class=SDescription>Implements the base class for all ConnectionProviders. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Pms.Core.ConnectionProvider.Signals" >Signals</a></td><td class=SDescription></td></tr><tr class="SSignal SIndent2 SMarked"><td class=SEntry><a href="#Pms.Core.ConnectionProvider.connectionAvailable" >connectionAvailable()</a></td><td class=SDescription>is emitted when a new connection is enqueued</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Pms.Core.ConnectionProvider.Variables" >Variables</a></td><td class=SDescription></td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#Pms.Core.ConnectionProvider.PmsEvents" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">%PmsEvents</a></td><td class=SDescription>See <a href="Object-pm.html#Pms.Core.Object" class=LClass id=link3 onMouseOver="ShowTip(event, 'tt1', 'link3')" onMouseOut="HideTip('tt1')">Pms::Core::Object</a></td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Pms.Core.ConnectionProvider.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#Pms.Core.ConnectionProvider.new" id=link4 onMouseOver="ShowTip(event, 'tt3', 'link4')" onMouseOut="HideTip('tt3')">new</a></td><td class=SDescription>Initializes the Object</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#Pms.Core.ConnectionProvider.nextConnection" id=link5 onMouseOver="ShowTip(event, 'tt4', 'link5')" onMouseOut="HideTip('tt4')">nextConnection</a></td><td class=SDescription>Returns the next pending connection in the queue</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#Pms.Core.ConnectionProvider.connectionAvailable" >connectionAvailable</a></td><td class=SDescription>Checks if there are pending connections</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#Pms.Core.ConnectionProvider.connectionsAvailable" id=link6 onMouseOver="ShowTip(event, 'tt5', 'link6')" onMouseOut="HideTip('tt5')">connectionsAvailable</a></td><td class=SDescription></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
    15. 

  15. 

  16. <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Pms.Core.ConnectionProvider.Signals"></a>Signals</h3></div></div>
    17. 

  17. 

  18. <div class="CSignal"><div class=CTopic><h3 class=CTitle><a name="Pms.Core.ConnectionProvider.connectionAvailable"></a>connectionAvailable()</h3><div class=CBody><h4 class=CHeading>Description</h4><p>is emitted when a new connection is enqueued</p></div></div></div>
    19. 

  19. 

  20. <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Pms.Core.ConnectionProvider.Variables"></a>Variables</h3></div></div>
    21. 

  21. 

  22. <div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="Pms.Core.ConnectionProvider.PmsEvents"></a>%PmsEvents</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">our %PmsEvents</td></tr></table></blockquote><h4 class=CHeading>Description</h4><p>See <a href="Object-pm.html#Pms.Core.Object" class=LClass id=link7 onMouseOver="ShowTip(event, 'tt1', 'link7')" onMouseOut="HideTip('tt1')">Pms::Core::Object</a></p></div></div></div>
    23. 

  23. 

  24. <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Pms.Core.ConnectionProvider.Functions"></a>Functions</h3></div></div>
    25. 

  25. 

  26. <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Pms.Core.ConnectionProvider.new"></a>new</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">sub new</td></tr></table></blockquote><p>Initializes the Object</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>$parent</td><td class=CDLDescription>the <a href="../Application-pm.html#Pms.Application" class=LClass >Pms::Application</a> object</td></tr></table></div></div></div>
    27. 

  27. 

  28. <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Pms.Core.ConnectionProvider.nextConnection"></a>nextConnection</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">sub nextConnection</td></tr></table></blockquote><p>Returns the next pending connection in the queue</p><h4 class=CHeading>Access</h4><p>Public</p><h4 class=CHeading>Returns</h4><p><b>undef</b> if no connection is available or a <a href="Connection-pm.html#Pms.Core.Connection" class=LClass id=link8 onMouseOver="ShowTip(event, 'tt6', 'link8')" onMouseOut="HideTip('tt6')">Pms::Core::Connection</a> reference</p></div></div></div>
    29. 

  29. 

  30. <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Pms.Core.ConnectionProvider.connectionAvailable"></a>connectionAvailable</h3><div class=CBody><p>Checks if there are pending connections</p><h4 class=CHeading>Access</h4><p>Public</p><h4 class=CHeading>Returns</h4><p>the number of pending connections</p></div></div></div>
    31. 

  31. 

  32. <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="Pms.Core.ConnectionProvider.connectionsAvailable"></a>connectionsAvailable</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">sub connectionsAvailable</td></tr></table></blockquote></div></div></div>
    33. 

  33. 

  34. </div><!--Content-->
    35. 

  35. 

  36. 

  37. <div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
    38. 

  38. 

  39. 

  40. <div id=Menu><div class=MEntry><div class=MFile><a href="../../main-pl.html">main.pl</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent6')">Pms</a><div class=MGroupContent id=MGroupContent6><div class=MEntry><div class=MFile><a href="../Application-pm.html">Application</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Core</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MFile><a href="Channel-pm.html">Channel</a></div></div><div class=MEntry><div class=MFile><a href="Connection-pm.html">Connection</a></div></div><div class=MEntry><div class=MFile id=MSelected>ConnectionProvider</div></div><div class=MEntry><div class=MFile><a href="Object-pm.html">Object</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent2')">Event</a><div class=MGroupContent id=MGroupContent2><div class=MEntry><div class=MFile><a href="../Event/Channel-pm.html">Channel</a></div></div><div class=MEntry><div class=MFile><a href="../Event/Command-pm.html">Command</a></div></div><div class=MEntry><div class=MFile><a href="../Event/Connect-pm.html">Connect</a></div></div><div class=MEntry><div class=MFile><a href="../Event/Disconnect-pm.html">Disconnect</a></div></div><div class=MEntry><div class=MFile><a href="../Event/Event-pm.html">Event</a></div></div><div class=MEntry><div class=MFile><a href="../Event/Join-pm.html">Join</a></div></div><div class=MEntry><div class=MFile><a href="../Event/Leave-pm.html">Leave</a></div></div><div class=MEntry><div class=MFile><a href="../Event/Message-pm.html">Message</a></div></div><div class=MEntry><div class=MFile><a href="../Event/NickChange-pm.html">NickChange</a></div></div><div class=MEntry><div class=MFile><a href="../Event/Topic-pm.html">Topic</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent3')">Modules</a><div class=MGroupContent id=MGroupContent3><div class=MEntry><div class=MFile><a href="../Modules/Backlog-pm.html">Backlog</a></div></div><div class=MEntry><div class=MFile><a href="../Modules/Motd-pm.html">Motd</a></div></div><div class=MEntry><div class=MFile><a href="../Modules/Security/Module-pm.html">Security::<wbr>Module</a></div></div><div class=MEntry><div class=MFile><a href="../Modules/Security/UserInfo-pm.html">Security::<wbr>UserInfo</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent4')">Net</a><div class=MGroupContent id=MGroupContent4><div class=MEntry><div class=MFile><a href="../Net/WebSocket/Backend-pm.html">Backend</a></div></div><div class=MEntry><div class=MFile><a href="../Net/WebSocket/Connection-pm.html">Connection</a></div></div><div class=MEntry><div class=MFile><a href="../Net/WebSocket/ConnectionProvider-pm.html">ConnectionProvider</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent5')">Prot</a><div class=MGroupContent id=MGroupContent5><div class=MEntry><div class=MFile><a href="../Prot/Messages-pm.html">Messages</a></div></div><div class=MEntry><div class=MFile><a href="../Prot/Netstring-pm.html">Netstring</a></div></div><div class=MEntry><div class=MFile><a href="../Prot/Parser-pm.html">Parser</a></div></div></div></div></div></div></div></div><div class=MEntry><div class=MFile><a href="../../PmsConfig-pm.html">PmsConfig</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent7')">Index</a><div class=MGroupContent id=MGroupContent7><div class=MEntry><div class=MIndex><a href="../../../index/General.html">Everything</a></div></div><div class=MEntry><div class=MIndex><a href="../../../index/Classes.html">Classes</a></div></div><div class=MEntry><div class=MIndex><a href="../../../index/Functions.html">Functions</a></div></div><div class=MEntry><div class=MIndex><a href="../../../index/Variables.html">Variables</a></div></div><div class=MEntry><div class=MIndex><a href="../../../index/Signals.html">Signals</a></div></div><div class=MEntry><div class=MIndex><a href="../../../index/Files.html">Files</a></div></div></div></div></div><script type="text/javascript"><!--
    41. 

  41. var searchPanel = new SearchPanel("searchPanel", "HTML", "../../../search");
    42. 

  42. --></script><div id=MSearchPanel class=MSearchPanelInactive><input type=text id=MSearchField value=Search onFocus="searchPanel.OnSearchFieldFocus(true)" onBlur="searchPanel.OnSearchFieldFocus(false)" onKeyUp="searchPanel.OnSearchFieldChange()"><select id=MSearchType onFocus="searchPanel.OnSearchTypeFocus(true)" onBlur="searchPanel.OnSearchTypeFocus(false)" onChange="searchPanel.OnSearchTypeChange()"><option  id=MSearchEverything selected value="General">Everything</option><option value="Classes">Classes</option><option value="Files">Files</option><option value="Functions">Functions</option><option value="Signals">Signals</option><option value="Variables">Variables</option></select></div><script language=JavaScript><!--
    43. 

  43. HideAllBut([1, 6, 2, 3], 8);// --></script></div><!--Menu-->
    44. 

  44. 

  45. 

  46. 

  47. <!--START_ND_TOOLTIPS-->
    48. 

  48. <div class=CToolTip id="tt1"><div class=CClass>This Package implements the Base Class for all Object in PMS that need to send signals or events.</div></div><div class=CToolTip id="tt2"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">our %PmsEvents</td></tr></table></blockquote>See Pms::Core::Object</div></div><div class=CToolTip id="tt3"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">sub new</td></tr></table></blockquote>Initializes the Object</div></div><div class=CToolTip id="tt4"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">sub nextConnection</td></tr></table></blockquote>Returns the next pending connection in the queue</div></div><div class=CToolTip id="tt5"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">sub connectionsAvailable</td></tr></table></blockquote></div></div><div class=CToolTip id="tt6"><div class=CClass>Represents the connection of a chatuser.</div></div><!--END_ND_TOOLTIPS-->
    49. 

  49. 

  50. 

  51. 

  52. 

  53. <div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div>
    54. 

  54. 

  55. 

  56. <script language=JavaScript><!--
    57. 

  57. if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>
    58.