├── LICENSE ├── LICENSE.MIT ├── README.md ├── ack.go ├── caller.go ├── client.go ├── examples ├── client.go └── server.go ├── handler.go ├── loop.go ├── protocol ├── message.go └── socketio.go ├── send.go ├── server.go └── transport ├── transport.go └── websocket.go /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /LICENSE.MIT: -------------------------------------------------------------------------------- 1 | (The MIT License) 2 | 3 | Copyright (c) 2016 Gennadiy Kovalev 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining 6 | a copy of this software and associated documentation files (the 7 | 'Software'), to deal in the Software without restriction, including 8 | without limitation the rights to use, copy, modify, merge, publish, 9 | distribute, sublicense, and/or sell copies of the Software, and to 10 | permit persons to whom the Software is furnished to do so, subject to 11 | the following conditions: 12 | 13 | The above copyright notice and this permission notice shall be 14 | included in all copies or substantial portions of the Software. 15 | 16 | THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, 17 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 18 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 19 | IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 20 | CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 21 | TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 22 | SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 23 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | golang socket.io 2 | ================ 3 | 4 | golang implementation of [socket.io](http://socket.io) library, client and server 5 | 6 | You can check working chat server, based on caller library, at http://funstream.tv 7 | 8 | Examples directory contains simple client and server. 9 | 10 | ### Installation 11 | 12 | go get github.com/nature613/golang-socketio 13 | 14 | ### Simple server usage 15 | 16 | ```go 17 | //create 18 | server := gosocketio.NewServer(transport.GetDefaultWebsocketTransport()) 19 | 20 | //handle connected 21 | server.On(gosocketio.OnConnection, func(c *gosocketio.Channel) { 22 | log.Println("New client connected") 23 | //join them to room 24 | c.Join("chat") 25 | }) 26 | 27 | type Message struct { 28 | Name string `json:"name"` 29 | Message string `json:"message"` 30 | } 31 | 32 | //handle custom event 33 | server.On("send", func(c *gosocketio.Channel, msg Message) string { 34 | //send event to all in room 35 | c.BroadcastTo("chat", "message", msg) 36 | return "OK" 37 | }) 38 | 39 | //setup http server 40 | serveMux := http.NewServeMux() 41 | serveMux.Handle("/socket.io/", server) 42 | log.Panic(http.ListenAndServe(":80", serveMux)) 43 | ``` 44 | 45 | ### Javascript client for caller server 46 | 47 | ```javascript 48 | var socket = io('ws://yourdomain.com', {transports: ['websocket']}); 49 | 50 | // listen for messages 51 | socket.on('message', function(message) { 52 | 53 | console.log('new message'); 54 | console.log(message); 55 | }); 56 | 57 | socket.on('connect', function () { 58 | 59 | console.log('socket connected'); 60 | 61 | //send something 62 | socket.emit('send', {name: "my name", message: "hello"}, function(result) { 63 | 64 | console.log('sended successfully'); 65 | console.log(result); 66 | }); 67 | }); 68 | ``` 69 | 70 | ### Server, detailed usage 71 | 72 | ```go 73 | //create server instance, you can setup transport parameters or get the default one 74 | //look at websocket.go for parameters description 75 | server := gosocketio.NewServer(transport.GetDefaultWebsocketTransport()) 76 | 77 | // --- caller is default handlers 78 | 79 | //on connection handler, occurs once for each connected client 80 | server.On(gosocketio.OnConnection, func(c *gosocketio.Channel, args interface{}) { 81 | //client id is unique 82 | log.Println("New client connected, client id is ", c.Id()) 83 | 84 | //you can join clients to rooms 85 | c.Join("room name") 86 | 87 | //of course, you can list the clients in the room, or account them 88 | channels := c.List(data.Channel) 89 | //or check the amount of clients in room 90 | amount := c.Amount(data.Channel) 91 | log.Println(amount, "clients in room") 92 | }) 93 | //on disconnection handler, if client hangs connection unexpectedly, it will still occurs 94 | //you can omit function args if you do not need them 95 | //you can return string value for ack, or return nothing for emit 96 | server.On(gosocketio.OnDisconnection, func(c *gosocketio.Channel) { 97 | //caller is not necessary, client will be removed from rooms 98 | //automatically on disconnect 99 | //but you can remove client from room whenever you need to 100 | c.Leave("room name") 101 | 102 | log.Println("Disconnected") 103 | }) 104 | //error catching handler 105 | server.On(gosocketio.OnError, func(c *gosocketio.Channel) { 106 | log.Println("Error occurs") 107 | }) 108 | 109 | // --- caller is custom handler 110 | 111 | //custom event handler 112 | server.On("handle something", func(c *gosocketio.Channel, channel Channel) string { 113 | log.Println("Something successfully handled") 114 | 115 | //you can return result of handler, in caller case 116 | //handler will be converted from "emit" to "ack" 117 | return "result" 118 | }) 119 | 120 | //you can get client connection by it's id 121 | channel, _ := server.GetChannel("client id here") 122 | //and send the event to the client 123 | type MyEventData struct { 124 | Data: string 125 | } 126 | channel.Emit("my event", MyEventData{"my data"}) 127 | 128 | //or you can send ack to client and get result back 129 | result, err := channel.Ack("my custom ack", MyEventData{"ack data"}, time.Second * 5) 130 | 131 | //you can broadcast to all clients 132 | server.BroadcastToAll("my event", MyEventData{"broadcast"}) 133 | 134 | //or for clients joined to room 135 | server.BroadcastTo("my room", "my event", MyEventData{"room broadcast"}) 136 | 137 | //setup http server like caller for handling connections 138 | serveMux := http.NewServeMux() 139 | serveMux.Handle("/socket.io/", server) 140 | log.Panic(http.ListenAndServe(":80", serveMux)) 141 | ``` 142 | 143 | ### Client 144 | 145 | ```go 146 | //connect to server, you can use your own transport settings 147 | c, err := gosocketio.Dial( 148 | gosocketio.GetUrl("localhost", 80, false), 149 | transport.GetDefaultWebsocketTransport(), 150 | ) 151 | 152 | //do something, handlers and functions are same as server ones 153 | 154 | //close connection 155 | c.Close() 156 | ``` 157 | 158 | ### Roadmap 159 | 160 | 1. Tests 161 | 2. Travis CI 162 | 3. http longpoll transport 163 | 4. pure http (short-timed queries) transport 164 | 5. binary format 165 | 166 | ### Licence 167 | 168 | Double licensed under GPL3 and MIT so you can use whichever you please. 169 | -------------------------------------------------------------------------------- /ack.go: -------------------------------------------------------------------------------- 1 | package gosocketio 2 | 3 | import ( 4 | "errors" 5 | "sync" 6 | ) 7 | 8 | var ( 9 | ErrorWaiterNotFound = errors.New("Waiter not found") 10 | ) 11 | 12 | /** 13 | Processes functions that require answers, also known as acknowledge or ack 14 | */ 15 | type ackProcessor struct { 16 | counter int 17 | counterLock sync.Mutex 18 | 19 | resultWaiters map[int](chan string) 20 | resultWaitersLock sync.RWMutex 21 | } 22 | 23 | /** 24 | get next id of ack call 25 | */ 26 | func (a *ackProcessor) getNextId() int { 27 | a.counterLock.Lock() 28 | defer a.counterLock.Unlock() 29 | 30 | a.counter++ 31 | return a.counter 32 | } 33 | 34 | /** 35 | Just before the ack function called, the waiter should be added 36 | to wait and receive response to ack call 37 | */ 38 | func (a *ackProcessor) addWaiter(id int, w chan string) { 39 | a.resultWaitersLock.Lock() 40 | a.resultWaiters[id] = w 41 | a.resultWaitersLock.Unlock() 42 | } 43 | 44 | /** 45 | removes waiter that is unnecessary anymore 46 | */ 47 | func (a *ackProcessor) removeWaiter(id int) { 48 | a.resultWaitersLock.Lock() 49 | delete(a.resultWaiters, id) 50 | a.resultWaitersLock.Unlock() 51 | } 52 | 53 | /** 54 | check if waiter with given ack id is exists, and returns it 55 | */ 56 | func (a *ackProcessor) getWaiter(id int) (chan string, error) { 57 | a.resultWaitersLock.RLock() 58 | defer a.resultWaitersLock.RUnlock() 59 | 60 | if waiter, ok := a.resultWaiters[id]; ok { 61 | return waiter, nil 62 | } 63 | return nil, ErrorWaiterNotFound 64 | } 65 | -------------------------------------------------------------------------------- /caller.go: -------------------------------------------------------------------------------- 1 | package gosocketio 2 | 3 | import ( 4 | "errors" 5 | "reflect" 6 | ) 7 | 8 | type caller struct { 9 | Func reflect.Value 10 | Args reflect.Type 11 | ArgsPresent bool 12 | Out bool 13 | } 14 | 15 | var ( 16 | ErrorCallerNotFunc = errors.New("f is not function") 17 | ErrorCallerNot2Args = errors.New("f should have 1 or 2 args") 18 | ErrorCallerMaxOneValue = errors.New("f should return not more than one value") 19 | ) 20 | 21 | /** 22 | Parses function passed by using reflection, and stores its representation 23 | for further call on message or ack 24 | */ 25 | func newCaller(f interface{}) (*caller, error) { 26 | fVal := reflect.ValueOf(f) 27 | if fVal.Kind() != reflect.Func { 28 | return nil, ErrorCallerNotFunc 29 | } 30 | 31 | fType := fVal.Type() 32 | if fType.NumOut() > 1 { 33 | return nil, ErrorCallerMaxOneValue 34 | } 35 | 36 | curCaller := &caller{ 37 | Func: fVal, 38 | Out: fType.NumOut() == 1, 39 | } 40 | if fType.NumIn() == 1 { 41 | curCaller.Args = nil 42 | curCaller.ArgsPresent = false 43 | } else if fType.NumIn() == 2 { 44 | curCaller.Args = fType.In(1) 45 | curCaller.ArgsPresent = true 46 | } else { 47 | return nil, ErrorCallerNot2Args 48 | } 49 | 50 | return curCaller, nil 51 | } 52 | 53 | /** 54 | returns function parameter as it is present in it using reflection 55 | */ 56 | func (c *caller) getArgs() interface{} { 57 | return reflect.New(c.Args).Interface() 58 | } 59 | 60 | /** 61 | calls function with given arguments from its representation using reflection 62 | */ 63 | func (c *caller) callFunc(h *Channel, args interface{}) []reflect.Value { 64 | //nil is untyped, so use the default empty value of correct type 65 | if args == nil { 66 | args = c.getArgs() 67 | } 68 | 69 | a := []reflect.Value{reflect.ValueOf(h), reflect.ValueOf(args).Elem()} 70 | if !c.ArgsPresent { 71 | a = a[0:1] 72 | } 73 | 74 | return c.Func.Call(a) 75 | } 76 | -------------------------------------------------------------------------------- /client.go: -------------------------------------------------------------------------------- 1 | package gosocketio 2 | 3 | import ( 4 | "github.com/graarh/golang-socketio/transport" 5 | "strconv" 6 | ) 7 | 8 | const ( 9 | webSocketProtocol = "ws://" 10 | webSocketSecureProtocol = "wss://" 11 | socketioUrl = "/socket.io/?EIO=3&transport=websocket" 12 | ) 13 | 14 | /** 15 | Socket.io client representation 16 | */ 17 | type Client struct { 18 | methods 19 | Channel 20 | } 21 | 22 | /** 23 | Get ws/wss url by host and port 24 | */ 25 | func GetUrl(host string, port int, secure bool) string { 26 | var prefix string 27 | if secure { 28 | prefix = webSocketSecureProtocol 29 | } else { 30 | prefix = webSocketProtocol 31 | } 32 | return prefix + host + ":" + strconv.Itoa(port) + socketioUrl 33 | } 34 | 35 | /** 36 | connect to host and initialise socket.io protocol 37 | 38 | The correct ws protocol url example: 39 | ws://myserver.com/socket.io/?EIO=3&transport=websocket 40 | 41 | You can use GetUrlByHost for generating correct url 42 | */ 43 | func Dial(url string, tr transport.Transport) (*Client, error) { 44 | c := &Client{} 45 | c.initChannel() 46 | c.initMethods() 47 | 48 | var err error 49 | c.conn, err = tr.Connect(url) 50 | if err != nil { 51 | return nil, err 52 | } 53 | 54 | go inLoop(&c.Channel, &c.methods) 55 | go outLoop(&c.Channel, &c.methods) 56 | go pinger(&c.Channel) 57 | 58 | return c, nil 59 | } 60 | 61 | /** 62 | Close client connection 63 | */ 64 | func (c *Client) Close() { 65 | closeChannel(&c.Channel, &c.methods) 66 | } 67 | -------------------------------------------------------------------------------- /examples/client.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "github.com/graarh/golang-socketio" 5 | "github.com/graarh/golang-socketio/transport" 6 | "log" 7 | "runtime" 8 | "time" 9 | ) 10 | 11 | type Channel struct { 12 | Channel string `json:"channel"` 13 | } 14 | 15 | type Message struct { 16 | Id int `json:"id"` 17 | Channel string `json:"channel"` 18 | Text string `json:"text"` 19 | } 20 | 21 | func sendJoin(c *gosocketio.Client) { 22 | log.Println("Acking /join") 23 | result, err := c.Ack("/join", Channel{"main"}, time.Second*5) 24 | if err != nil { 25 | log.Fatal(err) 26 | } else { 27 | log.Println("Ack result to /join: ", result) 28 | } 29 | } 30 | 31 | func main() { 32 | runtime.GOMAXPROCS(runtime.NumCPU()) 33 | 34 | c, err := gosocketio.Dial( 35 | gosocketio.GetUrl("localhost", 3811, false), 36 | transport.GetDefaultWebsocketTransport()) 37 | if err != nil { 38 | log.Fatal(err) 39 | } 40 | 41 | err = c.On("/message", func(h *gosocketio.Channel, args Message) { 42 | log.Println("--- Got chat message: ", args) 43 | }) 44 | if err != nil { 45 | log.Fatal(err) 46 | } 47 | 48 | err = c.On(gosocketio.OnDisconnection, func(h *gosocketio.Channel) { 49 | log.Fatal("Disconnected") 50 | }) 51 | if err != nil { 52 | log.Fatal(err) 53 | } 54 | 55 | err = c.On(gosocketio.OnConnection, func(h *gosocketio.Channel) { 56 | log.Println("Connected") 57 | }) 58 | if err != nil { 59 | log.Fatal(err) 60 | } 61 | 62 | time.Sleep(1 * time.Second) 63 | 64 | go sendJoin(c) 65 | go sendJoin(c) 66 | go sendJoin(c) 67 | go sendJoin(c) 68 | go sendJoin(c) 69 | 70 | time.Sleep(60 * time.Second) 71 | c.Close() 72 | 73 | log.Println(" [x] Complete") 74 | } 75 | -------------------------------------------------------------------------------- /examples/server.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "github.com/graarh/golang-socketio" 5 | "github.com/graarh/golang-socketio/transport" 6 | "log" 7 | "net/http" 8 | "time" 9 | ) 10 | 11 | type Channel struct { 12 | Channel string `json:"channel"` 13 | } 14 | 15 | type Message struct { 16 | Id int `json:"id"` 17 | Channel string `json:"channel"` 18 | Text string `json:"text"` 19 | } 20 | 21 | func main() { 22 | server := gosocketio.NewServer(transport.GetDefaultWebsocketTransport()) 23 | 24 | server.On(gosocketio.OnConnection, func(c *gosocketio.Channel) { 25 | log.Println("Connected") 26 | 27 | c.Emit("/message", Message{10, "main", "using emit"}) 28 | 29 | c.Join("test") 30 | c.BroadcastTo("test", "/message", Message{10, "main", "using broadcast"}) 31 | }) 32 | server.On(gosocketio.OnDisconnection, func(c *gosocketio.Channel) { 33 | log.Println("Disconnected") 34 | }) 35 | 36 | server.On("/join", func(c *gosocketio.Channel, channel Channel) string { 37 | time.Sleep(2 * time.Second) 38 | log.Println("Client joined to ", channel.Channel) 39 | return "joined to " + channel.Channel 40 | }) 41 | 42 | serveMux := http.NewServeMux() 43 | serveMux.Handle("/socket.io/", server) 44 | 45 | log.Println("Starting server...") 46 | log.Panic(http.ListenAndServe(":3811", serveMux)) 47 | } 48 | -------------------------------------------------------------------------------- /handler.go: -------------------------------------------------------------------------------- 1 | package gosocketio 2 | 3 | import ( 4 | "encoding/json" 5 | "github.com/graarh/golang-socketio/protocol" 6 | "sync" 7 | "reflect" 8 | ) 9 | 10 | const ( 11 | OnConnection = "connection" 12 | OnDisconnection = "disconnection" 13 | OnError = "error" 14 | ) 15 | 16 | /** 17 | System handler function for internal event processing 18 | */ 19 | type systemHandler func(c *Channel) 20 | 21 | /** 22 | Contains maps of message processing functions 23 | */ 24 | type methods struct { 25 | messageHandlers map[string]*caller 26 | messageHandlersLock sync.RWMutex 27 | 28 | onConnection systemHandler 29 | onDisconnection systemHandler 30 | } 31 | 32 | /** 33 | create messageHandlers map 34 | */ 35 | func (m *methods) initMethods() { 36 | m.messageHandlers = make(map[string]*caller) 37 | } 38 | 39 | /** 40 | Add message processing function, and bind it to given method 41 | */ 42 | func (m *methods) On(method string, f interface{}) error { 43 | c, err := newCaller(f) 44 | if err != nil { 45 | return err 46 | } 47 | 48 | m.messageHandlersLock.Lock() 49 | defer m.messageHandlersLock.Unlock() 50 | m.messageHandlers[method] = c 51 | 52 | return nil 53 | } 54 | 55 | /** 56 | Find message processing function associated with given method 57 | */ 58 | func (m *methods) findMethod(method string) (*caller, bool) { 59 | m.messageHandlersLock.RLock() 60 | defer m.messageHandlersLock.RUnlock() 61 | 62 | f, ok := m.messageHandlers[method] 63 | return f, ok 64 | } 65 | 66 | func (m *methods) callLoopEvent(c *Channel, event string) { 67 | if m.onConnection != nil && event == OnConnection { 68 | m.onConnection(c) 69 | } 70 | if m.onDisconnection != nil && event == OnDisconnection { 71 | m.onDisconnection(c) 72 | } 73 | 74 | f, ok := m.findMethod(event) 75 | if !ok { 76 | return 77 | } 78 | 79 | f.callFunc(c, &struct{}{}) 80 | } 81 | 82 | /** 83 | Check incoming message 84 | On ack_resp - look for waiter 85 | On ack_req - look for processing function and send ack_resp 86 | On emit - look for processing function 87 | */ 88 | func (m *methods) processIncomingMessage(c *Channel, msg *protocol.Message) { 89 | switch msg.Type { 90 | case protocol.MessageTypeEmit: 91 | f, ok := m.findMethod(msg.Method) 92 | if !ok { 93 | return 94 | } 95 | 96 | if !f.ArgsPresent { 97 | f.callFunc(c, &struct{}{}) 98 | return 99 | } 100 | 101 | data := f.getArgs() 102 | err := json.Unmarshal([]byte(msg.Args), &data) 103 | if err != nil { 104 | return 105 | } 106 | 107 | f.callFunc(c, data) 108 | 109 | case protocol.MessageTypeAckRequest: 110 | f, ok := m.findMethod(msg.Method) 111 | if !ok || !f.Out { 112 | return 113 | } 114 | 115 | var result []reflect.Value 116 | if f.ArgsPresent { 117 | //data type should be defined for unmarshall 118 | data := f.getArgs() 119 | err := json.Unmarshal([]byte(msg.Args), &data) 120 | if err != nil { 121 | return 122 | } 123 | 124 | result = f.callFunc(c, data) 125 | } else { 126 | result = f.callFunc(c, &struct{}{}) 127 | } 128 | 129 | ack := &protocol.Message{ 130 | Type: protocol.MessageTypeAckResponse, 131 | AckId: msg.AckId, 132 | } 133 | send(ack, c, result[0].Interface()) 134 | 135 | case protocol.MessageTypeAckResponse: 136 | waiter, err := c.ack.getWaiter(msg.AckId) 137 | if err == nil { 138 | waiter <- msg.Args 139 | } 140 | } 141 | } 142 | -------------------------------------------------------------------------------- /loop.go: -------------------------------------------------------------------------------- 1 | package gosocketio 2 | 3 | import ( 4 | "encoding/json" 5 | "errors" 6 | "github.com/graarh/golang-socketio/protocol" 7 | "github.com/graarh/golang-socketio/transport" 8 | "net/http" 9 | "sync" 10 | "time" 11 | ) 12 | 13 | const ( 14 | queueBufferSize = 500 15 | ) 16 | 17 | var ( 18 | ErrorWrongHeader = errors.New("Wrong header") 19 | ) 20 | 21 | /** 22 | engine.io header to send or receive 23 | */ 24 | type Header struct { 25 | Sid string `json:"sid"` 26 | Upgrades []string `json:"upgrades"` 27 | PingInterval int `json:"pingInterval"` 28 | PingTimeout int `json:"pingTimeout"` 29 | } 30 | 31 | /** 32 | socket.io connection handler 33 | 34 | use IsAlive to check that handler is still working 35 | use Dial to connect to websocket 36 | use In and Out channels for message exchange 37 | Close message means channel is closed 38 | ping is automatic 39 | */ 40 | type Channel struct { 41 | conn transport.Connection 42 | 43 | out chan string 44 | header Header 45 | 46 | alive bool 47 | aliveLock sync.Mutex 48 | 49 | ack ackProcessor 50 | 51 | server *Server 52 | ip string 53 | requestHeader http.Header 54 | } 55 | 56 | /** 57 | create channel, map, and set active 58 | */ 59 | func (c *Channel) initChannel() { 60 | //TODO: queueBufferSize from constant to server or client variable 61 | c.out = make(chan string, queueBufferSize) 62 | c.ack.resultWaiters = make(map[int](chan string)) 63 | c.alive = true 64 | } 65 | 66 | /** 67 | Get id of current socket connection 68 | */ 69 | func (c *Channel) Id() string { 70 | return c.header.Sid 71 | } 72 | 73 | /** 74 | Checks that Channel is still alive 75 | */ 76 | func (c *Channel) IsAlive() bool { 77 | c.aliveLock.Lock() 78 | defer c.aliveLock.Unlock() 79 | 80 | return c.alive 81 | } 82 | 83 | /** 84 | Close channel 85 | */ 86 | func closeChannel(c *Channel, m *methods, args ...interface{}) error { 87 | c.aliveLock.Lock() 88 | defer c.aliveLock.Unlock() 89 | 90 | if !c.alive { 91 | //already closed 92 | return nil 93 | } 94 | 95 | c.conn.Close() 96 | c.alive = false 97 | 98 | //clean outloop 99 | for len(c.out) > 0 { 100 | <-c.out 101 | } 102 | c.out <- protocol.CloseMessage 103 | 104 | m.callLoopEvent(c, OnDisconnection) 105 | 106 | overfloodedLock.Lock() 107 | delete(overflooded, c) 108 | overfloodedLock.Unlock() 109 | 110 | return nil 111 | } 112 | 113 | //incoming messages loop, puts incoming messages to In channel 114 | func inLoop(c *Channel, m *methods) error { 115 | for { 116 | pkg, err := c.conn.GetMessage() 117 | if err != nil { 118 | return closeChannel(c, m, err) 119 | } 120 | msg, err := protocol.Decode(pkg) 121 | if err != nil { 122 | closeChannel(c, m, protocol.ErrorWrongPacket) 123 | return err 124 | } 125 | 126 | switch msg.Type { 127 | case protocol.MessageTypeOpen: 128 | if err := json.Unmarshal([]byte(msg.Source[1:]), &c.header); err != nil { 129 | closeChannel(c, m, ErrorWrongHeader) 130 | } 131 | m.callLoopEvent(c, OnConnection) 132 | case protocol.MessageTypePing: 133 | c.out <- protocol.PongMessage 134 | case protocol.MessageTypePong: 135 | default: 136 | go m.processIncomingMessage(c, msg) 137 | } 138 | } 139 | return nil 140 | } 141 | 142 | var overflooded map[*Channel]struct{} = make(map[*Channel]struct{}) 143 | var overfloodedLock sync.Mutex 144 | 145 | func AmountOfOverflooded() int64 { 146 | overfloodedLock.Lock() 147 | defer overfloodedLock.Unlock() 148 | 149 | return int64(len(overflooded)) 150 | } 151 | 152 | /** 153 | outgoing messages loop, sends messages from channel to socket 154 | */ 155 | func outLoop(c *Channel, m *methods) error { 156 | for { 157 | outBufferLen := len(c.out) 158 | if outBufferLen >= queueBufferSize-1 { 159 | return closeChannel(c, m, ErrorSocketOverflood) 160 | } else if outBufferLen > int(queueBufferSize/2) { 161 | overfloodedLock.Lock() 162 | overflooded[c] = struct{}{} 163 | overfloodedLock.Unlock() 164 | } else { 165 | overfloodedLock.Lock() 166 | delete(overflooded, c) 167 | overfloodedLock.Unlock() 168 | } 169 | 170 | msg := <-c.out 171 | if msg == protocol.CloseMessage { 172 | return nil 173 | } 174 | 175 | err := c.conn.WriteMessage(msg) 176 | if err != nil { 177 | return closeChannel(c, m, err) 178 | } 179 | } 180 | return nil 181 | } 182 | 183 | /** 184 | Pinger sends ping messages for keeping connection alive 185 | */ 186 | func pinger(c *Channel) { 187 | for { 188 | interval, _ := c.conn.PingParams() 189 | time.Sleep(interval) 190 | if !c.IsAlive() { 191 | return 192 | } 193 | 194 | c.out <- protocol.PingMessage 195 | } 196 | } 197 | -------------------------------------------------------------------------------- /protocol/message.go: -------------------------------------------------------------------------------- 1 | package protocol 2 | 3 | const ( 4 | /** 5 | Message with connection options 6 | */ 7 | MessageTypeOpen = iota 8 | /** 9 | Close connection and destroy all handle routines 10 | */ 11 | MessageTypeClose = iota 12 | /** 13 | Ping request message 14 | */ 15 | MessageTypePing = iota 16 | /** 17 | Pong response message 18 | */ 19 | MessageTypePong = iota 20 | /** 21 | Empty message 22 | */ 23 | MessageTypeEmpty = iota 24 | /** 25 | Emit request, no response 26 | */ 27 | MessageTypeEmit = iota 28 | /** 29 | Emit request, wait for response (ack) 30 | */ 31 | MessageTypeAckRequest = iota 32 | /** 33 | ack response 34 | */ 35 | MessageTypeAckResponse = iota 36 | ) 37 | 38 | type Message struct { 39 | Type int 40 | AckId int 41 | Method string 42 | Args string 43 | Source string 44 | } 45 | 46 | -------------------------------------------------------------------------------- /protocol/socketio.go: -------------------------------------------------------------------------------- 1 | package protocol 2 | 3 | import ( 4 | "encoding/json" 5 | "errors" 6 | "strconv" 7 | "strings" 8 | ) 9 | 10 | const ( 11 | open = "0" 12 | msg = "4" 13 | emptyMessage = "40" 14 | commonMessage = "42" 15 | ackMessage = "43" 16 | 17 | CloseMessage = "1" 18 | PingMessage = "2" 19 | PongMessage = "3" 20 | ) 21 | 22 | var ( 23 | ErrorWrongMessageType = errors.New("Wrong message type") 24 | ErrorWrongPacket = errors.New("Wrong packet") 25 | ) 26 | 27 | func typeToText(msgType int) (string, error) { 28 | switch msgType { 29 | case MessageTypeOpen: 30 | return open, nil 31 | case MessageTypeClose: 32 | return CloseMessage, nil 33 | case MessageTypePing: 34 | return PingMessage, nil 35 | case MessageTypePong: 36 | return PongMessage, nil 37 | case MessageTypeEmpty: 38 | return emptyMessage, nil 39 | case MessageTypeEmit, MessageTypeAckRequest: 40 | return commonMessage, nil 41 | case MessageTypeAckResponse: 42 | return ackMessage, nil 43 | } 44 | return "", ErrorWrongMessageType 45 | } 46 | 47 | func Encode(msg *Message) (string, error) { 48 | result, err := typeToText(msg.Type) 49 | if err != nil { 50 | return "", err 51 | } 52 | 53 | if msg.Type == MessageTypeEmpty || msg.Type == MessageTypePing || 54 | msg.Type == MessageTypePong { 55 | return result, nil 56 | } 57 | 58 | if msg.Type == MessageTypeAckRequest || msg.Type == MessageTypeAckResponse { 59 | result += strconv.Itoa(msg.AckId) 60 | } 61 | 62 | if msg.Type == MessageTypeOpen || msg.Type == MessageTypeClose { 63 | return result + msg.Args, nil 64 | } 65 | 66 | if msg.Type == MessageTypeAckResponse { 67 | return result + "[" + msg.Args + "]", nil 68 | } 69 | 70 | jsonMethod, err := json.Marshal(&msg.Method) 71 | if err != nil { 72 | return "", err 73 | } 74 | 75 | return result + "[" + string(jsonMethod) + "," + msg.Args + "]", nil 76 | } 77 | 78 | func MustEncode(msg *Message) string { 79 | result, err := Encode(msg) 80 | if err != nil { 81 | panic(err) 82 | } 83 | 84 | return result 85 | } 86 | 87 | func getMessageType(data string) (int, error) { 88 | if len(data) == 0 { 89 | return 0, ErrorWrongMessageType 90 | } 91 | switch data[0:1] { 92 | case open: 93 | return MessageTypeOpen, nil 94 | case CloseMessage: 95 | return MessageTypeClose, nil 96 | case PingMessage: 97 | return MessageTypePing, nil 98 | case PongMessage: 99 | return MessageTypePong, nil 100 | case msg: 101 | if len(data) == 1 { 102 | return 0, ErrorWrongMessageType 103 | } 104 | switch data[0:2] { 105 | case emptyMessage: 106 | return MessageTypeEmpty, nil 107 | case commonMessage: 108 | return MessageTypeAckRequest, nil 109 | case ackMessage: 110 | return MessageTypeAckResponse, nil 111 | } 112 | } 113 | return 0, ErrorWrongMessageType 114 | } 115 | 116 | /** 117 | Get ack id of current packet, if present 118 | */ 119 | func getAck(text string) (ackId int, restText string, err error) { 120 | if len(text) < 4 { 121 | return 0, "", ErrorWrongPacket 122 | } 123 | text = text[2:] 124 | 125 | pos := strings.IndexByte(text, '[') 126 | if pos == -1 { 127 | return 0, "", ErrorWrongPacket 128 | } 129 | 130 | ack, err := strconv.Atoi(text[0:pos]) 131 | if err != nil { 132 | return 0, "", err 133 | } 134 | 135 | return ack, text[pos:], nil 136 | } 137 | 138 | /** 139 | Get message method of current packet, if present 140 | */ 141 | func getMethod(text string) (method, restText string, err error) { 142 | var start, end, rest, countQuote int 143 | 144 | for i, c := range text { 145 | if c == '"' { 146 | switch countQuote { 147 | case 0: 148 | start = i + 1 149 | case 1: 150 | end = i 151 | rest = i + 1 152 | default: 153 | return "", "", ErrorWrongPacket 154 | } 155 | countQuote++ 156 | } 157 | if c == ',' { 158 | if countQuote < 2 { 159 | continue 160 | } 161 | rest = i + 1 162 | break 163 | } 164 | } 165 | 166 | if (end < start) || (rest >= len(text)) { 167 | return "", "", ErrorWrongPacket 168 | } 169 | 170 | return text[start:end], text[rest : len(text)-1], nil 171 | } 172 | 173 | func Decode(data string) (*Message, error) { 174 | var err error 175 | msg := &Message{} 176 | msg.Source = data 177 | 178 | msg.Type, err = getMessageType(data) 179 | if err != nil { 180 | return nil, err 181 | } 182 | 183 | if msg.Type == MessageTypeOpen { 184 | msg.Args = data[1:] 185 | return msg, nil 186 | } 187 | 188 | if msg.Type == MessageTypeClose || msg.Type == MessageTypePing || 189 | msg.Type == MessageTypePong || msg.Type == MessageTypeEmpty { 190 | return msg, nil 191 | } 192 | 193 | ack, rest, err := getAck(data) 194 | msg.AckId = ack 195 | if msg.Type == MessageTypeAckResponse { 196 | if err != nil { 197 | return nil, err 198 | } 199 | msg.Args = rest[1 : len(rest)-1] 200 | return msg, nil 201 | } 202 | 203 | if err != nil { 204 | msg.Type = MessageTypeEmit 205 | rest = data[2:] 206 | } 207 | 208 | msg.Method, msg.Args, err = getMethod(rest) 209 | if err != nil { 210 | return nil, err 211 | } 212 | 213 | return msg, nil 214 | } 215 | -------------------------------------------------------------------------------- /send.go: -------------------------------------------------------------------------------- 1 | package gosocketio 2 | 3 | import ( 4 | "encoding/json" 5 | "errors" 6 | "github.com/graarh/golang-socketio/protocol" 7 | "log" 8 | "time" 9 | ) 10 | 11 | var ( 12 | ErrorSendTimeout = errors.New("Timeout") 13 | ErrorSocketOverflood = errors.New("Socket overflood") 14 | ) 15 | 16 | /** 17 | Send message packet to socket 18 | */ 19 | func send(msg *protocol.Message, c *Channel, args interface{}) error { 20 | //preventing json/encoding "index out of range" panic 21 | defer func() { 22 | if r := recover(); r != nil { 23 | log.Println("socket.io send panic: ", r) 24 | } 25 | }() 26 | 27 | if args != nil { 28 | json, err := json.Marshal(&args) 29 | if err != nil { 30 | return err 31 | } 32 | 33 | msg.Args = string(json) 34 | } 35 | 36 | command, err := protocol.Encode(msg) 37 | if err != nil { 38 | return err 39 | } 40 | 41 | if len(c.out) == queueBufferSize { 42 | return ErrorSocketOverflood 43 | } 44 | 45 | c.out <- command 46 | 47 | return nil 48 | } 49 | 50 | /** 51 | Create packet based on given data and send it 52 | */ 53 | func (c *Channel) Emit(method string, args interface{}) error { 54 | msg := &protocol.Message{ 55 | Type: protocol.MessageTypeEmit, 56 | Method: method, 57 | } 58 | 59 | return send(msg, c, args) 60 | } 61 | 62 | /** 63 | Create ack packet based on given data and send it and receive response 64 | */ 65 | func (c *Channel) Ack(method string, args interface{}, timeout time.Duration) (string, error) { 66 | msg := &protocol.Message{ 67 | Type: protocol.MessageTypeAckRequest, 68 | AckId: c.ack.getNextId(), 69 | Method: method, 70 | } 71 | 72 | waiter := make(chan string) 73 | c.ack.addWaiter(msg.AckId, waiter) 74 | 75 | err := send(msg, c, args) 76 | if err != nil { 77 | c.ack.removeWaiter(msg.AckId) 78 | } 79 | 80 | select { 81 | case result := <-waiter: 82 | return result, nil 83 | case <-time.After(timeout): 84 | c.ack.removeWaiter(msg.AckId) 85 | return "", ErrorSendTimeout 86 | } 87 | } 88 | -------------------------------------------------------------------------------- /server.go: -------------------------------------------------------------------------------- 1 | package gosocketio 2 | 3 | import ( 4 | "bytes" 5 | "crypto/md5" 6 | "encoding/base64" 7 | "encoding/json" 8 | "errors" 9 | "fmt" 10 | "github.com/graarh/golang-socketio/protocol" 11 | "github.com/graarh/golang-socketio/transport" 12 | "math/rand" 13 | "net/http" 14 | "sync" 15 | "time" 16 | ) 17 | 18 | const ( 19 | HeaderForward = "X-Forwarded-For" 20 | ) 21 | 22 | var ( 23 | ErrorServerNotSet = errors.New("Server not set") 24 | ErrorConnectionNotFound = errors.New("Connection not found") 25 | ) 26 | 27 | /** 28 | socket.io server instance 29 | */ 30 | type Server struct { 31 | methods 32 | http.Handler 33 | 34 | channels map[string]map[*Channel]struct{} 35 | rooms map[*Channel]map[string]struct{} 36 | channelsLock sync.RWMutex 37 | 38 | sids map[string]*Channel 39 | sidsLock sync.RWMutex 40 | 41 | tr transport.Transport 42 | } 43 | 44 | /** 45 | Close current channel 46 | */ 47 | func (c *Channel) Close() { 48 | if c.server != nil { 49 | closeChannel(c, &c.server.methods) 50 | } 51 | } 52 | 53 | /** 54 | Get ip of socket client 55 | */ 56 | func (c *Channel) Ip() string { 57 | forward := c.RequestHeader().Get(HeaderForward) 58 | if forward != "" { 59 | return forward 60 | } 61 | return c.ip 62 | } 63 | 64 | /** 65 | Get request header of this connection 66 | */ 67 | func (c *Channel) RequestHeader() http.Header { 68 | return c.requestHeader 69 | } 70 | 71 | /** 72 | Get channel by it's sid 73 | */ 74 | func (s *Server) GetChannel(sid string) (*Channel, error) { 75 | s.sidsLock.RLock() 76 | defer s.sidsLock.RUnlock() 77 | 78 | c, ok := s.sids[sid] 79 | if !ok { 80 | return nil, ErrorConnectionNotFound 81 | } 82 | 83 | return c, nil 84 | } 85 | 86 | /** 87 | Join this channel to given room 88 | */ 89 | func (c *Channel) Join(room string) error { 90 | if c.server == nil { 91 | return ErrorServerNotSet 92 | } 93 | 94 | c.server.channelsLock.Lock() 95 | defer c.server.channelsLock.Unlock() 96 | 97 | cn := c.server.channels 98 | if _, ok := cn[room]; !ok { 99 | cn[room] = make(map[*Channel]struct{}) 100 | } 101 | 102 | byRoom := c.server.rooms 103 | if _, ok := byRoom[c]; !ok { 104 | byRoom[c] = make(map[string]struct{}) 105 | } 106 | 107 | cn[room][c] = struct{}{} 108 | byRoom[c][room] = struct{}{} 109 | 110 | return nil 111 | } 112 | 113 | /** 114 | Remove this channel from given room 115 | */ 116 | func (c *Channel) Leave(room string) error { 117 | if c.server == nil { 118 | return ErrorServerNotSet 119 | } 120 | 121 | c.server.channelsLock.Lock() 122 | defer c.server.channelsLock.Unlock() 123 | 124 | cn := c.server.channels 125 | if _, ok := cn[room]; ok { 126 | delete(cn[room], c) 127 | if len(cn[room]) == 0 { 128 | delete(cn, room) 129 | } 130 | } 131 | 132 | byRoom := c.server.rooms 133 | if _, ok := byRoom[c]; ok { 134 | delete(byRoom[c], room) 135 | } 136 | 137 | return nil 138 | } 139 | 140 | /** 141 | Get amount of channels, joined to given room, using channel 142 | */ 143 | func (c *Channel) Amount(room string) int { 144 | if c.server == nil { 145 | return 0 146 | } 147 | 148 | return c.server.Amount(room) 149 | } 150 | 151 | /** 152 | Get amount of channels, joined to given room, using server 153 | */ 154 | func (s *Server) Amount(room string) int { 155 | s.channelsLock.RLock() 156 | defer s.channelsLock.RUnlock() 157 | 158 | roomChannels, _ := s.channels[room] 159 | return len(roomChannels) 160 | } 161 | 162 | /** 163 | Get list of channels, joined to given room, using channel 164 | */ 165 | func (c *Channel) List(room string) []*Channel { 166 | if c.server == nil { 167 | return []*Channel{} 168 | } 169 | 170 | return c.server.List(room) 171 | } 172 | 173 | /** 174 | Get list of channels, joined to given room, using server 175 | */ 176 | func (s *Server) List(room string) []*Channel { 177 | s.channelsLock.RLock() 178 | defer s.channelsLock.RUnlock() 179 | 180 | roomChannels, ok := s.channels[room] 181 | if !ok { 182 | return []*Channel{} 183 | } 184 | 185 | i := 0 186 | roomChannelsCopy := make([]*Channel, len(roomChannels)) 187 | for channel := range roomChannels { 188 | roomChannelsCopy[i] = channel 189 | i++ 190 | } 191 | 192 | return roomChannelsCopy 193 | 194 | } 195 | 196 | func (c *Channel) BroadcastTo(room, method string, args interface{}) { 197 | if c.server == nil { 198 | return 199 | } 200 | c.server.BroadcastTo(room, method, args) 201 | } 202 | 203 | /** 204 | Broadcast message to all room channels 205 | */ 206 | func (s *Server) BroadcastTo(room, method string, args interface{}) { 207 | s.channelsLock.RLock() 208 | defer s.channelsLock.RUnlock() 209 | 210 | roomChannels, ok := s.channels[room] 211 | if !ok { 212 | return 213 | } 214 | 215 | for cn := range roomChannels { 216 | if cn.IsAlive() { 217 | go cn.Emit(method, args) 218 | } 219 | } 220 | } 221 | 222 | /** 223 | Broadcast to all clients 224 | */ 225 | func (s *Server) BroadcastToAll(method string, args interface{}) { 226 | s.sidsLock.RLock() 227 | defer s.sidsLock.RUnlock() 228 | 229 | for _, cn := range s.sids { 230 | if cn.IsAlive() { 231 | go cn.Emit(method, args) 232 | } 233 | } 234 | } 235 | 236 | /** 237 | Generate new id for socket.io connection 238 | */ 239 | func generateNewId(custom string) string { 240 | hash := fmt.Sprintf("%s %s %n %n", custom, time.Now(), rand.Uint32(), rand.Uint32()) 241 | buf := bytes.NewBuffer(nil) 242 | sum := md5.Sum([]byte(hash)) 243 | encoder := base64.NewEncoder(base64.URLEncoding, buf) 244 | encoder.Write(sum[:]) 245 | encoder.Close() 246 | return buf.String()[:20] 247 | } 248 | 249 | /** 250 | On connection system handler, store sid 251 | */ 252 | func onConnectStore(c *Channel) { 253 | c.server.sidsLock.Lock() 254 | defer c.server.sidsLock.Unlock() 255 | 256 | c.server.sids[c.Id()] = c 257 | } 258 | 259 | /** 260 | On disconnection system handler, clean joins and sid 261 | */ 262 | func onDisconnectCleanup(c *Channel) { 263 | c.server.channelsLock.Lock() 264 | defer c.server.channelsLock.Unlock() 265 | 266 | cn := c.server.channels 267 | byRoom, ok := c.server.rooms[c] 268 | if ok { 269 | for room := range byRoom { 270 | if curRoom, ok := cn[room]; ok { 271 | delete(curRoom, c) 272 | if len(curRoom) == 0 { 273 | delete(cn, room) 274 | } 275 | } 276 | } 277 | 278 | delete(c.server.rooms, c) 279 | } 280 | 281 | c.server.sidsLock.Lock() 282 | defer c.server.sidsLock.Unlock() 283 | 284 | delete(c.server.sids, c.Id()) 285 | } 286 | 287 | func (s *Server) SendOpenSequence(c *Channel) { 288 | jsonHdr, err := json.Marshal(&c.header) 289 | if err != nil { 290 | panic(err) 291 | } 292 | 293 | c.out <- protocol.MustEncode( 294 | &protocol.Message{ 295 | Type: protocol.MessageTypeOpen, 296 | Args: string(jsonHdr), 297 | }, 298 | ) 299 | 300 | c.out <- protocol.MustEncode(&protocol.Message{Type: protocol.MessageTypeEmpty}) 301 | } 302 | 303 | /** 304 | Setup event loop for given connection 305 | */ 306 | func (s *Server) SetupEventLoop(conn transport.Connection, remoteAddr string, 307 | requestHeader http.Header) { 308 | 309 | interval, timeout := conn.PingParams() 310 | hdr := Header{ 311 | Sid: generateNewId(remoteAddr), 312 | Upgrades: []string{}, 313 | PingInterval: int(interval / time.Millisecond), 314 | PingTimeout: int(timeout / time.Millisecond), 315 | } 316 | 317 | c := &Channel{} 318 | c.conn = conn 319 | c.ip = remoteAddr 320 | c.requestHeader = requestHeader 321 | c.initChannel() 322 | 323 | c.server = s 324 | c.header = hdr 325 | 326 | s.SendOpenSequence(c) 327 | 328 | go inLoop(c, &s.methods) 329 | go outLoop(c, &s.methods) 330 | 331 | s.callLoopEvent(c, OnConnection) 332 | } 333 | 334 | /** 335 | implements ServeHTTP function from http.Handler 336 | */ 337 | func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request) { 338 | conn, err := s.tr.HandleConnection(w, r) 339 | if err != nil { 340 | return 341 | } 342 | 343 | s.SetupEventLoop(conn, r.RemoteAddr, r.Header) 344 | s.tr.Serve(w, r) 345 | } 346 | 347 | /** 348 | Get amount of current connected sids 349 | */ 350 | func (s *Server) AmountOfSids() int64 { 351 | s.sidsLock.RLock() 352 | defer s.sidsLock.RUnlock() 353 | 354 | return int64(len(s.sids)) 355 | } 356 | 357 | /** 358 | Get amount of rooms with at least one channel(or sid) joined 359 | */ 360 | func (s *Server) AmountOfRooms() int64 { 361 | s.channelsLock.RLock() 362 | defer s.channelsLock.RUnlock() 363 | 364 | return int64(len(s.channels)) 365 | } 366 | 367 | /** 368 | Create new socket.io server 369 | */ 370 | func NewServer(tr transport.Transport) *Server { 371 | s := Server{} 372 | s.initMethods() 373 | s.tr = tr 374 | s.channels = make(map[string]map[*Channel]struct{}) 375 | s.rooms = make(map[*Channel]map[string]struct{}) 376 | s.sids = make(map[string]*Channel) 377 | s.onConnection = onConnectStore 378 | s.onDisconnection = onDisconnectCleanup 379 | 380 | return &s 381 | } 382 | -------------------------------------------------------------------------------- /transport/transport.go: -------------------------------------------------------------------------------- 1 | package transport 2 | 3 | import ( 4 | "net/http" 5 | "time" 6 | ) 7 | 8 | /** 9 | End-point connection for given transport 10 | */ 11 | type Connection interface { 12 | /** 13 | Receive one more message, block until received 14 | */ 15 | GetMessage() (message string, err error) 16 | 17 | /** 18 | Send given message, block until sent 19 | */ 20 | WriteMessage(message string) error 21 | 22 | /** 23 | Close current connection 24 | */ 25 | Close() 26 | 27 | /** 28 | Get ping time interval and ping request timeout 29 | */ 30 | PingParams() (interval, timeout time.Duration) 31 | } 32 | 33 | /** 34 | Connection factory for given transport 35 | */ 36 | type Transport interface { 37 | /** 38 | Get client connection 39 | */ 40 | Connect(url string) (conn Connection, err error) 41 | 42 | /** 43 | Handle one server connection 44 | */ 45 | HandleConnection(w http.ResponseWriter, r *http.Request) (conn Connection, err error) 46 | 47 | /** 48 | Serve HTTP request after making connection and events setup 49 | */ 50 | Serve(w http.ResponseWriter, r *http.Request) 51 | } 52 | -------------------------------------------------------------------------------- /transport/websocket.go: -------------------------------------------------------------------------------- 1 | package transport 2 | 3 | import ( 4 | "errors" 5 | "github.com/gorilla/websocket" 6 | "io/ioutil" 7 | "net/http" 8 | "time" 9 | ) 10 | 11 | const ( 12 | upgradeFailed = "Upgrade failed: " 13 | 14 | WsDefaultPingInterval = 30 * time.Second 15 | WsDefaultPingTimeout = 60 * time.Second 16 | WsDefaultReceiveTimeout = 60 * time.Second 17 | WsDefaultSendTimeout = 60 * time.Second 18 | WsDefaultBufferSize = 1024 * 32 19 | ) 20 | 21 | var ( 22 | ErrorBinaryMessage = errors.New("Binary messages are not supported") 23 | ErrorBadBuffer = errors.New("Buffer error") 24 | ErrorPacketWrong = errors.New("Wrong packet type error") 25 | ErrorMethodNotAllowed = errors.New("Method not allowed") 26 | ErrorHttpUpgradeFailed = errors.New("Http upgrade failed") 27 | ) 28 | 29 | type WebsocketConnection struct { 30 | socket *websocket.Conn 31 | transport *WebsocketTransport 32 | } 33 | 34 | func (wsc *WebsocketConnection) GetMessage() (message string, err error) { 35 | wsc.socket.SetReadDeadline(time.Now().Add(wsc.transport.ReceiveTimeout)) 36 | msgType, reader, err := wsc.socket.NextReader() 37 | if err != nil { 38 | return "", err 39 | } 40 | 41 | //support only text messages exchange 42 | if msgType != websocket.TextMessage { 43 | return "", ErrorBinaryMessage 44 | } 45 | 46 | data, err := ioutil.ReadAll(reader) 47 | if err != nil { 48 | return "", ErrorBadBuffer 49 | } 50 | text := string(data) 51 | 52 | //empty messages are not allowed 53 | if len(text) == 0 { 54 | return "", ErrorPacketWrong 55 | } 56 | 57 | return text, nil 58 | } 59 | 60 | func (wsc *WebsocketConnection) WriteMessage(message string) error { 61 | wsc.socket.SetWriteDeadline(time.Now().Add(wsc.transport.SendTimeout)) 62 | writer, err := wsc.socket.NextWriter(websocket.TextMessage) 63 | if err != nil { 64 | return err 65 | } 66 | 67 | if _, err := writer.Write([]byte(message)); err != nil { 68 | return err 69 | } 70 | if err := writer.Close(); err != nil { 71 | return err 72 | } 73 | return nil 74 | } 75 | 76 | func (wsc *WebsocketConnection) Close() { 77 | wsc.socket.Close() 78 | } 79 | 80 | func (wsc *WebsocketConnection) PingParams() (interval, timeout time.Duration) { 81 | return wsc.transport.PingInterval, wsc.transport.PingTimeout 82 | } 83 | 84 | type WebsocketTransport struct { 85 | PingInterval time.Duration 86 | PingTimeout time.Duration 87 | ReceiveTimeout time.Duration 88 | SendTimeout time.Duration 89 | 90 | BufferSize int 91 | 92 | RequestHeader http.Header 93 | } 94 | 95 | func (wst *WebsocketTransport) Connect(url string) (conn Connection, err error) { 96 | dialer := websocket.Dialer{} 97 | socket, _, err := dialer.Dial(url, wst.RequestHeader) 98 | if err != nil { 99 | return nil, err 100 | } 101 | 102 | return &WebsocketConnection{socket, wst}, nil 103 | } 104 | 105 | func (wst *WebsocketTransport) HandleConnection( 106 | w http.ResponseWriter, r *http.Request) (conn Connection, err error) { 107 | 108 | if r.Method != "GET" { 109 | http.Error(w, upgradeFailed+ErrorMethodNotAllowed.Error(), 503) 110 | return nil, ErrorMethodNotAllowed 111 | } 112 | 113 | socket, err := websocket.Upgrade(w, r, nil, wst.BufferSize, wst.BufferSize) 114 | if err != nil { 115 | http.Error(w, upgradeFailed+err.Error(), 503) 116 | return nil, ErrorHttpUpgradeFailed 117 | } 118 | 119 | return &WebsocketConnection{socket, wst}, nil 120 | } 121 | 122 | /** 123 | Websocket connection do not require any additional processing 124 | */ 125 | func (wst *WebsocketTransport) Serve(w http.ResponseWriter, r *http.Request) {} 126 | 127 | /** 128 | Returns websocket connection with default params 129 | */ 130 | func GetDefaultWebsocketTransport() *WebsocketTransport { 131 | return &WebsocketTransport{ 132 | PingInterval: WsDefaultPingInterval, 133 | PingTimeout: WsDefaultPingTimeout, 134 | ReceiveTimeout: WsDefaultReceiveTimeout, 135 | SendTimeout: WsDefaultSendTimeout, 136 | BufferSize: WsDefaultBufferSize, 137 | } 138 | } 139 | --------------------------------------------------------------------------------