Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id D44EE200CE0 for ; Thu, 6 Jul 2017 04:29:03 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id D309F16511B; Thu, 6 Jul 2017 02:29:03 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 810BD16511E for ; Thu, 6 Jul 2017 04:29:01 +0200 (CEST) Received: (qmail 57391 invoked by uid 500); 6 Jul 2017 02:29:00 -0000 Mailing-List: contact commits-help@guacamole.incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@guacamole.incubator.apache.org Delivered-To: mailing list commits@guacamole.incubator.apache.org Received: (qmail 57331 invoked by uid 99); 6 Jul 2017 02:29:00 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd1-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 06 Jul 2017 02:29:00 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd1-us-west.apache.org (ASF Mail Server at spamd1-us-west.apache.org) with ESMTP id CF454C1358 for ; Thu, 6 Jul 2017 02:28:58 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd1-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -3.031 X-Spam-Level: X-Spam-Status: No, score=-3.031 tagged_above=-999 required=6.31 tests=[KAM_ASCII_DIVIDERS=0.8, KAM_MANYCOMMENTS=1.2, RCVD_IN_DNSWL_HI=-5, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, SPF_PASS=-0.001, T_RP_MATCHES_RCVD=-0.01] autolearn=disabled Received: from mx1-lw-eu.apache.org ([10.40.0.8]) by localhost (spamd1-us-west.apache.org [10.40.0.7]) (amavisd-new, port 10024) with ESMTP id yCx3J4ZyisSi for ; Thu, 6 Jul 2017 02:28:54 +0000 (UTC) Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx1-lw-eu.apache.org (ASF Mail Server at mx1-lw-eu.apache.org) with SMTP id A86A75FCB0 for ; Thu, 6 Jul 2017 02:28:51 +0000 (UTC) Received: (qmail 57174 invoked by uid 99); 6 Jul 2017 02:28:50 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 06 Jul 2017 02:28:50 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 1D010F2189; Thu, 6 Jul 2017 02:28:50 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: mjumper@apache.org To: commits@guacamole.incubator.apache.org Date: Thu, 06 Jul 2017 02:28:52 -0000 Message-Id: <23e655e63080496083f529d071d9b7eb@git.apache.org> In-Reply-To: <86647479316447b1847ab81c7721b5e8@git.apache.org> References: <86647479316447b1847ab81c7721b5e8@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [03/51] [partial] incubator-guacamole-website git commit: Deploy draft documentation for 0.9.13-incubating. archived-at: Thu, 06 Jul 2017 02:29:03 -0000 http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/eff0fb8d/content/doc/0.9.13-incubating/guacamole-common/org/apache/guacamole/net/DelegatingGuacamoleTunnel.html ---------------------------------------------------------------------- diff --git a/content/doc/0.9.13-incubating/guacamole-common/org/apache/guacamole/net/DelegatingGuacamoleTunnel.html b/content/doc/0.9.13-incubating/guacamole-common/org/apache/guacamole/net/DelegatingGuacamoleTunnel.html new file mode 100644 index 0000000..441726a --- /dev/null +++ b/content/doc/0.9.13-incubating/guacamole-common/org/apache/guacamole/net/DelegatingGuacamoleTunnel.html @@ -0,0 +1,549 @@ + + + + + + +DelegatingGuacamoleTunnel (guacamole-common 0.9.13-incubating API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
org.apache.guacamole.net
+

Class DelegatingGuacamoleTunnel

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.apache.guacamole.net.DelegatingGuacamoleTunnel
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    GuacamoleTunnel
    +
    +
    +
    +
    public class DelegatingGuacamoleTunnel
+extends Object
+implements GuacamoleTunnel
    +
    GuacamoleTunnel implementation which simply delegates all function calls to + an underlying GuacamoleTunnel.
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      DelegatingGuacamoleTunnel(GuacamoleTunnel tunnel) +
      Wraps the given tunnel such that all function calls against this tunnel + will be delegated to it.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      GuacamoleReaderacquireReader() +
      Acquires exclusive read access to the Guacamole instruction stream + and returns a GuacamoleReader for reading from that stream.
      +
      GuacamoleWriteracquireWriter() +
      Acquires exclusive write access to the Guacamole instruction stream + and returns a GuacamoleWriter for writing to that stream.
      +
      voidclose() +
      Release all resources allocated to this GuacamoleTunnel.
      +
      GuacamoleSocketgetSocket() +
      Returns the GuacamoleSocket used by this GuacamoleTunnel for reading + and writing.
      +
      UUIDgetUUID() +
      Returns the unique identifier associated with this GuacamoleTunnel.
      +
      booleanhasQueuedReaderThreads() +
      Returns whether there are threads waiting for read access to the + Guacamole instruction stream.
      +
      booleanhasQueuedWriterThreads() +
      Returns whether there are threads waiting for write access to the + Guacamole instruction stream.
      +
      booleanisOpen() +
      Returns whether this GuacamoleTunnel is open, or has been closed.
      +
      voidreleaseReader() +
      Relinquishes exclusive read access to the Guacamole instruction + stream.
      +
      voidreleaseWriter() +
      Relinquishes exclusive write access to the Guacamole instruction + stream.
      +
      + +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DelegatingGuacamoleTunnel

        +
        public DelegatingGuacamoleTunnel(GuacamoleTunnel tunnel)
        +
        Wraps the given tunnel such that all function calls against this tunnel + will be delegated to it.
        +
        +
        Parameters:
        +
        tunnel - The GuacamoleTunnel to wrap.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        acquireReader

        +
        public GuacamoleReader acquireReader()
        +
        Description copied from interface: GuacamoleTunnel
        +
        Acquires exclusive read access to the Guacamole instruction stream + and returns a GuacamoleReader for reading from that stream.
        +
        +
        Specified by:
        +
        acquireReader in interface GuacamoleTunnel
        +
        Returns:
        +
        A GuacamoleReader for reading from the Guacamole instruction + stream.
        +
        +
        • +
      + + + +
        +
      • +

        releaseReader

        +
        public void releaseReader()
        +
        Description copied from interface: GuacamoleTunnel
        +
        Relinquishes exclusive read access to the Guacamole instruction + stream. This function should be called whenever a thread finishes using + a GuacamoleTunnel's GuacamoleReader.
        +
        +
        Specified by:
        +
        releaseReader in interface GuacamoleTunnel
        +
        +
        • +
      + + + +
        +
      • +

        hasQueuedReaderThreads

        +
        public boolean hasQueuedReaderThreads()
        +
        Description copied from interface: GuacamoleTunnel
        +
        Returns whether there are threads waiting for read access to the + Guacamole instruction stream.
        +
        +
        Specified by:
        +
        hasQueuedReaderThreads in interface GuacamoleTunnel
        +
        Returns:
        +
        true if threads are waiting for read access the Guacamole + instruction stream, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        acquireWriter

        +
        public GuacamoleWriter acquireWriter()
        +
        Description copied from interface: GuacamoleTunnel
        +
        Acquires exclusive write access to the Guacamole instruction stream + and returns a GuacamoleWriter for writing to that stream.
        +
        +
        Specified by:
        +
        acquireWriter in interface GuacamoleTunnel
        +
        Returns:
        +
        A GuacamoleWriter for writing to the Guacamole instruction + stream.
        +
        +
        • +
      + + + +
        +
      • +

        releaseWriter

        +
        public void releaseWriter()
        +
        Description copied from interface: GuacamoleTunnel
        +
        Relinquishes exclusive write access to the Guacamole instruction + stream. This function should be called whenever a thread finishes using + a GuacamoleTunnel's GuacamoleWriter.
        +
        +
        Specified by:
        +
        releaseWriter in interface GuacamoleTunnel
        +
        +
        • +
      + + + +
        +
      • +

        hasQueuedWriterThreads

        +
        public boolean hasQueuedWriterThreads()
        +
        Description copied from interface: GuacamoleTunnel
        +
        Returns whether there are threads waiting for write access to the + Guacamole instruction stream.
        +
        +
        Specified by:
        +
        hasQueuedWriterThreads in interface GuacamoleTunnel
        +
        Returns:
        +
        true if threads are waiting for write access the Guacamole + instruction stream, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        getUUID

        +
        public UUID getUUID()
        +
        Description copied from interface: GuacamoleTunnel
        +
        Returns the unique identifier associated with this GuacamoleTunnel.
        +
        +
        Specified by:
        +
        getUUID in interface GuacamoleTunnel
        +
        Returns:
        +
        The unique identifier associated with this GuacamoleTunnel.
        +
        +
        • +
      + + + +
        +
      • +

        getSocket

        +
        public GuacamoleSocket getSocket()
        +
        Description copied from interface: GuacamoleTunnel
        +
        Returns the GuacamoleSocket used by this GuacamoleTunnel for reading + and writing.
        +
        +
        Specified by:
        +
        getSocket in interface GuacamoleTunnel
        +
        Returns:
        +
        The GuacamoleSocket used by this GuacamoleTunnel.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        isOpen

        +
        public boolean isOpen()
        +
        Description copied from interface: GuacamoleTunnel
        +
        Returns whether this GuacamoleTunnel is open, or has been closed.
        +
        +
        Specified by:
        +
        isOpen in interface GuacamoleTunnel
        +
        Returns:
        +
        true if this GuacamoleTunnel is open, false if it is closed.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2017. All rights reserved.

+ + + + http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/eff0fb8d/content/doc/0.9.13-incubating/guacamole-common/org/apache/guacamole/net/GuacamoleSocket.html ---------------------------------------------------------------------- diff --git a/content/doc/0.9.13-incubating/guacamole-common/org/apache/guacamole/net/GuacamoleSocket.html b/content/doc/0.9.13-incubating/guacamole-common/org/apache/guacamole/net/GuacamoleSocket.html new file mode 100644 index 0000000..8faad2a --- /dev/null +++ b/content/doc/0.9.13-incubating/guacamole-common/org/apache/guacamole/net/GuacamoleSocket.html @@ -0,0 +1,320 @@ + + + + + + +GuacamoleSocket (guacamole-common 0.9.13-incubating API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.apache.guacamole.net
+

Interface GuacamoleSocket

+
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Releases all resources in use by the connection represented by this + GuacamoleSocket.
      +
      GuacamoleReadergetReader() +
      Returns a GuacamoleReader which can be used to read from the + Guacamole instruction stream associated with the connection + represented by this GuacamoleSocket.
      +
      GuacamoleWritergetWriter() +
      Returns a GuacamoleWriter which can be used to write to the + Guacamole instruction stream associated with the connection + represented by this GuacamoleSocket.
      +
      booleanisOpen() +
      Returns whether this GuacamoleSocket is open and can be used for reading + and writing.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getReader

        +
        GuacamoleReader getReader()
        +
        Returns a GuacamoleReader which can be used to read from the + Guacamole instruction stream associated with the connection + represented by this GuacamoleSocket.
        +
        +
        Returns:
        +
        A GuacamoleReader which can be used to read from the + Guacamole instruction stream.
        +
        +
        • +
      + + + +
        +
      • +

        getWriter

        +
        GuacamoleWriter getWriter()
        +
        Returns a GuacamoleWriter which can be used to write to the + Guacamole instruction stream associated with the connection + represented by this GuacamoleSocket.
        +
        +
        Returns:
        +
        A GuacamoleWriter which can be used to write to the + Guacamole instruction stream.
        +
        +
        • +
      + + + +
        +
      • +

        close

        +
        void close()
+    throws GuacamoleException
        +
        Releases all resources in use by the connection represented by this + GuacamoleSocket.
        +
        +
        Throws:
        +
        GuacamoleException - If an error occurs while releasing resources.
        +
        +
        • +
      + + + +
        +
      • +

        isOpen

        +
        boolean isOpen()
        +
        Returns whether this GuacamoleSocket is open and can be used for reading + and writing.
        +
        +
        Returns:
        +
        true if this GuacamoleSocket is open, false otherwise.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2017. All rights reserved.

+ + + + http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/eff0fb8d/content/doc/0.9.13-incubating/guacamole-common/org/apache/guacamole/net/GuacamoleTunnel.html ---------------------------------------------------------------------- diff --git a/content/doc/0.9.13-incubating/guacamole-common/org/apache/guacamole/net/GuacamoleTunnel.html b/content/doc/0.9.13-incubating/guacamole-common/org/apache/guacamole/net/GuacamoleTunnel.html new file mode 100644 index 0000000..5ff62ed --- /dev/null +++ b/content/doc/0.9.13-incubating/guacamole-common/org/apache/guacamole/net/GuacamoleTunnel.html @@ -0,0 +1,489 @@ + + + + + + +GuacamoleTunnel (guacamole-common 0.9.13-incubating API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
org.apache.guacamole.net
+

Interface GuacamoleTunnel

+
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static StringINTERNAL_DATA_OPCODE +
      The Guacamole protocol instruction opcode reserved for arbitrary + internal use by tunnel implementations.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      GuacamoleReaderacquireReader() +
      Acquires exclusive read access to the Guacamole instruction stream + and returns a GuacamoleReader for reading from that stream.
      +
      GuacamoleWriteracquireWriter() +
      Acquires exclusive write access to the Guacamole instruction stream + and returns a GuacamoleWriter for writing to that stream.
      +
      voidclose() +
      Release all resources allocated to this GuacamoleTunnel.
      +
      GuacamoleSocketgetSocket() +
      Returns the GuacamoleSocket used by this GuacamoleTunnel for reading + and writing.
      +
      UUIDgetUUID() +
      Returns the unique identifier associated with this GuacamoleTunnel.
      +
      booleanhasQueuedReaderThreads() +
      Returns whether there are threads waiting for read access to the + Guacamole instruction stream.
      +
      booleanhasQueuedWriterThreads() +
      Returns whether there are threads waiting for write access to the + Guacamole instruction stream.
      +
      booleanisOpen() +
      Returns whether this GuacamoleTunnel is open, or has been closed.
      +
      voidreleaseReader() +
      Relinquishes exclusive read access to the Guacamole instruction + stream.
      +
      voidreleaseWriter() +
      Relinquishes exclusive write access to the Guacamole instruction + stream.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        INTERNAL_DATA_OPCODE

        +
        static final String INTERNAL_DATA_OPCODE
        +
        The Guacamole protocol instruction opcode reserved for arbitrary + internal use by tunnel implementations. The value of this opcode is + guaranteed to be the empty string (""). Tunnel implementations may use + this opcode for any purpose. It is currently used by the HTTP tunnel to + mark the end of the HTTP response, and by the WebSocket tunnel to + transmit the tunnel UUID.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        acquireReader

        +
        GuacamoleReader acquireReader()
        +
        Acquires exclusive read access to the Guacamole instruction stream + and returns a GuacamoleReader for reading from that stream.
        +
        +
        Returns:
        +
        A GuacamoleReader for reading from the Guacamole instruction + stream.
        +
        +
        • +
      + + + +
        +
      • +

        releaseReader

        +
        void releaseReader()
        +
        Relinquishes exclusive read access to the Guacamole instruction + stream. This function should be called whenever a thread finishes using + a GuacamoleTunnel's GuacamoleReader.
        +
        • +
      + + + +
        +
      • +

        hasQueuedReaderThreads

        +
        boolean hasQueuedReaderThreads()
        +
        Returns whether there are threads waiting for read access to the + Guacamole instruction stream.
        +
        +
        Returns:
        +
        true if threads are waiting for read access the Guacamole + instruction stream, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        acquireWriter

        +
        GuacamoleWriter acquireWriter()
        +
        Acquires exclusive write access to the Guacamole instruction stream + and returns a GuacamoleWriter for writing to that stream.
        +
        +
        Returns:
        +
        A GuacamoleWriter for writing to the Guacamole instruction + stream.
        +
        +
        • +
      + + + +
        +
      • +

        releaseWriter

        +
        void releaseWriter()
        +
        Relinquishes exclusive write access to the Guacamole instruction + stream. This function should be called whenever a thread finishes using + a GuacamoleTunnel's GuacamoleWriter.
        +
        • +
      + + + +
        +
      • +

        hasQueuedWriterThreads

        +
        boolean hasQueuedWriterThreads()
        +
        Returns whether there are threads waiting for write access to the + Guacamole instruction stream.
        +
        +
        Returns:
        +
        true if threads are waiting for write access the Guacamole + instruction stream, false otherwise.
        +
        +
        • +
      + + + +
        +
      • +

        getUUID

        +
        UUID getUUID()
        +
        Returns the unique identifier associated with this GuacamoleTunnel.
        +
        +
        Returns:
        +
        The unique identifier associated with this GuacamoleTunnel.
        +
        +
        • +
      + + + +
        +
      • +

        getSocket

        +
        GuacamoleSocket getSocket()
        +
        Returns the GuacamoleSocket used by this GuacamoleTunnel for reading + and writing.
        +
        +
        Returns:
        +
        The GuacamoleSocket used by this GuacamoleTunnel.
        +
        +
        • +
      + + + +
        +
      • +

        close

        +
        void close()
+    throws GuacamoleException
        +
        Release all resources allocated to this GuacamoleTunnel.
        +
        +
        Throws:
        +
        GuacamoleException - if an error occurs while releasing + resources.
        +
        +
        • +
      + + + +
        +
      • +

        isOpen

        +
        boolean isOpen()
        +
        Returns whether this GuacamoleTunnel is open, or has been closed.
        +
        +
        Returns:
        +
        true if this GuacamoleTunnel is open, false if it is closed.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2017. All rights reserved.

+ + + + http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/eff0fb8d/content/doc/0.9.13-incubating/guacamole-common/org/apache/guacamole/net/InetGuacamoleSocket.html ---------------------------------------------------------------------- diff --git a/content/doc/0.9.13-incubating/guacamole-common/org/apache/guacamole/net/InetGuacamoleSocket.html b/content/doc/0.9.13-incubating/guacamole-common/org/apache/guacamole/net/InetGuacamoleSocket.html new file mode 100644 index 0000000..3c397b4 --- /dev/null +++ b/content/doc/0.9.13-incubating/guacamole-common/org/apache/guacamole/net/InetGuacamoleSocket.html @@ -0,0 +1,402 @@ + + + + + + +InetGuacamoleSocket (guacamole-common 0.9.13-incubating API) + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
org.apache.guacamole.net
+

Class InetGuacamoleSocket

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    GuacamoleSocket
    +
    +
    +
    +
    public class InetGuacamoleSocket
+extends Object
+implements GuacamoleSocket
    +
    Provides abstract socket-like access to a Guacamole connection over a given + hostname and port.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      InetGuacamoleSocket(String hostname, + int port) +
      Creates a new InetGuacamoleSocket which reads and writes instructions + to the Guacamole instruction stream of the Guacamole proxy server + running at the given hostname and port.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidclose() +
      Releases all resources in use by the connection represented by this + GuacamoleSocket.
      +
      GuacamoleReadergetReader() +
      Returns a GuacamoleReader which can be used to read from the + Guacamole instruction stream associated with the connection + represented by this GuacamoleSocket.
      +
      GuacamoleWritergetWriter() +
      Returns a GuacamoleWriter which can be used to write to the + Guacamole instruction stream associated with the connection + represented by this GuacamoleSocket.
      +
      booleanisOpen() +
      Returns whether this GuacamoleSocket is open and can be used for reading + and writing.
      +
      + +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        InetGuacamoleSocket

        +
        public InetGuacamoleSocket(String hostname,
+                           int port)
+                    throws GuacamoleException
        +
        Creates a new InetGuacamoleSocket which reads and writes instructions + to the Guacamole instruction stream of the Guacamole proxy server + running at the given hostname and port.
        +
        +
        Parameters:
        +
        hostname - The hostname of the Guacamole proxy server to connect to.
        +
        port - The port of the Guacamole proxy server to connect to.
        +
        Throws:
        +
        GuacamoleException - If an error occurs while connecting to the + Guacamole proxy server.
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getReader

        +
        public GuacamoleReader getReader()
        +
        Description copied from interface: GuacamoleSocket
        +
        Returns a GuacamoleReader which can be used to read from the + Guacamole instruction stream associated with the connection + represented by this GuacamoleSocket.
        +
        +
        Specified by:
        +
        getReader in interface GuacamoleSocket
        +
        Returns:
        +
        A GuacamoleReader which can be used to read from the + Guacamole instruction stream.
        +
        +
        • +
      + + + +
        +
      • +

        getWriter

        +
        public GuacamoleWriter getWriter()
        +
        Description copied from interface: GuacamoleSocket
        +
        Returns a GuacamoleWriter which can be used to write to the + Guacamole instruction stream associated with the connection + represented by this GuacamoleSocket.
        +
        +
        Specified by:
        +
        getWriter in interface GuacamoleSocket
        +
        Returns:
        +
        A GuacamoleWriter which can be used to write to the + Guacamole instruction stream.
        +
        +
        • +
      + + + +
        +
      • +

        isOpen

        +
        public boolean isOpen()
        +
        Description copied from interface: GuacamoleSocket
        +
        Returns whether this GuacamoleSocket is open and can be used for reading + and writing.
        +
        +
        Specified by:
        +
        isOpen in interface GuacamoleSocket
        +
        Returns:
        +
        true if this GuacamoleSocket is open, false otherwise.
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2017. All rights reserved.

+ + + +