include/client.h

   1
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is guacd.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Michael Jumper.
  19  * Portions created by the Initial Developer are Copyright (C) 2010
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38
  39 #ifndef _GUACD_CLIENT_H
  40 #define _GUACD_CLIENT_H
  41
  42 /**
  43  * Provides functions and structures required for defining (and handling) a proxy client.
  44  *
  45  * @file client.h
  46  */
  47
  48 /**
  49  * The time to allow between sync responses in milliseconds. If a sync
  50  * instruction is sent to the client and no response is received within this
  51  * timeframe, server messages will not be handled until a sync instruction is
  52  * received from the client.
  53  */
  54 #define GUAC_SYNC_THRESHOLD 500
  55
  56 /**
  57  * The time to allow between server sync messages in milliseconds. A sync
  58  * message from the server will be sent every GUAC_SYNC_FREQUENCY milliseconds.
  59  * As this will induce a response from a client that is not malfunctioning,
  60  * this is used to detect when a client has died. This must be set to a
  61  * reasonable value to avoid clients being disconnected unnecessarily due
  62  * to timeout.
  63  */
  64 #define GUAC_SYNC_FREQUENCY 5000
  65
  66 /**
  67  * The amount of time to wait after handling server messages. If a client
  68  * plugin has a message handler, and sends instructions when server messages
  69  * are being handled, there will be a pause of this many milliseconds before
  70  * the next call to the message handler.
  71  */
  72 #define GUAC_SERVER_MESSAGE_HANDLE_FREQUENCY 50
  73
  74 /**
  75  * The number of milliseconds to wait for messages in any phase before
  76  * timing out and closing the connection with an error.
  77  */
  78 #define GUAC_TIMEOUT      15000
  79
  80 /**
  81  * The number of microseconds to wait for messages in any phase before
  82  * timing out and closing the conncetion with an error. This is always
  83  * equal to GUAC_TIMEOUT * 1000.
  84  */
  85 #define GUAC_USEC_TIMEOUT (GUAC_TIMEOUT*1000)
  86
  87
  88 void guac_client_stop(guac_client* client);
  89 int guac_start_client(guac_client* client);
  90
  91 #endif