diff options
Diffstat (limited to 'doc/apidocs/nbxmpp.smacks.Smacks-class.html')
| -rw-r--r-- | doc/apidocs/nbxmpp.smacks.Smacks-class.html | 500 |
1 files changed, 500 insertions, 0 deletions
diff --git a/doc/apidocs/nbxmpp.smacks.Smacks-class.html b/doc/apidocs/nbxmpp.smacks.Smacks-class.html new file mode 100644 index 0000000..73a88b1 --- /dev/null +++ b/doc/apidocs/nbxmpp.smacks.Smacks-class.html @@ -0,0 +1,500 @@ +<?xml version="1.0" encoding="ascii"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> + <title>nbxmpp.smacks.Smacks</title> + <link rel="stylesheet" href="epydoc.css" type="text/css" /> + <script type="text/javascript" src="epydoc.js"></script> +</head> + +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<!-- ==================== NAVIGATION BAR ==================== --> +<table class="navbar" border="0" width="100%" cellpadding="0" + bgcolor="#a0c0ff" cellspacing="0"> + <tr valign="middle"> + <!-- Home link --> + <th> <a + href="nbxmpp-module.html">Home</a> </th> + + <!-- Tree link --> + <th> <a + href="module-tree.html">Trees</a> </th> + + <!-- Index link --> + <th> <a + href="identifier-index.html">Indices</a> </th> + + <!-- Help link --> + <th> <a + href="help.html">Help</a> </th> + + <!-- Project homepage --> + <th class="navbar" align="right" width="100%"> + <table border="0" cellpadding="0" cellspacing="0"> + <tr><th class="navbar" align="center" + ><a class="navbar" target="_top" href="http://python-nbxmpp.gajim.org">python-nbxmpp</a></th> + </tr></table></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <span class="breadcrumbs"> + <a href="nbxmpp-module.html">Package nbxmpp</a> :: + <a href="nbxmpp.smacks-module.html">Module smacks</a> :: + Class Smacks + </span> + </td> + <td> + <table cellpadding="0" cellspacing="0"> + <!-- hide/show private --> + <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" + onclick="toggle_private();">hide private</a>]</span></td></tr> + <tr><td align="right"><span class="options" + >[<a href="frames.html" target="_top">frames</a + >] | <a href="nbxmpp.smacks.Smacks-class.html" + target="_top">no frames</a>]</span></td></tr> + </table> + </td> + </tr> +</table> +<!-- ==================== CLASS DESCRIPTION ==================== --> +<h1 class="epydoc">Class Smacks</h1><p class="nomargin-top"><span class="codelink"><a href="nbxmpp.smacks-pysrc.html#Smacks">source code</a></span></p> +<p>This is Smacks is the Stream Management class. It takes care of requesting +and sending acks. Also, it keeps track of the unhandled outgoing stanzas.</p> +<p>The dispatcher has to be able to access this class to increment the +number of handled stanzas</p> + +<!-- ==================== INSTANCE METHODS ==================== --> +<a name="section-InstanceMethods"></a> +<table class="summary" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="table-header"> + <td colspan="2" class="table-header"> + <table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr valign="top"> + <td align="left"><span class="table-header">Instance Methods</span></td> + <td align="right" valign="top" + ><span class="options">[<a href="#section-InstanceMethods" + class="privatelink" onclick="toggle_private();" + >hide private</a>]</span></td> + </tr> + </table> + </td> +</tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="nbxmpp.smacks.Smacks-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">con</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="nbxmpp.smacks-pysrc.html#Smacks.__init__">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="nbxmpp.smacks.Smacks-class.html#set_owner" class="summary-sig-name">set_owner</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">owner</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="nbxmpp.smacks-pysrc.html#Smacks.set_owner">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr class="private"> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="nbxmpp.smacks.Smacks-class.html#_neg_response" class="summary-sig-name" onclick="show_private();">_neg_response</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">disp</span>, + <span class="summary-sig-arg">stanza</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="nbxmpp.smacks-pysrc.html#Smacks._neg_response">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="nbxmpp.smacks.Smacks-class.html#negociate" class="summary-sig-name">negociate</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">resume</span>=<span class="summary-sig-default">True</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="nbxmpp.smacks-pysrc.html#Smacks.negociate">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="nbxmpp.smacks.Smacks-class.html#resume_request" class="summary-sig-name">resume_request</a>(<span class="summary-sig-arg">self</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="nbxmpp.smacks-pysrc.html#Smacks.resume_request">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="nbxmpp.smacks.Smacks-class.html#send_ack" class="summary-sig-name">send_ack</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">disp</span>, + <span class="summary-sig-arg">stanza</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="nbxmpp.smacks-pysrc.html#Smacks.send_ack">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="nbxmpp.smacks.Smacks-class.html#request_ack" class="summary-sig-name">request_ack</a>(<span class="summary-sig-arg">self</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="nbxmpp.smacks-pysrc.html#Smacks.request_ack">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="nbxmpp.smacks.Smacks-class.html#check_ack" class="summary-sig-name">check_ack</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">disp</span>, + <span class="summary-sig-arg">stanza</span>)</span><br /> + Checks if the number of stanzas sent are the same as the +number of stanzas received by the server. Pops stanzas that were +handled by the server from the queue.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="nbxmpp.smacks-pysrc.html#Smacks.check_ack">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="nbxmpp.smacks.Smacks-class.html#error_handling" class="summary-sig-name">error_handling</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">disp</span>, + <span class="summary-sig-arg">stanza</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="nbxmpp.smacks-pysrc.html#Smacks.error_handling">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +</table> +<!-- ==================== METHOD DETAILS ==================== --> +<a name="section-MethodDetails"></a> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="table-header"> + <td colspan="2" class="table-header"> + <table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr valign="top"> + <td align="left"><span class="table-header">Method Details</span></td> + <td align="right" valign="top" + ><span class="options">[<a href="#section-MethodDetails" + class="privatelink" onclick="toggle_private();" + >hide private</a>]</span></td> + </tr> + </table> + </td> +</tr> +</table> +<a name="__init__"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">con</span>)</span> + <br /><em class="fname">(Constructor)</em> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="nbxmpp.smacks-pysrc.html#Smacks.__init__">source code</a></span> + </td> + </tr></table> + + + <dl class="fields"> + </dl> +</td></tr></table> +</div> +<a name="set_owner"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">set_owner</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">owner</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="nbxmpp.smacks-pysrc.html#Smacks.set_owner">source code</a></span> + </td> + </tr></table> + + + <dl class="fields"> + </dl> +</td></tr></table> +</div> +<a name="_neg_response"></a> +<div class="private"> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">_neg_response</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">disp</span>, + <span class="sig-arg">stanza</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="nbxmpp.smacks-pysrc.html#Smacks._neg_response">source code</a></span> + </td> + </tr></table> + + + <dl class="fields"> + </dl> +</td></tr></table> +</div> +<a name="negociate"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">negociate</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">resume</span>=<span class="sig-default">True</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="nbxmpp.smacks-pysrc.html#Smacks.negociate">source code</a></span> + </td> + </tr></table> + + + <dl class="fields"> + </dl> +</td></tr></table> +</div> +<a name="resume_request"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">resume_request</span>(<span class="sig-arg">self</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="nbxmpp.smacks-pysrc.html#Smacks.resume_request">source code</a></span> + </td> + </tr></table> + + + <dl class="fields"> + </dl> +</td></tr></table> +</div> +<a name="send_ack"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">send_ack</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">disp</span>, + <span class="sig-arg">stanza</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="nbxmpp.smacks-pysrc.html#Smacks.send_ack">source code</a></span> + </td> + </tr></table> + + + <dl class="fields"> + </dl> +</td></tr></table> +</div> +<a name="request_ack"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">request_ack</span>(<span class="sig-arg">self</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="nbxmpp.smacks-pysrc.html#Smacks.request_ack">source code</a></span> + </td> + </tr></table> + + + <dl class="fields"> + </dl> +</td></tr></table> +</div> +<a name="check_ack"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">check_ack</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">disp</span>, + <span class="sig-arg">stanza</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="nbxmpp.smacks-pysrc.html#Smacks.check_ack">source code</a></span> + </td> + </tr></table> + + Checks if the number of stanzas sent are the same as the +number of stanzas received by the server. Pops stanzas that were +handled by the server from the queue. + <dl class="fields"> + </dl> +</td></tr></table> +</div> +<a name="error_handling"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">error_handling</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">disp</span>, + <span class="sig-arg">stanza</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="nbxmpp.smacks-pysrc.html#Smacks.error_handling">source code</a></span> + </td> + </tr></table> + + + <dl class="fields"> + </dl> +</td></tr></table> +</div> +<br /> +<!-- ==================== NAVIGATION BAR ==================== --> +<table class="navbar" border="0" width="100%" cellpadding="0" + bgcolor="#a0c0ff" cellspacing="0"> + <tr valign="middle"> + <!-- Home link --> + <th> <a + href="nbxmpp-module.html">Home</a> </th> + + <!-- Tree link --> + <th> <a + href="module-tree.html">Trees</a> </th> + + <!-- Index link --> + <th> <a + href="identifier-index.html">Indices</a> </th> + + <!-- Help link --> + <th> <a + href="help.html">Help</a> </th> + + <!-- Project homepage --> + <th class="navbar" align="right" width="100%"> + <table border="0" cellpadding="0" cellspacing="0"> + <tr><th class="navbar" align="center" + ><a class="navbar" target="_top" href="http://python-nbxmpp.gajim.org">python-nbxmpp</a></th> + </tr></table></th> + </tr> +</table> +<table border="0" cellpadding="0" cellspacing="0" width="100%%"> + <tr> + <td align="left" class="footer"> + Generated by Epydoc 3.0.1 on Tue May 8 11:18:07 2012 + </td> + <td align="right" class="footer"> + <a target="mainFrame" href="http://epydoc.sourceforge.net" + >http://epydoc.sourceforge.net</a> + </td> + </tr> +</table> + +<script type="text/javascript"> + <!-- + // Private objects are initially displayed (because if + // javascript is turned off then we want them to be + // visible); but by default, we want to hide them. So hide + // them unless we have a cookie that says to show them. + checkCookie(); + // --> +</script> +</body> +</html> |