350 lines
No EOL
18 KiB
HTML
350 lines
No EOL
18 KiB
HTML
<!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" xml:lang="en" lang="en">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<title>
|
|
Class: SocketsController
|
|
|
|
— Documentation by YARD 0.7.1
|
|
|
|
</title>
|
|
|
|
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
|
|
|
|
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
|
|
|
|
<script type="text/javascript" charset="utf-8">
|
|
relpath = '';
|
|
if (relpath != '') relpath += '/';
|
|
</script>
|
|
|
|
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
|
|
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
|
|
|
|
</head>
|
|
<body>
|
|
<script type="text/javascript" charset="utf-8">
|
|
if (window.top.frames.main) document.body.className = 'frames';
|
|
</script>
|
|
|
|
<div id="header">
|
|
<div id="menu">
|
|
|
|
<a href="_index.html">Index (S)</a> »
|
|
|
|
|
|
<span class="title">SocketsController</span>
|
|
|
|
|
|
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
</div>
|
|
|
|
<div id="search">
|
|
|
|
<a id="class_list_link" href="#">Class List</a>
|
|
|
|
<a id="method_list_link" href="#">Method List</a>
|
|
|
|
<a id="file_list_link" href="#">File List</a>
|
|
|
|
</div>
|
|
<div class="clear"></div>
|
|
</div>
|
|
|
|
<iframe id="search_frame"></iframe>
|
|
|
|
<div id="content"><h1>Class: SocketsController
|
|
|
|
|
|
|
|
</h1>
|
|
|
|
<dl class="box">
|
|
|
|
<dt class="r1">Inherits:</dt>
|
|
<dd class="r1">
|
|
<span class="inheritName"><span class='object_link'><a href="ApplicationController.html" title="ApplicationController (class)">ApplicationController</a></span></span>
|
|
|
|
<ul class="fullTree">
|
|
<li>Object</li>
|
|
|
|
<li class="next">ActionController::Base</li>
|
|
|
|
<li class="next"><span class='object_link'><a href="ApplicationController.html" title="ApplicationController (class)">ApplicationController</a></span></li>
|
|
|
|
<li class="next">SocketsController</li>
|
|
|
|
</ul>
|
|
<a href="#" class="inheritanceTree">show all</a>
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dt class="r2">Includes:</dt>
|
|
<dd class="r2"><span class='object_link'><a href="ApplicationHelper.html" title="ApplicationHelper (module)">ApplicationHelper</a></span>, <span class='object_link'><a href="Rails.html" title="Rails (module)">Rails</a></span>, <span class='object_link'><a href="SocketsHelper.html" title="SocketsHelper (module)">SocketsHelper</a></span></dd>
|
|
|
|
|
|
|
|
|
|
|
|
<dt class="r1 last">Defined in:</dt>
|
|
<dd class="r1 last">app/controllers/sockets_controller.rb</dd>
|
|
|
|
</dl>
|
|
<div class="clear"></div>
|
|
|
|
<h2>Overview</h2><div class="docstring">
|
|
<div class="discussion">
|
|
<p>
|
|
Copyright © 2010, Diaspora Inc. This file is
|
|
</p>
|
|
<pre class="code">
|
|
<span class='licensed identifier id'>licensed</span> <span class='under identifier id'>under</span> <span class='the identifier id'>the</span> <span class='Affero constant id'>Affero</span> <span class='General constant id'>General</span> <span class='Public constant id'>Public</span> <span class='License constant id'>License</span> <span class='version identifier id'>version</span> <span class='integer val'>3</span> <span class='or or kw'>or</span> <span class='later identifier id'>later</span><span class='dot token'>.</span> <span class='See constant id'>See</span>
|
|
<span class='the identifier id'>the</span> <span class='COPYRIGHT constant id'>COPYRIGHT</span> <span class='file identifier id'>file</span><span class='dot token'>.</span>
|
|
</pre>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2>
|
|
Instance Method Summary
|
|
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
</h2>
|
|
|
|
<ul class="summary">
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#incoming-instance_method" title="#incoming (instance method)">- (Object) <strong>incoming</strong>(msg) </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'></div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#outgoing-instance_method" title="#outgoing (instance method)">- (Object) <strong>outgoing</strong>(user_or_id, object, opts = {}) </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'></div></span>
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="inherited">Methods included from <span class='object_link'><a href="SocketsHelper.html" title="SocketsHelper (module)">SocketsHelper</a></span></h3>
|
|
<p class="inherited"><span class='object_link'><a href="SocketsHelper.html#action_hash-instance_method" title="SocketsHelper#action_hash (method)">#action_hash</a></span>, <span class='object_link'><a href="SocketsHelper.html#obj_id-instance_method" title="SocketsHelper#obj_id (method)">#obj_id</a></span></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="inherited">Methods included from <span class='object_link'><a href="NotificationsHelper.html" title="NotificationsHelper (module)">NotificationsHelper</a></span></h3>
|
|
<p class="inherited"><span class='object_link'><a href="NotificationsHelper.html#new_notification_link-instance_method" title="NotificationsHelper#new_notification_link (method)">#new_notification_link</a></span>, <span class='object_link'><a href="NotificationsHelper.html#notification_message_for-instance_method" title="NotificationsHelper#notification_message_for (method)">#notification_message_for</a></span>, <span class='object_link'><a href="NotificationsHelper.html#notification_people_link-instance_method" title="NotificationsHelper#notification_people_link (method)">#notification_people_link</a></span>, <span class='object_link'><a href="NotificationsHelper.html#object_link-instance_method" title="NotificationsHelper#object_link (method)">#object_link</a></span>, <span class='object_link'><a href="NotificationsHelper.html#peoples_names-instance_method" title="NotificationsHelper#peoples_names (method)">#peoples_names</a></span>, <span class='object_link'><a href="NotificationsHelper.html#the_day-instance_method" title="NotificationsHelper#the_day (method)">#the_day</a></span>, <span class='object_link'><a href="NotificationsHelper.html#the_month-instance_method" title="NotificationsHelper#the_month (method)">#the_month</a></span>, <span class='object_link'><a href="NotificationsHelper.html#translation-instance_method" title="NotificationsHelper#translation (method)">#translation</a></span></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="inherited">Methods included from <span class='object_link'><a href="ApplicationHelper.html" title="ApplicationHelper (module)">ApplicationHelper</a></span></h3>
|
|
<p class="inherited"><span class='object_link'><a href="ApplicationHelper.html#bookmarklet-instance_method" title="ApplicationHelper#bookmarklet (method)">#bookmarklet</a></span>, <span class='object_link'><a href="ApplicationHelper.html#direction_for-instance_method" title="ApplicationHelper#direction_for (method)">#direction_for</a></span>, <span class='object_link'><a href="ApplicationHelper.html#get_javascript_strings_for-instance_method" title="ApplicationHelper#get_javascript_strings_for (method)">#get_javascript_strings_for</a></span>, <span class='object_link'><a href="ApplicationHelper.html#hard_link-instance_method" title="ApplicationHelper#hard_link (method)">#hard_link</a></span>, <span class='object_link'><a href="ApplicationHelper.html#how_long_ago-instance_method" title="ApplicationHelper#how_long_ago (method)">#how_long_ago</a></span>, <span class='object_link'><a href="ApplicationHelper.html#info_text-instance_method" title="ApplicationHelper#info_text (method)">#info_text</a></span>, <span class='object_link'><a href="ApplicationHelper.html#mine%3F-instance_method" title="ApplicationHelper#mine? (method)">#mine?</a></span>, <span class='object_link'><a href="ApplicationHelper.html#object_fields-instance_method" title="ApplicationHelper#object_fields (method)">#object_fields</a></span>, <span class='object_link'><a href="ApplicationHelper.html#object_path-instance_method" title="ApplicationHelper#object_path (method)">#object_path</a></span>, <span class='object_link'><a href="ApplicationHelper.html#owner_image_link-instance_method" title="ApplicationHelper#owner_image_link (method)">#owner_image_link</a></span>, <span class='object_link'><a href="ApplicationHelper.html#owner_image_tag-instance_method" title="ApplicationHelper#owner_image_tag (method)">#owner_image_tag</a></span>, <span class='object_link'><a href="ApplicationHelper.html#person_image_link-instance_method" title="ApplicationHelper#person_image_link (method)">#person_image_link</a></span>, <span class='object_link'><a href="ApplicationHelper.html#person_image_tag-instance_method" title="ApplicationHelper#person_image_tag (method)">#person_image_tag</a></span>, <span class='object_link'><a href="ApplicationHelper.html#person_link-instance_method" title="ApplicationHelper#person_link (method)">#person_link</a></span>, <span class='object_link'><a href="ApplicationHelper.html#post_yield_tag-instance_method" title="ApplicationHelper#post_yield_tag (method)">#post_yield_tag</a></span>, <span class='object_link'><a href="ApplicationHelper.html#profile_photo-instance_method" title="ApplicationHelper#profile_photo (method)">#profile_photo</a></span>, <span class='object_link'><a href="ApplicationHelper.html#rtl%3F-instance_method" title="ApplicationHelper#rtl? (method)">#rtl?</a></span>, <span class='object_link'><a href="ApplicationHelper.html#timeago-instance_method" title="ApplicationHelper#timeago (method)">#timeago</a></span>, <span class='object_link'><a href="ApplicationHelper.html#type_partial-instance_method" title="ApplicationHelper#type_partial (method)">#type_partial</a></span></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="ApplicationController.html" title="ApplicationController (class)">ApplicationController</a></span></h3>
|
|
<p class="inherited"><span class='object_link'><a href="ApplicationController.html#after_sign_in_path_for-instance_method" title="ApplicationController#after_sign_in_path_for (method)">#after_sign_in_path_for</a></span>, <span class='object_link'><a href="ApplicationController.html#clear_gc_stats-instance_method" title="ApplicationController#clear_gc_stats (method)">#clear_gc_stats</a></span>, <span class='object_link'><a href="ApplicationController.html#ensure_http_referer_is_set-instance_method" title="ApplicationController#ensure_http_referer_is_set (method)">#ensure_http_referer_is_set</a></span>, <span class='object_link'><a href="ApplicationController.html#ensure_page-instance_method" title="ApplicationController#ensure_page (method)">#ensure_page</a></span>, <span class='object_link'><a href="ApplicationController.html#grammatical_gender-instance_method" title="ApplicationController#grammatical_gender (method)">#grammatical_gender</a></span>, <span class='object_link'><a href="ApplicationController.html#redirect_unless_admin-instance_method" title="ApplicationController#redirect_unless_admin (method)">#redirect_unless_admin</a></span>, <span class='object_link'><a href="ApplicationController.html#set_git_header-instance_method" title="ApplicationController#set_git_header (method)">#set_git_header</a></span>, <span class='object_link'><a href="ApplicationController.html#set_grammatical_gender-instance_method" title="ApplicationController#set_grammatical_gender (method)">#set_grammatical_gender</a></span>, <span class='object_link'><a href="ApplicationController.html#set_header_data-instance_method" title="ApplicationController#set_header_data (method)">#set_header_data</a></span>, <span class='object_link'><a href="ApplicationController.html#set_invites-instance_method" title="ApplicationController#set_invites (method)">#set_invites</a></span>, <span class='object_link'><a href="ApplicationController.html#set_locale-instance_method" title="ApplicationController#set_locale (method)">#set_locale</a></span>, <span class='object_link'><a href="ApplicationController.html#which_action_and_user-instance_method" title="ApplicationController#which_action_and_user (method)">#which_action_and_user</a></span></p>
|
|
|
|
|
|
|
|
<div id="instance_method_details" class="method_details_list">
|
|
<h2>Instance Method Details</h2>
|
|
|
|
|
|
<div class="method_details first">
|
|
<p class="signature first" id="incoming-instance_method">
|
|
|
|
- (<tt>Object</tt>) <strong>incoming</strong>(msg)
|
|
|
|
|
|
|
|
</p><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
10
|
|
11
|
|
12</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'app/controllers/sockets_controller.rb', line 10</span>
|
|
|
|
<span class='def def kw'>def</span> <span class='incoming identifier id'>incoming</span><span class='lparen token'>(</span><span class='msg identifier id'>msg</span><span class='rparen token'>)</span>
|
|
<span class='Rails constant id'>Rails</span><span class='dot token'>.</span><span class='logger identifier id'>logger</span><span class='dot token'>.</span><span class='info identifier id'>info</span><span class='lparen token'>(</span><span class='dstring node'>"Socket received connection to: #{msg}"</span><span class='rparen token'>)</span>
|
|
<span class='end end kw'>end</span>
|
|
</pre>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="method_details ">
|
|
<p class="signature " id="outgoing-instance_method">
|
|
|
|
- (<tt>Object</tt>) <strong>outgoing</strong>(user_or_id, object, opts = {})
|
|
|
|
|
|
|
|
</p><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
14
|
|
15
|
|
16
|
|
17
|
|
18
|
|
19
|
|
20
|
|
21
|
|
22
|
|
23
|
|
24</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'app/controllers/sockets_controller.rb', line 14</span>
|
|
|
|
<span class='def def kw'>def</span> <span class='outgoing identifier id'>outgoing</span><span class='lparen token'>(</span><span class='user_or_id identifier id'>user_or_id</span><span class='comma token'>,</span> <span class='object identifier id'>object</span><span class='comma token'>,</span> <span class='opts identifier id'>opts</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
|
|
<span class='if if kw'>if</span> <span class='user_or_id identifier id'>user_or_id</span><span class='dot token'>.</span><span class='instance_of? fid id'>instance_of?</span><span class='lparen token'>(</span><span class='Fixnum constant id'>Fixnum</span><span class='rparen token'>)</span>
|
|
<span class='user_id identifier id'>user_id</span> <span class='assign token'>=</span> <span class='user_or_id identifier id'>user_or_id</span>
|
|
<span class='else else kw'>else</span>
|
|
<span class='user_id identifier id'>user_id</span> <span class='assign token'>=</span> <span class='user_or_id identifier id'>user_or_id</span><span class='dot token'>.</span><span class='id identifier id'>id</span>
|
|
<span class='@user ivar id'>@user</span> <span class='assign token'>=</span> <span class='user_or_id identifier id'>user_or_id</span>
|
|
<span class='end end kw'>end</span>
|
|
<span class='return return kw'>return</span> <span class='unless unless_mod kw'>unless</span> <span class='Diaspora constant id'>Diaspora</span><span class='colon2 op'>::</span><span class='WebSocket constant id'>WebSocket</span><span class='dot token'>.</span><span class='is_connected? fid id'>is_connected?</span><span class='lparen token'>(</span><span class='user_id identifier id'>user_id</span><span class='rparen token'>)</span>
|
|
<span class='@_request ivar id'>@_request</span> <span class='assign token'>=</span> <span class='ActionDispatch constant id'>ActionDispatch</span><span class='colon2 op'>::</span><span class='Request constant id'>Request</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
|
|
<span class='Diaspora constant id'>Diaspora</span><span class='colon2 op'>::</span><span class='WebSocket constant id'>WebSocket</span><span class='dot token'>.</span><span class='queue_to_user identifier id'>queue_to_user</span><span class='lparen token'>(</span><span class='user_id identifier id'>user_id</span><span class='comma token'>,</span> <span class='action_hash identifier id'>action_hash</span><span class='lparen token'>(</span><span class='@user ivar id'>@user</span> <span class='orop op'>||</span> <span class='User constant id'>User</span><span class='dot token'>.</span><span class='find identifier id'>find</span><span class='lparen token'>(</span><span class='user_id identifier id'>user_id</span><span class='rparen token'>)</span><span class='comma token'>,</span> <span class='object identifier id'>object</span><span class='comma token'>,</span> <span class='opts identifier id'>opts</span><span class='rparen token'>)</span><span class='rparen token'>)</span>
|
|
<span class='end end kw'>end</span>
|
|
</pre>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div id="footer">
|
|
Generated on Mon Jun 13 15:59:15 2011 by
|
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
0.7.1 (ruby-1.8.7).
|
|
</div>
|
|
|
|
</body>
|
|
</html> |