mirror of
https://github.com/mistergibson/gxg-framework.git
synced 2026-08-15 03:46:00 -07:00
654 lines
20 KiB
HTML
654 lines
20 KiB
HTML
<!DOCTYPE html>
|
|
|
|
<html>
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
|
|
<title>class GxG::Communications::BridgeAdapter - RDoc Documentation</title>
|
|
|
|
<script type="text/javascript">
|
|
var rdoc_rel_prefix = "../../";
|
|
var index_rel_prefix = "../../";
|
|
</script>
|
|
|
|
<script src="../../js/navigation.js" defer></script>
|
|
<script src="../../js/search.js" defer></script>
|
|
<script src="../../js/search_index.js" defer></script>
|
|
<script src="../../js/searcher.js" defer></script>
|
|
<script src="../../js/darkfish.js" defer></script>
|
|
|
|
<link href="../../css/fonts.css" rel="stylesheet">
|
|
<link href="../../css/rdoc.css" rel="stylesheet">
|
|
|
|
|
|
|
|
<body id="top" role="document" class="class">
|
|
<nav role="navigation">
|
|
<div id="project-navigation">
|
|
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
|
<h2>
|
|
<a href="../../index.html" rel="home">Home</a>
|
|
</h2>
|
|
|
|
<div id="table-of-contents-navigation">
|
|
<a href="../../table_of_contents.html#pages">Pages</a>
|
|
<a href="../../table_of_contents.html#classes">Classes</a>
|
|
<a href="../../table_of_contents.html#methods">Methods</a>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="search-section" role="search" class="project-section initially-hidden">
|
|
<form action="#" method="get" accept-charset="utf-8">
|
|
<div id="search-field-wrapper">
|
|
<input id="search-field" role="combobox" aria-label="Search"
|
|
aria-autocomplete="list" aria-controls="search-results"
|
|
type="text" name="search" placeholder="Search" spellcheck="false"
|
|
title="Type to search, Up and Down to navigate, Enter to load">
|
|
</div>
|
|
|
|
<ul id="search-results" aria-label="Search Results"
|
|
aria-busy="false" aria-expanded="false"
|
|
aria-atomic="false" class="initially-hidden"></ul>
|
|
</form>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div id="class-metadata">
|
|
|
|
<div id="parent-class-section" class="nav-section">
|
|
<h3>Parent</h3>
|
|
|
|
|
|
<p class="link"><a href="../../Object.html">Object</a>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<!-- Method Quickref -->
|
|
<div id="method-list-section" class="nav-section">
|
|
<h3>Methods</h3>
|
|
|
|
<ul class="link-list" role="directory">
|
|
|
|
<li ><a href="#method-c-abilities">::abilities</a>
|
|
|
|
<li ><a href="#method-c-limits">::limits</a>
|
|
|
|
<li ><a href="#method-c-new">::new</a>
|
|
|
|
<li ><a href="#method-c-protocol">::protocol</a>
|
|
|
|
<li ><a href="#method-c-templates">::templates</a>
|
|
|
|
<li ><a href="#method-i-channels">#channels</a>
|
|
|
|
<li ><a href="#method-i-close">#close</a>
|
|
|
|
<li ><a href="#method-i-entitiies">#entitiies</a>
|
|
|
|
<li ><a href="#method-i-entity_status">#entity_status</a>
|
|
|
|
<li ><a href="#method-i-my_id">#my_id</a>
|
|
|
|
<li ><a href="#method-i-notify">#notify</a>
|
|
|
|
<li ><a href="#method-i-open">#open</a>
|
|
|
|
<li ><a href="#method-i-open-3F">#open?</a>
|
|
|
|
<li ><a href="#method-i-uuid">#uuid</a>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</nav>
|
|
|
|
<main role="main" aria-labelledby="class-GxG::Communications::BridgeAdapter">
|
|
<h1 id="class-GxG::Communications::BridgeAdapter" class="class">
|
|
class GxG::Communications::BridgeAdapter
|
|
</h1>
|
|
|
|
<section class="description">
|
|
|
|
<p>Adapters</p>
|
|
|
|
</section>
|
|
|
|
|
|
<section id="5Buntitled-5D" class="documentation-section">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
|
<header>
|
|
<h3>Public Class Methods</h3>
|
|
</header>
|
|
|
|
|
|
<div id="method-c-abilities" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">abilities</span><span
|
|
class="method-args">()</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="abilities-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 46</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">abilities</span>()
|
|
[]
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-c-limits" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">limits</span><span
|
|
class="method-args">()</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="limits-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 50</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">limits</span>()
|
|
{}
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-c-new" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">new</span><span
|
|
class="method-args">(the_process=nil, the_url=nil, options=nil)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="new-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 58</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">the_process</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">the_url</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>=<span class="ruby-keyword">nil</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
|
<span class="ruby-identifier">the_url</span> = <span class="ruby-operator">::</span><span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-identifier">parse</span>(<span class="ruby-identifier">the_url</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_url</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">URI</span><span class="ruby-operator">::</span><span class="ruby-constant">Generic</span>)
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a valid URL as a String or URI."</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">the_process</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You MUST provide a Service or Application object to interact with."</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-ivar">@process</span> = <span class="ruby-identifier">the_process</span>
|
|
<span class="ruby-ivar">@url</span> = <span class="ruby-identifier">the_url</span>
|
|
<span class="ruby-ivar">@options</span> = (<span class="ruby-identifier">options</span> <span class="ruby-operator">||</span> {})
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@options</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>)
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"You must provide options as a Hash."</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-ivar">@active</span> = <span class="ruby-keyword">false</span>
|
|
<span class="ruby-ivar">@connector</span> = <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-ivar">@thread_safety</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Mutex</span>.<span class="ruby-identifier">new</span>
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-ivar">@uuid</span> = <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-identifier">uuid_generate</span>.<span class="ruby-identifier">to_sym</span>
|
|
<span class="ruby-keyword">self</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-c-protocol" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">protocol</span><span
|
|
class="method-args">()</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>WARNING: Only instantiate subclasses</p>
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="protocol-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 42</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">protocol</span>()
|
|
<span class="ruby-value">:unspecified</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-c-templates" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">templates</span><span
|
|
class="method-args">()</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="templates-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 54</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">templates</span>()
|
|
{}
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</section>
|
|
|
|
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
|
<header>
|
|
<h3>Public Instance Methods</h3>
|
|
</header>
|
|
|
|
|
|
<div id="method-i-channels" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">channels</span><span
|
|
class="method-args">()</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>Basic Channel <a href="../Support.html"><code>Support</code></a></p>
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="channels-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 129</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">channels</span>()
|
|
{}
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-close" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">close</span><span
|
|
class="method-args">()</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="close-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 108</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">close</span>()
|
|
<span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">open?</span>
|
|
<span class="ruby-ivar">@connector</span>.<span class="ruby-identifier">logout</span>()
|
|
<span class="ruby-ivar">@active</span> = <span class="ruby-keyword">false</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">true</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-entitiies" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">entitiies</span><span
|
|
class="method-args">()</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>Basic <a href="../Entity.html"><code>Entity</code></a> <a href="../Support.html"><code>Support</code></a></p>
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="entitiies-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 121</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">entitiies</span>()
|
|
[]
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-entity_status" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">entity_status</span><span
|
|
class="method-args">(the_address=nil)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="entity_status-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 125</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">entity_status</span>(<span class="ruby-identifier">the_address</span>=<span class="ruby-keyword">nil</span>)
|
|
<span class="ruby-value">:online</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-my_id" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">my_id</span><span
|
|
class="method-args">()</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="my_id-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 86</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">my_id</span>()
|
|
<span class="ruby-keyword">nil</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-notify" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">notify</span><span
|
|
class="method-args">(details=nil)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>Information Refresh</p>
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="notify-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 116</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">notify</span>(<span class="ruby-identifier">details</span>=<span class="ruby-keyword">nil</span>)
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-open" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">open</span><span
|
|
class="method-args">()</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="open-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 101</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">open</span>()
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">open?</span>
|
|
<span class="ruby-ivar">@active</span> = <span class="ruby-ivar">@connector</span>.<span class="ruby-identifier">login</span>(<span class="ruby-ivar">@url</span>, <span class="ruby-ivar">@options</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-ivar">@active</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-open-3F" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">open?</span><span
|
|
class="method-args">()</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="open-3F-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 90</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">open?</span>()
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@connector</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@connector</span>.<span class="ruby-identifier">closed?</span>
|
|
<span class="ruby-ivar">@active</span> = <span class="ruby-keyword">false</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-ivar">@active</span> = <span class="ruby-keyword">true</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-ivar">@active</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-uuid" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">uuid</span><span
|
|
class="method-args">()</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="uuid-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_communications.rb, line 82</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">uuid</span>()
|
|
<span class="ruby-ivar">@uuid</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</section>
|
|
|
|
</section>
|
|
</main>
|
|
|
|
|
|
<footer id="validator-badges" role="contentinfo">
|
|
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
|
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.2.
|
|
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
</footer>
|
|
|