changed file headers & added AUTHORS file
[PHP-P10.git] / Uplink / Uplink.class.php
index 85adeaeb81bc92f46482e536e25d82671f210e7d..9d88ae523af513b05e5dd9b2223c2d1a0324767d 100644 (file)
@@ -1,22 +1,19 @@
 <?php
-/********************************* PHP-P10 ******************************
- *    P10 uplink class by pk910   (c)2011 pk910                         *
- ************************************************************************
- *                          Version 2 (OOP)                             *
+/******************************* PHP-P10 v2 *****************************
+ * Copyright (C) 2011  Philipp Kreil (pk910)                            *
  *                                                                      *
- * PHP-P10 is free software; you can redistribute it and/or modify      *
+ * This program is free software: you can redistribute it and/or modify *
  * it under the terms of the GNU General Public License as published by *
- * the Free Software Foundation; either version 2 of the License, or    *
+ * the Free Software Foundation, either version 3 of the License, or    *
  * (at your option) any later version.                                  *
- *                                                                      *
+ *                                                                      * 
  * This program is distributed in the hope that it will be useful,      *
  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
  * GNU General Public License for more details.                         *
  *                                                                      *
  * You should have received a copy of the GNU General Public License    *
- * along with PHP-P10; if not, write to the Free Software Foundation,   *
- * Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.       *
+ * along with this program. If not, see <http://www.gnu.org/licenses/>. *
  *                                                                      *
  ************************************************************************
  * 
  *
  * This file contains the basic P10 Protocol handler.
  *
- ************************************************************************
- * accessable methods:
- *
- * void initialize()
- *     has to be called after the settings have been set.
- *
- * void loop() 
- *     loop function that should be calles as many times as possible. 
- *     It reads from the socket and BLOCKS the script execution for a 
- *     specific time if nothing is received.
- *
- * void setUplinkHost(String $host, int $port, bool $ssl = false, String $bind = null)
- *     sets the Uplink connection information.
- *
- * void setLoopTimeout(int $timeout)
- *     sets the maximum time loop() is blocking the script execution.
- *
- * void setUplinkServer(int $numeric, String $name, String $password, String $description)
- *     sets the own P10 Server information.
- *
- * void setValidateServer(String $name, String $password)
- *     sets additional security relevant information about the remote server.
- *
- * void setHISOptions(String $serverName, String $serverDescription String $usermask)
- *     sets the default Account fakehost
- *
- * void setEventHandler(EventHandler $event_handler)
- *     sets the EventHandlder
  */
 require_once("Client.class.php");
 require_once("Numerics.class.php");