/usr/share/doc/python-socketio-doc/html/mixins.html is in python-socketio-doc 0.3.6-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>socketio.mixins — gevent-socketio 0.3.1 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.3.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="gevent-socketio 0.3.1 documentation" href="index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">gevent-socketio 0.3.1 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-socketio.mixins">
<span id="socketio-mixins"></span><span id="mixins-module"></span><h1><a class="reference internal" href="#module-socketio.mixins" title="socketio.mixins"><tt class="xref py py-mod docutils literal"><span class="pre">socketio.mixins</span></tt></a><a class="headerlink" href="#module-socketio.mixins" title="Permalink to this headline">ΒΆ</a></h1>
<p>These are general-purpose Mixins – for use with Namespaces – that are
generally useful for most simple projects, e.g. Rooms, Broadcast.</p>
<p>You’ll likely want to create your own Mixins.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">BroadcastMixin</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""Mix in this class with your Namespace to have a broadcast event method.</span>
<span class="sd"> Use it like this:</span>
<span class="sd"> class MyNamespace(BaseNamespace, BroadcastMixin):</span>
<span class="sd"> def on_chatmsg(self, event):</span>
<span class="sd"> self.broadcast_event('chatmsg', event)</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">broadcast_event</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">event</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> This is sent to all in the sockets in this particular Namespace,</span>
<span class="sd"> including itself.</span>
<span class="sd"> """</span>
<span class="n">pkt</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="s">"event"</span><span class="p">,</span>
<span class="n">name</span><span class="o">=</span><span class="n">event</span><span class="p">,</span>
<span class="n">args</span><span class="o">=</span><span class="n">args</span><span class="p">,</span>
<span class="n">endpoint</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">ns_name</span><span class="p">)</span>
<span class="k">for</span> <span class="n">sessid</span><span class="p">,</span> <span class="n">socket</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">socket</span><span class="o">.</span><span class="n">server</span><span class="o">.</span><span class="n">sockets</span><span class="o">.</span><span class="n">iteritems</span><span class="p">():</span>
<span class="n">socket</span><span class="o">.</span><span class="n">send_packet</span><span class="p">(</span><span class="n">pkt</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">broadcast_event_not_me</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">event</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> This is sent to all in the sockets in this particular Namespace,</span>
<span class="sd"> except itself.</span>
<span class="sd"> """</span>
<span class="n">pkt</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="s">"event"</span><span class="p">,</span>
<span class="n">name</span><span class="o">=</span><span class="n">event</span><span class="p">,</span>
<span class="n">args</span><span class="o">=</span><span class="n">args</span><span class="p">,</span>
<span class="n">endpoint</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">ns_name</span><span class="p">)</span>
<span class="k">for</span> <span class="n">sessid</span><span class="p">,</span> <span class="n">socket</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">socket</span><span class="o">.</span><span class="n">server</span><span class="o">.</span><span class="n">sockets</span><span class="o">.</span><span class="n">iteritems</span><span class="p">():</span>
<span class="k">if</span> <span class="n">socket</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">socket</span><span class="p">:</span>
<span class="n">socket</span><span class="o">.</span><span class="n">send_packet</span><span class="p">(</span><span class="n">pkt</span><span class="p">)</span>
</pre></div>
</div>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">RoomsMixin</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="nb">super</span><span class="p">(</span><span class="n">RoomsMixin</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="k">if</span> <span class="s">'rooms'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">session</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">session</span><span class="p">[</span><span class="s">'rooms'</span><span class="p">]</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span> <span class="c"># a set of simple strings</span>
<span class="k">def</span> <span class="nf">join</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">room</span><span class="p">):</span>
<span class="sd">"""Lets a user join a room on a specific Namespace."""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">session</span><span class="p">[</span><span class="s">'rooms'</span><span class="p">]</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_get_room_name</span><span class="p">(</span><span class="n">room</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">leave</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">room</span><span class="p">):</span>
<span class="sd">"""Lets a user leave a room on a specific Namespace."""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">session</span><span class="p">[</span><span class="s">'rooms'</span><span class="p">]</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_get_room_name</span><span class="p">(</span><span class="n">room</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">_get_room_name</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">room</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">ns_name</span> <span class="o">+</span> <span class="s">'_'</span> <span class="o">+</span> <span class="n">room</span>
<span class="k">def</span> <span class="nf">emit_to_room</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">room</span><span class="p">,</span> <span class="n">event</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">):</span>
<span class="sd">"""This is sent to all in the room (in this particular Namespace)"""</span>
<span class="n">pkt</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="s">"event"</span><span class="p">,</span>
<span class="n">name</span><span class="o">=</span><span class="n">event</span><span class="p">,</span>
<span class="n">args</span><span class="o">=</span><span class="n">args</span><span class="p">,</span>
<span class="n">endpoint</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">ns_name</span><span class="p">)</span>
<span class="n">room_name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_room_name</span><span class="p">(</span><span class="n">room</span><span class="p">)</span>
<span class="k">for</span> <span class="n">sessid</span><span class="p">,</span> <span class="n">socket</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">socket</span><span class="o">.</span><span class="n">server</span><span class="o">.</span><span class="n">sockets</span><span class="o">.</span><span class="n">iteritems</span><span class="p">():</span>
<span class="k">if</span> <span class="s">'rooms'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">socket</span><span class="o">.</span><span class="n">session</span><span class="p">:</span>
<span class="k">continue</span>
<span class="k">if</span> <span class="n">room_name</span> <span class="ow">in</span> <span class="n">socket</span><span class="o">.</span><span class="n">session</span><span class="p">[</span><span class="s">'rooms'</span><span class="p">]</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">socket</span> <span class="o">!=</span> <span class="n">socket</span><span class="p">:</span>
<span class="n">socket</span><span class="o">.</span><span class="n">send_packet</span><span class="p">(</span><span class="n">pkt</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/mixins.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">gevent-socketio 0.3.1 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2011-2014, Jeffrey Gelens, Alexandre Bourget, and John Anderson.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
</html>
|