├── LICENSE ├── README.md ├── SocketServer.class.php └── example.php /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | {description} 294 | Copyright (C) {year} {fullname} 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | {signature of Ty Coon}, 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | PHP-TCP-Port-Listener 2 | ===================== 3 | -------------------------------------------------------------------------------- /SocketServer.class.php: -------------------------------------------------------------------------------- 1 | hooks = array(); 48 | 49 | $this->config["ip"] = $bind_ip; 50 | $this->config["port"] = $port; 51 | 52 | $this->master_socket = socket_create(AF_INET, SOCK_STREAM, 0); 53 | socket_bind($this->master_socket,$this->config["ip"],$this->config["port"]) or die("Issue Binding"); 54 | socket_getsockname($this->master_socket,$bind_ip,$port); 55 | socket_listen($this->master_socket); 56 | SocketServer::debug("Listenting for connections on {$bind_ip}:{$port}"); 57 | } 58 | 59 | /*! @function hook 60 | @abstract Adds a function to be called whenever a certain action happens. Can be extended in your implementation. 61 | @param string - Command 62 | @param callback- Function to Call. 63 | @see unhook 64 | @see trigger_hooks 65 | @result void 66 | */ 67 | public function hook($command,$function) 68 | { 69 | $command = strtoupper($command); 70 | if(!isset($this->hooks[$command])) { $this->hooks[$command] = array(); } 71 | $k = array_search($function,$this->hooks[$command]); 72 | if($k === FALSE) 73 | { 74 | $this->hooks[$command][] = $function; 75 | } 76 | } 77 | 78 | /*! @function unhook 79 | @abstract Deletes a function from the call list for a certain action. Can be extended in your implementation. 80 | @param string - Command 81 | @param callback- Function to Delete from Call List 82 | @see hook 83 | @see trigger_hooks 84 | @result void 85 | */ 86 | public function unhook($command = NULL,$function) 87 | { 88 | $command = strtoupper($command); 89 | if($command !== NULL) 90 | { 91 | $k = array_search($function,$this->hooks[$command]); 92 | if($k !== FALSE) 93 | { 94 | unset($this->hooks[$command][$k]); 95 | } 96 | } else { 97 | $k = array_search($this->user_funcs,$function); 98 | if($k !== FALSE) 99 | { 100 | unset($this->user_funcs[$k]); 101 | } 102 | } 103 | } 104 | 105 | /*! @function loop_once 106 | @abstract Runs the class's actions once. 107 | @discussion Should only be used if you want to run additional checks during server operation. Otherwise, use infinite_loop() 108 | @param void 109 | @see infinite_loop 110 | @result bool - True 111 | */ 112 | public function loop_once() 113 | { 114 | // Setup Clients Listen Socket For Reading 115 | $read[0] = $this->master_socket; 116 | for($i = 0; $i < $this->max_clients; $i++) 117 | { 118 | if(isset($this->clients[$i])) 119 | { 120 | $read[$i + 1] = $this->clients[$i]->socket; 121 | } 122 | } 123 | 124 | // Set up a blocking call to socket_select 125 | if(socket_select($read,$write = NULL, $except = NULL, $tv_sec = 5) < 1) 126 | { 127 | // SocketServer::debug("Problem blocking socket_select?"); 128 | return true; 129 | } 130 | 131 | // Handle new Connections 132 | if(in_array($this->master_socket, $read)) 133 | { 134 | for($i = 0; $i < $this->max_clients; $i++) 135 | { 136 | if(empty($this->clients[$i])) 137 | { 138 | $temp_sock = $this->master_socket; 139 | $this->clients[$i] = new SocketServerClient($this->master_socket,$i); 140 | $this->trigger_hooks("CONNECT",$this->clients[$i],""); 141 | break; 142 | } 143 | elseif($i == ($this->max_clients-1)) 144 | { 145 | SocketServer::debug("Too many clients... :( "); 146 | } 147 | } 148 | 149 | } 150 | 151 | // Handle Input 152 | for($i = 0; $i < $this->max_clients; $i++) // for each client 153 | { 154 | if(isset($this->clients[$i])) 155 | { 156 | if(in_array($this->clients[$i]->socket, $read)) 157 | { 158 | $input = socket_read($this->clients[$i]->socket, $this->max_read); 159 | if($input == null) 160 | { 161 | $this->disconnect($i); 162 | } 163 | else 164 | { 165 | SocketServer::debug("{$i}@{$this->clients[$i]->ip} --> {$input}"); 166 | $this->trigger_hooks("INPUT",$this->clients[$i],$input); 167 | } 168 | } 169 | } 170 | } 171 | return true; 172 | } 173 | 174 | /*! @function disconnect 175 | @abstract Disconnects a client from the server. 176 | @param int - Index of the client to disconnect. 177 | @param string - Message to send to the hooks 178 | @result void 179 | */ 180 | public function disconnect($client_index,$message = "") 181 | { 182 | $i = $client_index; 183 | SocketServer::debug("Client {$i} from {$this->clients[$i]->ip} Disconnecting"); 184 | $this->trigger_hooks("DISCONNECT",$this->clients[$i],$message); 185 | $this->clients[$i]->destroy(); 186 | unset($this->clients[$i]); 187 | } 188 | 189 | /*! @function trigger_hooks 190 | @abstract Triggers Hooks for a certain command. 191 | @param string - Command who's hooks you want to trigger. 192 | @param object - The client who activated this command. 193 | @param string - The input from the client, or a message to be sent to the hooks. 194 | @result void 195 | */ 196 | public function trigger_hooks($command,&$client,$input) 197 | { 198 | if(isset($this->hooks[$command])) 199 | { 200 | foreach($this->hooks[$command] as $function) 201 | { 202 | SocketServer::debug("Triggering Hook '{$function}' for '{$command}'"); 203 | $continue = call_user_func($function,$this,$client,$input); 204 | if($continue === FALSE) { break; } 205 | } 206 | } 207 | } 208 | 209 | /*! @function infinite_loop 210 | @abstract Runs the server code until the server is shut down. 211 | @see loop_once 212 | @param void 213 | @result void 214 | */ 215 | public function infinite_loop() 216 | { 217 | $test = true; 218 | do 219 | { 220 | $test = $this->loop_once(); 221 | } 222 | while($test); 223 | } 224 | 225 | /*! @function debug 226 | @static 227 | @abstract Outputs Text directly. 228 | @discussion Yeah, should probably make a way to turn this off. 229 | @param string - Text to Output 230 | @result void 231 | */ 232 | public static function debug($text) 233 | { 234 | echo("{$text}\r\n"); 235 | } 236 | 237 | /*! @function socket_write_smart 238 | @static 239 | @abstract Writes data to the socket, including the length of the data, and ends it with a CRLF unless specified. 240 | @discussion It is perfectly valid for socket_write_smart to return zero which means no bytes have been written. Be sure to use the === operator to check for FALSE in case of an error. 241 | @param resource- Socket Instance 242 | @param string - Data to write to the socket. 243 | @param string - Data to end the line with. Specify a "" if you don't want a line end sent. 244 | @result mixed - Returns the number of bytes successfully written to the socket or FALSE on failure. The error code can be retrieved with socket_last_error(). This code may be passed to socket_strerror() to get a textual explanation of the error. 245 | */ 246 | public static function socket_write_smart(&$sock,$string,$crlf = "\r\n") 247 | { 248 | SocketServer::debug("<-- {$string}"); 249 | if($crlf) { $string = "{$string}{$crlf}"; } 250 | return socket_write($sock,$string,strlen($string)); 251 | } 252 | 253 | /*! @function __get 254 | @abstract Magic Method used for allowing the reading of protected variables. 255 | @discussion You never need to use this method, simply calling $server->variable works because of this method's existence. 256 | @param string - Variable to retrieve 257 | @result mixed - Returns the reference to the variable called. 258 | */ 259 | function &__get($name) 260 | { 261 | return $this->{$name}; 262 | } 263 | } 264 | 265 | /*! @class SocketServerClient 266 | @author Navarr Barnier 267 | @abstract A Client Instance for use with SocketServer 268 | */ 269 | class SocketServerClient 270 | { 271 | /*! @var socket 272 | @abstract resource - The client's socket resource, for sending and receiving data with. 273 | */ 274 | protected $socket; 275 | 276 | /*! @var ip 277 | @abstract string - The client's IP address, as seen by the server. 278 | */ 279 | protected $ip; 280 | 281 | /*! @var hostname 282 | @abstract string - The client's hostname, as seen by the server. 283 | @discussion This variable is only set after calling lookup_hostname, as hostname lookups can take up a decent amount of time. 284 | @see lookup_hostname 285 | */ 286 | protected $hostname; 287 | 288 | /*! @var server_clients_index 289 | @abstract int - The index of this client in the SocketServer's client array. 290 | */ 291 | protected $server_clients_index; 292 | 293 | /*! @function __construct 294 | @param resource- The resource of the socket the client is connecting by, generally the master socket. 295 | @param int - The Index in the Server's client array. 296 | @result void 297 | */ 298 | public function __construct(&$socket,$i) 299 | { 300 | $this->server_clients_index = $i; 301 | $this->socket = socket_accept($socket) or die("Failed to Accept"); 302 | SocketServer::debug("New Client Connected"); 303 | socket_getpeername($this->socket,$ip); 304 | $this->ip = $ip; 305 | } 306 | 307 | /*! @function lookup_hostname 308 | @abstract Searches for the user's hostname and stores the result to hostname. 309 | @see hostname 310 | @param void 311 | @result string - The hostname on success or the IP address on failure. 312 | */ 313 | public function lookup_hostname() 314 | { 315 | $this->hostname = gethostbyaddr($this->ip); 316 | return $this->hostname; 317 | } 318 | 319 | /*! @function destroy 320 | @abstract Closes the socket. Thats pretty much it. 321 | @param void 322 | @result void 323 | */ 324 | public function destroy() 325 | { 326 | socket_close($this->socket); 327 | } 328 | 329 | function &__get($name) 330 | { 331 | return $this->{$name}; 332 | } 333 | 334 | function __isset($name) 335 | { 336 | return isset($this->{$name}); 337 | } 338 | } -------------------------------------------------------------------------------- /example.php: -------------------------------------------------------------------------------- 1 | max_clients = 10; // Allow no more than 10 people to connect at a time 6 | $server->hook("CONNECT","handle_connect"); // Run handle_connect every time someone connects 7 | $server->hook("INPUT","handle_input"); // Run handle_input whenever text is sent to the server 8 | $server->infinite_loop(); // Run Server Code Until Process is terminated. 9 | 10 | 11 | function handle_connect(&$server,&$client,$input) { 12 | SocketServer::socket_write_smart($client->socket,"String? ",""); 13 | } 14 | 15 | 16 | function handle_input(&$server,&$client,$input) { 17 | // You probably want to sanitize your inputs here 18 | $trim = trim($input); // Trim the input, Remove Line Endings and Extra Whitespace. 19 | 20 | if(strtolower($trim) == "quit") // User Wants to quit the server 21 | { 22 | SocketServer::socket_write_smart($client->socket,"Oh... Goodbye..."); // Give the user a sad goodbye message, meany! 23 | $server->disconnect($client->server_clients_index); // Disconnect this client. 24 | return; // Ends the function 25 | } 26 | 27 | $output = strrev($trim); // Reverse the String 28 | 29 | SocketServer::socket_write_smart($client->socket,$output); // Send the Client back the String 30 | SocketServer::socket_write_smart($client->socket,"String? ",""); // Request Another String 31 | } 32 | 33 | 34 | /* 35 | Using socket_create, socket_bind, socket_listen, and socket_accept 36 | 37 | http://www.php.net/manual/en/function.socket-create.php 38 | 39 | http://www.php.net/manual/en/function.socket-bind.php 40 | 41 | http://www.php.net/manual/en/function.socket-listen.php 42 | 43 | http://www.php.net/manual/en/function.socket-accept.php 44 | 45 | There are lots of examples on those pages on how to use them. 46 | */ --------------------------------------------------------------------------------