| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_265) on Mon Dec 21 15:09:24 PST 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Uses of Interface org.apache.guacamole.net.GuacamoleSocket (guacamole-common 1.3.0 API)</title> |
| <meta name="date" content="2020-12-21"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Uses of Interface org.apache.guacamole.net.GuacamoleSocket (guacamole-common 1.3.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="../package-summary.html">Package</a></li> |
| <li><a href="../../../../../org/apache/guacamole/net/GuacamoleSocket.html" title="interface in org.apache.guacamole.net">Class</a></li> |
| <li class="navBarCell1Rev">Use</li> |
| <li><a href="../package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev</li> |
| <li>Next</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/guacamole/net/class-use/GuacamoleSocket.html" target="_top">Frames</a></li> |
| <li><a href="GuacamoleSocket.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h2 title="Uses of Interface org.apache.guacamole.net.GuacamoleSocket" class="title">Uses of Interface<br>org.apache.guacamole.net.GuacamoleSocket</h2> |
| </div> |
| <div class="classUseContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> |
| <caption><span>Packages that use <a href="../../../../../org/apache/guacamole/net/GuacamoleSocket.html" title="interface in org.apache.guacamole.net">GuacamoleSocket</a></span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Package</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="#org.apache.guacamole.net">org.apache.guacamole.net</a></td> |
| <td class="colLast"> |
| <div class="block">Classes which apply to network-specific concepts, such as low-level sockets |
| and tunnels.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="#org.apache.guacamole.protocol">org.apache.guacamole.protocol</a></td> |
| <td class="colLast"> |
| <div class="block">Classes relating directly to the Guacamole protocol.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <ul class="blockList"> |
| <li class="blockList"><a name="org.apache.guacamole.net"> |
| <!-- --> |
| </a> |
| <h3>Uses of <a href="../../../../../org/apache/guacamole/net/GuacamoleSocket.html" title="interface in org.apache.guacamole.net">GuacamoleSocket</a> in <a href="../../../../../org/apache/guacamole/net/package-summary.html">org.apache.guacamole.net</a></h3> |
| <table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> |
| <caption><span>Classes in <a href="../../../../../org/apache/guacamole/net/package-summary.html">org.apache.guacamole.net</a> that implement <a href="../../../../../org/apache/guacamole/net/GuacamoleSocket.html" title="interface in org.apache.guacamole.net">GuacamoleSocket</a></span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/DelegatingGuacamoleSocket.html" title="class in org.apache.guacamole.net">DelegatingGuacamoleSocket</a></span></code> |
| <div class="block">GuacamoleSocket implementation which simply delegates all function calls to |
| an underlying GuacamoleSocket.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/InetGuacamoleSocket.html" title="class in org.apache.guacamole.net">InetGuacamoleSocket</a></span></code> |
| <div class="block">Provides abstract socket-like access to a Guacamole connection over a given |
| hostname and port.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/SSLGuacamoleSocket.html" title="class in org.apache.guacamole.net">SSLGuacamoleSocket</a></span></code> |
| <div class="block">Provides abstract socket-like access to a Guacamole connection over SSL to |
| a given hostname and port.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> |
| <caption><span>Methods in <a href="../../../../../org/apache/guacamole/net/package-summary.html">org.apache.guacamole.net</a> that return <a href="../../../../../org/apache/guacamole/net/GuacamoleSocket.html" title="interface in org.apache.guacamole.net">GuacamoleSocket</a></span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/apache/guacamole/net/GuacamoleSocket.html" title="interface in org.apache.guacamole.net">GuacamoleSocket</a></code></td> |
| <td class="colLast"><span class="typeNameLabel">DelegatingGuacamoleSocket.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/DelegatingGuacamoleSocket.html#getDelegateSocket--">getDelegateSocket</a></span>()</code> |
| <div class="block">Returns the underlying GuacamoleSocket wrapped by this |
| DelegatingGuacamoleSocket.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/guacamole/net/GuacamoleSocket.html" title="interface in org.apache.guacamole.net">GuacamoleSocket</a></code></td> |
| <td class="colLast"><span class="typeNameLabel">GuacamoleTunnel.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/GuacamoleTunnel.html#getSocket--">getSocket</a></span>()</code> |
| <div class="block">Returns the GuacamoleSocket used by this GuacamoleTunnel for reading |
| and writing.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/guacamole/net/GuacamoleSocket.html" title="interface in org.apache.guacamole.net">GuacamoleSocket</a></code></td> |
| <td class="colLast"><span class="typeNameLabel">DelegatingGuacamoleTunnel.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/DelegatingGuacamoleTunnel.html#getSocket--">getSocket</a></span>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/guacamole/net/GuacamoleSocket.html" title="interface in org.apache.guacamole.net">GuacamoleSocket</a></code></td> |
| <td class="colLast"><span class="typeNameLabel">SimpleGuacamoleTunnel.</span><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/SimpleGuacamoleTunnel.html#getSocket--">getSocket</a></span>()</code> </td> |
| </tr> |
| </tbody> |
| </table> |
| <table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> |
| <caption><span>Constructors in <a href="../../../../../org/apache/guacamole/net/package-summary.html">org.apache.guacamole.net</a> with parameters of type <a href="../../../../../org/apache/guacamole/net/GuacamoleSocket.html" title="interface in org.apache.guacamole.net">GuacamoleSocket</a></span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/DelegatingGuacamoleSocket.html#DelegatingGuacamoleSocket-org.apache.guacamole.net.GuacamoleSocket-">DelegatingGuacamoleSocket</a></span>(<a href="../../../../../org/apache/guacamole/net/GuacamoleSocket.html" title="interface in org.apache.guacamole.net">GuacamoleSocket</a> socket)</code> |
| <div class="block">Wraps the given GuacamoleSocket such that all function calls against |
| this DelegatingGuacamoleSocket will be delegated to it.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/SimpleGuacamoleTunnel.html#SimpleGuacamoleTunnel-org.apache.guacamole.net.GuacamoleSocket-">SimpleGuacamoleTunnel</a></span>(<a href="../../../../../org/apache/guacamole/net/GuacamoleSocket.html" title="interface in org.apache.guacamole.net">GuacamoleSocket</a> socket)</code> |
| <div class="block">Creates a new GuacamoleTunnel which synchronizes access to the |
| Guacamole instruction stream associated with the given GuacamoleSocket.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"><a name="org.apache.guacamole.protocol"> |
| <!-- --> |
| </a> |
| <h3>Uses of <a href="../../../../../org/apache/guacamole/net/GuacamoleSocket.html" title="interface in org.apache.guacamole.net">GuacamoleSocket</a> in <a href="../../../../../org/apache/guacamole/protocol/package-summary.html">org.apache.guacamole.protocol</a></h3> |
| <table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> |
| <caption><span>Classes in <a href="../../../../../org/apache/guacamole/protocol/package-summary.html">org.apache.guacamole.protocol</a> that implement <a href="../../../../../org/apache/guacamole/net/GuacamoleSocket.html" title="interface in org.apache.guacamole.net">GuacamoleSocket</a></span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/protocol/ConfiguredGuacamoleSocket.html" title="class in org.apache.guacamole.protocol">ConfiguredGuacamoleSocket</a></span></code> |
| <div class="block">A GuacamoleSocket which pre-configures the connection based on a given |
| GuacamoleConfiguration, completing the initial protocol handshake before |
| accepting data for read or write.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/protocol/FailoverGuacamoleSocket.html" title="class in org.apache.guacamole.protocol">FailoverGuacamoleSocket</a></span></code> |
| <div class="block">GuacamoleSocket which intercepts errors received early in the Guacamole |
| session.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/protocol/FilteredGuacamoleSocket.html" title="class in org.apache.guacamole.protocol">FilteredGuacamoleSocket</a></span></code> |
| <div class="block">Implementation of GuacamoleSocket which allows individual instructions to be |
| intercepted, overridden, etc.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> |
| <caption><span>Constructors in <a href="../../../../../org/apache/guacamole/protocol/package-summary.html">org.apache.guacamole.protocol</a> with parameters of type <a href="../../../../../org/apache/guacamole/net/GuacamoleSocket.html" title="interface in org.apache.guacamole.net">GuacamoleSocket</a></span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/protocol/ConfiguredGuacamoleSocket.html#ConfiguredGuacamoleSocket-org.apache.guacamole.net.GuacamoleSocket-org.apache.guacamole.protocol.GuacamoleConfiguration-">ConfiguredGuacamoleSocket</a></span>(<a href="../../../../../org/apache/guacamole/net/GuacamoleSocket.html" title="interface in org.apache.guacamole.net">GuacamoleSocket</a> socket, |
| <a href="../../../../../org/apache/guacamole/protocol/GuacamoleConfiguration.html" title="class in org.apache.guacamole.protocol">GuacamoleConfiguration</a> config)</code> |
| <div class="block">Creates a new ConfiguredGuacamoleSocket which uses the given |
| GuacamoleConfiguration to complete the initial protocol handshake over |
| the given GuacamoleSocket.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/protocol/ConfiguredGuacamoleSocket.html#ConfiguredGuacamoleSocket-org.apache.guacamole.net.GuacamoleSocket-org.apache.guacamole.protocol.GuacamoleConfiguration-org.apache.guacamole.protocol.GuacamoleClientInformation-">ConfiguredGuacamoleSocket</a></span>(<a href="../../../../../org/apache/guacamole/net/GuacamoleSocket.html" title="interface in org.apache.guacamole.net">GuacamoleSocket</a> socket, |
| <a href="../../../../../org/apache/guacamole/protocol/GuacamoleConfiguration.html" title="class in org.apache.guacamole.protocol">GuacamoleConfiguration</a> config, |
| <a href="../../../../../org/apache/guacamole/protocol/GuacamoleClientInformation.html" title="class in org.apache.guacamole.protocol">GuacamoleClientInformation</a> info)</code> |
| <div class="block">Creates a new ConfiguredGuacamoleSocket which uses the given |
| GuacamoleConfiguration and GuacamoleClientInformation to complete the |
| initial protocol handshake over the given GuacamoleSocket.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/protocol/FailoverGuacamoleSocket.html#FailoverGuacamoleSocket-org.apache.guacamole.net.GuacamoleSocket-">FailoverGuacamoleSocket</a></span>(<a href="../../../../../org/apache/guacamole/net/GuacamoleSocket.html" title="interface in org.apache.guacamole.net">GuacamoleSocket</a> socket)</code> |
| <div class="block">Creates a new FailoverGuacamoleSocket which reads Guacamole instructions |
| from the given socket, searching for errors from the upstream remote |
| desktop until a maximum of 128KB of instruction data has been queued.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/protocol/FailoverGuacamoleSocket.html#FailoverGuacamoleSocket-org.apache.guacamole.net.GuacamoleSocket-int-">FailoverGuacamoleSocket</a></span>(<a href="../../../../../org/apache/guacamole/net/GuacamoleSocket.html" title="interface in org.apache.guacamole.net">GuacamoleSocket</a> socket, |
| int instructionQueueLimit)</code> |
| <div class="block">Creates a new FailoverGuacamoleSocket which reads Guacamole instructions |
| from the given socket, searching for errors from the upstream remote |
| desktop until the given instruction queue limit is reached.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/protocol/FilteredGuacamoleSocket.html#FilteredGuacamoleSocket-org.apache.guacamole.net.GuacamoleSocket-org.apache.guacamole.protocol.GuacamoleFilter-org.apache.guacamole.protocol.GuacamoleFilter-">FilteredGuacamoleSocket</a></span>(<a href="../../../../../org/apache/guacamole/net/GuacamoleSocket.html" title="interface in org.apache.guacamole.net">GuacamoleSocket</a> socket, |
| <a href="../../../../../org/apache/guacamole/protocol/GuacamoleFilter.html" title="interface in org.apache.guacamole.protocol">GuacamoleFilter</a> readFilter, |
| <a href="../../../../../org/apache/guacamole/protocol/GuacamoleFilter.html" title="interface in org.apache.guacamole.protocol">GuacamoleFilter</a> writeFilter)</code> |
| <div class="block">Creates a new FilteredGuacamoleSocket which uses the given filters to |
| determine whether instructions read/written are allowed through, |
| modified, etc.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="../package-summary.html">Package</a></li> |
| <li><a href="../../../../../org/apache/guacamole/net/GuacamoleSocket.html" title="interface in org.apache.guacamole.net">Class</a></li> |
| <li class="navBarCell1Rev">Use</li> |
| <li><a href="../package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev</li> |
| <li>Next</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/guacamole/net/class-use/GuacamoleSocket.html" target="_top">Frames</a></li> |
| <li><a href="GuacamoleSocket.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2020. All rights reserved.</small></p> |
| <!-- Google Analytics --> |
| <script type="text/javascript"> |
| (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ |
| (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), |
| m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) |
| })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); |
| |
| ga('create', 'UA-75289145-1', 'auto'); |
| ga('send', 'pageview'); |
| </script> |
| </body> |
| </html> |