├── .gitignore
├── COPYING
├── LICENSE
├── Makefile
├── README.md
├── easywsclient.cpp
├── easywsclient.hpp
├── example-client-cpp11.cpp
├── example-client.cpp
├── example-server.js
└── test
├── Makefile
├── easywsclient.t.cpp
├── gtest.mk
└── testServer.js
/.gitignore:
--------------------------------------------------------------------------------
1 | # Prerequisites
2 | *.d
3 |
4 | # Compiled Object files
5 | *.slo
6 | *.lo
7 | *.o
8 | *.obj
9 |
10 |
11 | # Precompiled Headers
12 | *.gch
13 | *.pch
14 |
15 | # Compiled Dynamic libraries
16 | *.so
17 | *.dylib
18 | *.dll
19 |
20 | # Fortran module files
21 | *.mod
22 | *.smod
23 |
24 | # Compiled Static libraries
25 | *.lai
26 | *.la
27 | *.a
28 | *.lib
29 |
30 | # Executables
31 | *.exe
32 | *.out
33 | *.app
34 |
--------------------------------------------------------------------------------
/COPYING:
--------------------------------------------------------------------------------
1 | The MIT License (MIT)
2 |
3 | Copyright (c) 2016, 2017 <1066012643@qq.com>
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in
13 | all copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21 | THE SOFTWARE.
22 |
--------------------------------------------------------------------------------
/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 |
635 | Copyright (C)
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 | Copyright (C)
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 |
--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
1 | CXXFLAGS = -std=gnu++0x -Wall
2 | LDLIBS = -lstdc++
3 | .PHONY: all clean test
4 | all: example-client example-client-cpp11
5 | clean:
6 | -rm example-client example-client-cpp11 *.o
7 | cd test; $(MAKE) clean
8 | test:
9 | cd test; $(MAKE) test
10 | testserver: node_modules
11 | node example-server.js
12 | node_modules:
13 | npm install
14 | example-client-cpp11: example-client-cpp11.o easywsclient.o
15 | example-client-cpp11.o: example-client-cpp11.cpp easywsclient.hpp
16 | example-client: example-client.o easywsclient.o
17 | example-client.o: example-client.cpp easywsclient.hpp
18 | easywsclient.o: easywsclient.cpp easywsclient.hpp
19 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | easywsclient 20191101
2 | ============
3 |
4 | Easywsclient is an easy and powerful WebSocket client to get your
5 | C++ code connected to a web stack right away. It depends only on the
6 | standard libraries. It is compatible with modern C++11 std::function and
7 | [lambda](http://en.wikipedia.org/wiki/Anonymous_function#C.2B.2B),
8 | if they're available (it's not required though). [RFC
9 | 6455](http://tools.ietf.org/html/rfc6455) Version 13 WebSocket is
10 | supported. Version 13 is compatible with all major, modern WebSocket
11 | implementations, including Node.js, and has been a standard since
12 | December 2011.
13 |
14 | Rationale: This library is intended to help a C++ project start using
15 | WebSocket rapidly. This small library can easily be thrown into an
16 | existing project. For complicated builds that you can't figure out right
17 | away, you can even cheat by piggy-backing the .cpp file into one of
18 | the project's existing files. Yes, WebSocket is that awesome enough to
19 | warrant getting it integrated into your project! This project imposes
20 | no special interface requirements, and can work happily with new C++11
21 | features or with older C++ projects.
22 |
23 | As an additional benefit, easywsclient is very simple, with just a single
24 | implementation file. It can serve as a cruft-free concise reference. You
25 | are most welcome to use this code as a reference for creating alternative
26 | implementations that may better suit your needs.
27 |
28 | News
29 | ====
30 |
31 | *2014-12-06*
32 | Binary frames now supported. Closes issue #38. Automated integration testing
33 | is now supported by running `make test`. The test suite expects GoogleTest to
34 | be installed at `/usr/src/gtest` (`apt-get install libgtest-dev` does the
35 | trick). The test suite uses C++14 (for lambda capture expressions), and thus it
36 | will not work on older compilers. Note that easywsclient itself still
37 | restricted to C++98/C++03, and will continue to build with older compilers.
38 |
39 |
40 |
41 | Usage
42 | =====
43 |
44 | The WebSocket class interface looks like this:
45 |
46 | ```c++
47 | // Factory method to create a WebSocket:
48 | static pointer from_url(std::string url);
49 | // Factory method to create a dummy WebSocket (all operations are noop):
50 | static pointer create_dummy();
51 |
52 | // Function to perform actual network send()/recv() I/O:
53 | // (note: if all you need is to recv()/dispatch() messages, then a
54 | // negative timeout can be used to block until a message arrives.
55 | // By default, when timeout is 0, poll() will not block at all.)
56 | void poll(int timeout = 0); // timeout in milliseconds
57 |
58 | // Receive a message, and pass it to callable(). Really, this just looks at
59 | // a buffer (filled up by poll()) and decodes any messages in the buffer.
60 | // Callable must have signature: void(const std::string & message).
61 | // Should work with C functions, C++ functors, and C++11 std::function and
62 | // lambda:
63 | template
64 | void dispatch(Callable callable);
65 |
66 | // Sends a TEXT type message (gets put into a buffer for poll() to send
67 | // later):
68 | void send(std::string message);
69 |
70 | // Close the WebSocket (send a CLOSE message over WebSocket, then close() the
71 | // actual socket when the send buffer becomes empty):
72 | void close();
73 | ```
74 |
75 | Put together, the usage looks like this:
76 |
77 | ```c++
78 | #include "easywsclient.hpp"
79 | //#include "easywsclient.cpp" // <-- include only if you don't want compile separately
80 |
81 | int
82 | main()
83 | {
84 | ...
85 | using easywsclient::WebSocket;
86 | WebSocket::pointer ws = WebSocket::from_url("ws://localhost:8126/foo");
87 | assert(ws);
88 | while (true) {
89 | ws->poll();
90 | ws->send("hello");
91 | ws->dispatch(handle_message);
92 | // ...do more stuff...
93 | }
94 | ...
95 | delete ws; // alternatively, use unique_ptr<> if you have C++11
96 | return 0;
97 | }
98 | ```
99 |
100 |
101 |
102 |
103 |
104 | //线程thread 维护重连连接 open a thread to maintain connect statute
105 | void run()
106 | {
107 | bool conn = FLASE;
108 | ws = WebSocket::from_url("ws://localhost:8126/foo");
109 |
110 | //如果你需要多线程,可以在一个thread 维护该ws的连接重连机制
111 | while (1) //判断ws是否正常连接
112 | {
113 | if(ws != NULL)
114 | {
115 | ws->poll(0);//这个必须要调用,否则不能发送,发送跟接收都是异步的,都是在这个poll函数里监测处 理的
116 | ws->dispatch(handle_message);
117 | if(ws->getReadyState() == WebSocket::CLOSED)
118 | {
119 | //ws连接断开 重连
120 | delete ws;
121 | ws = NULL;
122 | ws = WebSocket::from_url("ws://localhost:8126/foo");
123 | }
124 | else if(wss->getReadyState()== WebSocket::OPEN)
125 | {
126 | //ws连接ok
127 | // ws->send("goodbye");
128 | ws->send("hello");
129 | }
130 |
131 | }
132 | else
133 | {
134 | ws = WebSocket::from_url("ws://localhost:8126/foo");
135 | sleep(1);
136 | }
137 | usleep(100);
138 | }
139 | if(ws!=NULL)
140 | delete ws;
141 | }
142 |
143 |
144 | Example
145 | =======
146 |
147 | # Launch a test server:
148 | node example-server.js
149 |
150 | # Build and launch the client:
151 | g++ -c easywsclient.cpp -o easywsclient.o
152 | g++ -c example-client.cpp -o example-client.o
153 | g++ example-client.o easywsclient.o -o example-client
154 | ./example-client
155 |
156 | # ...or build and launch a C++11 client:
157 | g++ -std=gnu++0x -c easywsclient.cpp -o easywsclient.o
158 | g++ -std=gnu++0x -c example-client-cpp11.cpp -o example-client-cpp11.o
159 | g++ example-client-cpp11.o easywsclient.o -o example-client-cpp11
160 | ./example-client-cpp11
161 |
162 | # Expect the output from example-client:
163 | Connected to: ws://localhost:8126/foo
164 | >>> galaxy
165 | >>> world
166 |
167 | Threading
168 | =========
169 |
170 | This library is not thread safe. The user must take care to use locks if
171 | accessing an instance of `WebSocket` from multiple threads. If you need
172 | a quick threading library and don't have Boost or something else already,
173 | I recommend [TinyThread++](http://tinythreadpp.bitsnbites.eu/).
174 |
175 | Future Work
176 | ===========
177 |
178 | (contributions appreciated!)
179 |
180 | * Parameterize the `pointer` type (especially for `shared_ptr`).
181 | * Support optional integration on top of an async (event-driven) library,
182 | especially Asio.
183 |
--------------------------------------------------------------------------------
/easywsclient.cpp:
--------------------------------------------------------------------------------
1 |
2 | #ifdef _WIN32
3 | #if defined(_MSC_VER) && !defined(_CRT_SECURE_NO_WARNINGS)
4 | #define _CRT_SECURE_NO_WARNINGS // _CRT_SECURE_NO_WARNINGS for sscanf errors in MSVC2013 Express
5 | #endif
6 | #ifndef WIN32_LEAN_AND_MEAN
7 | #define WIN32_LEAN_AND_MEAN
8 | #endif
9 | #include
10 | #include
11 | #include
12 | #pragma comment( lib, "ws2_32" )
13 | #include
14 | #include
15 | #include
16 | #include
17 | #include
18 | #ifndef _SSIZE_T_DEFINED
19 | typedef int ssize_t;
20 | #define _SSIZE_T_DEFINED
21 | #endif
22 | #ifndef _SOCKET_T_DEFINED
23 | typedef SOCKET socket_t;
24 | #define _SOCKET_T_DEFINED
25 | #endif
26 | #ifndef snprintf
27 | #define snprintf _snprintf_s
28 | #endif
29 | #if _MSC_VER >=1600
30 | // vs2010 or later
31 | #include
32 | #else
33 | typedef __int8 int8_t;
34 | typedef unsigned __int8 uint8_t;
35 | typedef __int32 int32_t;
36 | typedef unsigned __int32 uint32_t;
37 | typedef __int64 int64_t;
38 | typedef unsigned __int64 uint64_t;
39 | #endif
40 | #define socketerrno WSAGetLastError()
41 | #define SOCKET_EAGAIN_EINPROGRESS WSAEINPROGRESS
42 | #define SOCKET_EWOULDBLOCK WSAEWOULDBLOCK
43 | #else
44 | #include
45 | #include
46 | #include
47 | #include
48 | #include
49 | #include
50 | #include
51 | #include
52 | #include
53 | #include
54 | #include
55 | #ifndef _SOCKET_T_DEFINED
56 | typedef int socket_t;
57 | #define _SOCKET_T_DEFINED
58 | #endif
59 | #ifndef INVALID_SOCKET
60 | #define INVALID_SOCKET (-1)
61 | #endif
62 | #ifndef SOCKET_ERROR
63 | #define SOCKET_ERROR (-1)
64 | #endif
65 | #define closesocket(s) ::close(s)
66 | #include
67 | #define socketerrno errno
68 | #define SOCKET_EAGAIN_EINPROGRESS EAGAIN
69 | #define SOCKET_EWOULDBLOCK EWOULDBLOCK
70 | #endif
71 |
72 | #include
73 | #include
74 |
75 | #include "easywsclient.hpp"
76 |
77 | using easywsclient::Callback_Imp;
78 | using easywsclient::BytesCallback_Imp;
79 |
80 | namespace { // private module-only namespace
81 |
82 | socket_t hostname_connect(const std::string& hostname, int port) {
83 | struct addrinfo hints;
84 | struct addrinfo *result;
85 | struct addrinfo *p;
86 | int ret;
87 | socket_t sockfd = INVALID_SOCKET;
88 | char sport[16];
89 | memset(&hints, 0, sizeof(hints));
90 | hints.ai_family = AF_UNSPEC;
91 | hints.ai_socktype = SOCK_STREAM;
92 | snprintf(sport, 16, "%d", port);
93 | if ((ret = getaddrinfo(hostname.c_str(), sport, &hints, &result)) != 0)
94 | {
95 | fprintf(stderr, "getaddrinfo: %s\n", gai_strerror(ret));
96 | return 1;
97 | }
98 | for(p = result; p != NULL; p = p->ai_next)
99 | {
100 | sockfd = socket(p->ai_family, p->ai_socktype, p->ai_protocol);
101 | if (sockfd == INVALID_SOCKET) { continue; }
102 | if (connect(sockfd, p->ai_addr, p->ai_addrlen) != SOCKET_ERROR) {
103 | break;
104 | }
105 | closesocket(sockfd);
106 | sockfd = INVALID_SOCKET;
107 | }
108 | freeaddrinfo(result);
109 | return sockfd;
110 | }
111 |
112 |
113 | class _DummyWebSocket : public easywsclient::WebSocket
114 | {
115 | public:
116 | void poll(int timeout) { }
117 | void send(const std::string& message) { }
118 | void sendBinary(const std::string& message) { }
119 | void sendBinary(const std::vector& message) { }
120 | void sendPing() { }
121 | void close() { }
122 | readyStateValues getReadyState() const { return CLOSED; }
123 | void _dispatch(Callback_Imp & callable) { }
124 | void _dispatchBinary(BytesCallback_Imp& callable) { }
125 | };
126 |
127 |
128 | class _RealWebSocket : public easywsclient::WebSocket
129 | {
130 | public:
131 | // http://tools.ietf.org/html/rfc6455#section-5.2 Base Framing Protocol
132 | //
133 | // 0 1 2 3
134 | // 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
135 | // +-+-+-+-+-------+-+-------------+-------------------------------+
136 | // |F|R|R|R| opcode|M| Payload len | Extended payload length |
137 | // |I|S|S|S| (4) |A| (7) | (16/64) |
138 | // |N|V|V|V| |S| | (if payload len==126/127) |
139 | // | |1|2|3| |K| | |
140 | // +-+-+-+-+-------+-+-------------+ - - - - - - - - - - - - - - - +
141 | // | Extended payload length continued, if payload len == 127 |
142 | // + - - - - - - - - - - - - - - - +-------------------------------+
143 | // | |Masking-key, if MASK set to 1 |
144 | // +-------------------------------+-------------------------------+
145 | // | Masking-key (continued) | Payload Data |
146 | // +-------------------------------- - - - - - - - - - - - - - - - +
147 | // : Payload Data continued ... :
148 | // + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
149 | // | Payload Data continued ... |
150 | // +---------------------------------------------------------------+
151 | struct wsheader_type {
152 | unsigned header_size;
153 | bool fin;
154 | bool mask;
155 | enum opcode_type {
156 | CONTINUATION = 0x0,
157 | TEXT_FRAME = 0x1,
158 | BINARY_FRAME = 0x2,
159 | CLOSE = 8,
160 | PING = 9,
161 | PONG = 0xa,
162 | } opcode;
163 | int N0;
164 | uint64_t N;
165 | uint8_t masking_key[4];
166 | };
167 |
168 | std::vector rxbuf;
169 | std::vector txbuf;
170 | std::vector receivedData;
171 |
172 | socket_t sockfd;
173 | readyStateValues readyState;
174 | bool useMask;
175 |
176 | _RealWebSocket(socket_t sockfd, bool useMask) : sockfd(sockfd), readyState(OPEN), useMask(useMask) {
177 | }
178 |
179 | readyStateValues getReadyState() const {
180 | return readyState;
181 | }
182 |
183 | void poll(int timeout) { // timeout in milliseconds
184 | if (readyState == CLOSED) {
185 | if (timeout > 0) {
186 | timeval tv = { timeout/1000, (timeout%1000) * 1000 };
187 | select(0, NULL, NULL, NULL, &tv);
188 | }
189 | return;
190 | }
191 | if (timeout != 0) {
192 | fd_set rfds;
193 | fd_set wfds;
194 | timeval tv = { timeout/1000, (timeout%1000) * 1000 };
195 | FD_ZERO(&rfds);
196 | FD_ZERO(&wfds);
197 | FD_SET(sockfd, &rfds);
198 | if (txbuf.size()) { FD_SET(sockfd, &wfds); }
199 | select(sockfd + 1, &rfds, &wfds, 0, timeout > 0 ? &tv : 0);
200 | }
201 | while (true) {
202 | // FD_ISSET(0, &rfds) will be true
203 | int N = rxbuf.size();
204 | ssize_t ret;
205 | rxbuf.resize(N + 1500);
206 | ret = recv(sockfd, (char*)&rxbuf[0] + N, 1500, 0);
207 | if (false) { }
208 | else if (ret < 0 && (socketerrno == SOCKET_EWOULDBLOCK || socketerrno == SOCKET_EAGAIN_EINPROGRESS)) {
209 | rxbuf.resize(N);
210 | break;
211 | }
212 | else if (ret <= 0) {
213 | rxbuf.resize(N);
214 | closesocket(sockfd);
215 | readyState = CLOSED;
216 | fputs(ret < 0 ? "Connection error!\n" : "Connection closed!\n", stderr);
217 | break;
218 | }
219 | else {
220 | rxbuf.resize(N + ret);
221 | }
222 | }
223 | while (txbuf.size()) {
224 | int ret = ::send(sockfd, (char*)&txbuf[0], txbuf.size(), 0);
225 | if (false) { } // ??
226 | else if (ret < 0 && (socketerrno == SOCKET_EWOULDBLOCK || socketerrno == SOCKET_EAGAIN_EINPROGRESS)) {
227 | break;
228 | }
229 | else if (ret <= 0) {
230 | closesocket(sockfd);
231 | readyState = CLOSED;
232 | fputs(ret < 0 ? "Connection error!\n" : "Connection closed!\n", stderr);
233 | break;
234 | }
235 | else {
236 | txbuf.erase(txbuf.begin(), txbuf.begin() + ret);
237 | }
238 | }
239 | if (!txbuf.size() && readyState == CLOSING) {
240 | closesocket(sockfd);
241 | readyState = CLOSED;
242 | }
243 | }
244 |
245 | // Callable must have signature: void(const std::string & message).
246 | // Should work with C functions, C++ functors, and C++11 std::function and
247 | // lambda:
248 | //template
249 | //void dispatch(Callable callable)
250 | virtual void _dispatch(Callback_Imp & callable) {
251 | struct CallbackAdapter : public BytesCallback_Imp
252 | // Adapt void(const std::string&) to void(const std::string&)
253 | {
254 | Callback_Imp& callable;
255 | CallbackAdapter(Callback_Imp& callable) : callable(callable) { }
256 | void operator()(const std::vector& message) {
257 | std::string stringMessage(message.begin(), message.end());
258 | callable(stringMessage);
259 | }
260 | };
261 | CallbackAdapter bytesCallback(callable);
262 | _dispatchBinary(bytesCallback);
263 | }
264 |
265 | virtual void _dispatchBinary(BytesCallback_Imp & callable) {
266 | // TODO: consider acquiring a lock on rxbuf...
267 | while (true) {
268 | wsheader_type ws;
269 | if (rxbuf.size() < 2) { return; /* Need at least 2 */ }
270 | const uint8_t * data = (uint8_t *) &rxbuf[0]; // peek, but don't consume
271 | ws.fin = (data[0] & 0x80) == 0x80;
272 | ws.opcode = (wsheader_type::opcode_type) (data[0] & 0x0f);
273 | ws.mask = (data[1] & 0x80) == 0x80;
274 | ws.N0 = (data[1] & 0x7f);
275 | ws.header_size = 2 + (ws.N0 == 126? 2 : 0) + (ws.N0 == 127? 8 : 0) + (ws.mask? 4 : 0);
276 | if (rxbuf.size() < ws.header_size) { return; /* Need: ws.header_size - rxbuf.size() */ }
277 | int i = 0;
278 | if (ws.N0 < 126) {
279 | ws.N = ws.N0;
280 | i = 2;
281 | }
282 | else if (ws.N0 == 126) {
283 | ws.N = 0;
284 | ws.N |= ((uint64_t) data[2]) << 8;
285 | ws.N |= ((uint64_t) data[3]) << 0;
286 | i = 4;
287 | }
288 | else if (ws.N0 == 127) {
289 | ws.N = 0;
290 | ws.N |= ((uint64_t) data[2]) << 56;
291 | ws.N |= ((uint64_t) data[3]) << 48;
292 | ws.N |= ((uint64_t) data[4]) << 40;
293 | ws.N |= ((uint64_t) data[5]) << 32;
294 | ws.N |= ((uint64_t) data[6]) << 24;
295 | ws.N |= ((uint64_t) data[7]) << 16;
296 | ws.N |= ((uint64_t) data[8]) << 8;
297 | ws.N |= ((uint64_t) data[9]) << 0;
298 | i = 10;
299 | }
300 | if (ws.mask) {
301 | ws.masking_key[0] = ((uint8_t) data[i+0]) << 0;
302 | ws.masking_key[1] = ((uint8_t) data[i+1]) << 0;
303 | ws.masking_key[2] = ((uint8_t) data[i+2]) << 0;
304 | ws.masking_key[3] = ((uint8_t) data[i+3]) << 0;
305 | }
306 | else {
307 | ws.masking_key[0] = 0;
308 | ws.masking_key[1] = 0;
309 | ws.masking_key[2] = 0;
310 | ws.masking_key[3] = 0;
311 | }
312 | if (rxbuf.size() < ws.header_size+ws.N) { return; /* Need: ws.header_size+ws.N - rxbuf.size() */ }
313 |
314 | // We got a whole message, now do something with it:
315 | if (false) { }
316 | else if (
317 | ws.opcode == wsheader_type::TEXT_FRAME
318 | || ws.opcode == wsheader_type::BINARY_FRAME
319 | || ws.opcode == wsheader_type::CONTINUATION
320 | ) {
321 | if (ws.mask) { for (size_t i = 0; i != ws.N; ++i) { rxbuf[i+ws.header_size] ^= ws.masking_key[i&0x3]; } }
322 | receivedData.insert(receivedData.end(), rxbuf.begin()+ws.header_size, rxbuf.begin()+ws.header_size+(size_t)ws.N);// just feed
323 | if (ws.fin) {
324 | callable((const std::vector) receivedData);
325 | receivedData.erase(receivedData.begin(), receivedData.end());
326 | std::vector ().swap(receivedData);// free memory
327 | }
328 | }
329 | else if (ws.opcode == wsheader_type::PING) {
330 | if (ws.mask) { for (size_t i = 0; i != ws.N; ++i) { rxbuf[i+ws.header_size] ^= ws.masking_key[i&0x3]; } }
331 | std::string data(rxbuf.begin()+ws.header_size, rxbuf.begin()+ws.header_size+(size_t)ws.N);
332 | sendData(wsheader_type::PONG, data.size(), data.begin(), data.end());
333 | }
334 | else if (ws.opcode == wsheader_type::PONG) { }
335 | else if (ws.opcode == wsheader_type::CLOSE) { close(); }
336 | else { fprintf(stderr, "ERROR: Got unexpected WebSocket message.\n"); close(); }
337 |
338 | rxbuf.erase(rxbuf.begin(), rxbuf.begin() + ws.header_size+(size_t)ws.N);
339 | }
340 | }
341 |
342 | void sendPing() {
343 | std::string empty;
344 | sendData(wsheader_type::PING, empty.size(), empty.begin(), empty.end());
345 | }
346 |
347 | void send(const std::string& message) {
348 | sendData(wsheader_type::TEXT_FRAME, message.size(), message.begin(), message.end());
349 | }
350 |
351 | void sendBinary(const std::string& message) {
352 | sendData(wsheader_type::BINARY_FRAME, message.size(), message.begin(), message.end());
353 | }
354 |
355 | void sendBinary(const std::vector& message) {
356 | sendData(wsheader_type::BINARY_FRAME, message.size(), message.begin(), message.end());
357 | }
358 |
359 | template
360 | void sendData(wsheader_type::opcode_type type, uint64_t message_size, Iterator message_begin, Iterator message_end) {
361 | // TODO:
362 | // Masking key should (must) be derived from a high quality random
363 | // number generator, to mitigate attacks on non-WebSocket friendly
364 | // middleware:
365 | const uint8_t masking_key[4] = { 0x12, 0x34, 0x56, 0x78 };
366 | // TODO: consider acquiring a lock on txbuf...
367 | if (readyState == CLOSING || readyState == CLOSED) { return; }
368 | std::vector header;
369 | header.assign(2 + (message_size >= 126 ? 2 : 0) + (message_size >= 65536 ? 6 : 0) + (useMask ? 4 : 0), 0);
370 | header[0] = 0x80 | type;
371 | if (false) { }
372 | else if (message_size < 126) {
373 | header[1] = (message_size & 0xff) | (useMask ? 0x80 : 0);
374 | if (useMask) {
375 | header[2] = masking_key[0];
376 | header[3] = masking_key[1];
377 | header[4] = masking_key[2];
378 | header[5] = masking_key[3];
379 | }
380 | }
381 | else if (message_size < 65536) {
382 | header[1] = 126 | (useMask ? 0x80 : 0);
383 | header[2] = (message_size >> 8) & 0xff;
384 | header[3] = (message_size >> 0) & 0xff;
385 | if (useMask) {
386 | header[4] = masking_key[0];
387 | header[5] = masking_key[1];
388 | header[6] = masking_key[2];
389 | header[7] = masking_key[3];
390 | }
391 | }
392 | else { // TODO: run coverage testing here
393 | header[1] = 127 | (useMask ? 0x80 : 0);
394 | header[2] = (message_size >> 56) & 0xff;
395 | header[3] = (message_size >> 48) & 0xff;
396 | header[4] = (message_size >> 40) & 0xff;
397 | header[5] = (message_size >> 32) & 0xff;
398 | header[6] = (message_size >> 24) & 0xff;
399 | header[7] = (message_size >> 16) & 0xff;
400 | header[8] = (message_size >> 8) & 0xff;
401 | header[9] = (message_size >> 0) & 0xff;
402 | if (useMask) {
403 | header[10] = masking_key[0];
404 | header[11] = masking_key[1];
405 | header[12] = masking_key[2];
406 | header[13] = masking_key[3];
407 | }
408 | }
409 | // N.B. - txbuf will keep growing until it can be transmitted over the socket:
410 | txbuf.insert(txbuf.end(), header.begin(), header.end());
411 | txbuf.insert(txbuf.end(), message_begin, message_end);
412 | if (useMask) {
413 | for (size_t i = 0; i != message_size; ++i) { *(txbuf.end() - message_size + i) ^= masking_key[i&0x3]; }
414 | }
415 | }
416 |
417 | void close() {
418 | if(readyState == CLOSING || readyState == CLOSED) { return; }
419 | readyState = CLOSING;
420 | uint8_t closeFrame[6] = {0x88, 0x80, 0x00, 0x00, 0x00, 0x00}; // last 4 bytes are a masking key
421 | std::vector header(closeFrame, closeFrame+6);
422 | txbuf.insert(txbuf.end(), header.begin(), header.end());
423 | }
424 |
425 | };
426 |
427 |
428 | easywsclient::WebSocket::pointer from_url(const std::string& url, bool useMask, const std::string& origin) {
429 | char host[128];
430 | int port;
431 | char path[128];
432 | if (url.size() >= 128) {
433 | fprintf(stderr, "ERROR: url size limit exceeded: %s\n", url.c_str());
434 | return NULL;
435 | }
436 | if (origin.size() >= 200) {
437 | fprintf(stderr, "ERROR: origin size limit exceeded: %s\n", origin.c_str());
438 | return NULL;
439 | }
440 | if (false) { }
441 | else if (sscanf(url.c_str(), "ws://%[^:/]:%d/%s", host, &port, path) == 3) {
442 | }
443 | else if (sscanf(url.c_str(), "ws://%[^:/]/%s", host, path) == 2) {
444 | port = 80;
445 | }
446 | else if (sscanf(url.c_str(), "ws://%[^:/]:%d", host, &port) == 2) {
447 | path[0] = '\0';
448 | }
449 | else if (sscanf(url.c_str(), "ws://%[^:/]", host) == 1) {
450 | port = 80;
451 | path[0] = '\0';
452 | }
453 | else {
454 | fprintf(stderr, "ERROR: Could not parse WebSocket url: %s\n", url.c_str());
455 | return NULL;
456 | }
457 | fprintf(stderr, "easywsclient: connecting: host=%s port=%d path=/%s\n", host, port, path);
458 | socket_t sockfd = hostname_connect(host, port);
459 | if (sockfd == INVALID_SOCKET) {
460 | fprintf(stderr, "Unable to connect to %s:%d\n", host, port);
461 | return NULL;
462 | }
463 | {
464 | // XXX: this should be done non-blocking,
465 | char line[256];
466 | int status;
467 | int i;
468 | snprintf(line, 256, "GET /%s HTTP/1.1\r\n", path); ::send(sockfd, line, strlen(line), 0);
469 | if (port == 80) {
470 | snprintf(line, 256, "Host: %s\r\n", host); ::send(sockfd, line, strlen(line), 0);
471 | }
472 | else {
473 | snprintf(line, 256, "Host: %s:%d\r\n", host, port); ::send(sockfd, line, strlen(line), 0);
474 | }
475 | snprintf(line, 256, "Upgrade: websocket\r\n"); ::send(sockfd, line, strlen(line), 0);
476 | snprintf(line, 256, "Connection: Upgrade\r\n"); ::send(sockfd, line, strlen(line), 0);
477 | if (!origin.empty()) {
478 | snprintf(line, 256, "Origin: %s\r\n", origin.c_str()); ::send(sockfd, line, strlen(line), 0);
479 | }
480 | snprintf(line, 256, "Sec-WebSocket-Key: x3JJHMbDL1EzLkh9GBhXDw==\r\n"); ::send(sockfd, line, strlen(line), 0);
481 | snprintf(line, 256, "Sec-WebSocket-Version: 13\r\n"); ::send(sockfd, line, strlen(line), 0);
482 | snprintf(line, 256, "\r\n"); ::send(sockfd, line, strlen(line), 0);
483 | for (i = 0; i < 2 || (i < 255 && line[i-2] != '\r' && line[i-1] != '\n'); ++i) { if (recv(sockfd, line+i, 1, 0) == 0) { return NULL; } }
484 | line[i] = 0;
485 | if (i == 255) { fprintf(stderr, "ERROR: Got invalid status line connecting to: %s\n", url.c_str()); return NULL; }
486 | if (sscanf(line, "HTTP/1.1 %d", &status) != 1 || status != 101) { fprintf(stderr, "ERROR: Got bad status connecting to %s: %s", url.c_str(), line); return NULL; }
487 | // TODO: verify response headers,
488 | while (true) {
489 | for (i = 0; i < 2 || (i < 255 && line[i-2] != '\r' && line[i-1] != '\n'); ++i) { if (recv(sockfd, line+i, 1, 0) == 0) { return NULL; } }
490 | if (line[0] == '\r' && line[1] == '\n') { break; }
491 | }
492 | }
493 | int flag = 1;
494 | setsockopt(sockfd, IPPROTO_TCP, TCP_NODELAY, (char*) &flag, sizeof(flag)); // Disable Nagle's algorithm
495 | #ifdef _WIN32
496 | u_long on = 1;
497 | ioctlsocket(sockfd, FIONBIO, &on);
498 | #else
499 | fcntl(sockfd, F_SETFL, O_NONBLOCK);
500 | #endif
501 | fprintf(stderr, "Connected to: %s\n", url.c_str());
502 | return easywsclient::WebSocket::pointer(new _RealWebSocket(sockfd, useMask));
503 | }
504 |
505 | } // end of module-only namespace
506 |
507 |
508 |
509 | namespace easywsclient {
510 |
511 | WebSocket::pointer WebSocket::create_dummy() {
512 | static pointer dummy = pointer(new _DummyWebSocket);
513 | return dummy;
514 | }
515 |
516 |
517 | WebSocket::pointer WebSocket::from_url(const std::string& url, const std::string& origin) {
518 | return ::from_url(url, true, origin);
519 | }
520 |
521 | WebSocket::pointer WebSocket::from_url_no_mask(const std::string& url, const std::string& origin) {
522 | return ::from_url(url, false, origin);
523 | }
524 |
525 |
526 | } // namespace easywsclient
527 |
--------------------------------------------------------------------------------
/easywsclient.hpp:
--------------------------------------------------------------------------------
1 | #ifndef EASYWSCLIENT_HPP_20170819_MIOFVASDTNUASZDQPLFD
2 | #define EASYWSCLIENT_HPP_20170819_MIOFVASDTNUASZDQPLFD
3 |
4 | // This code comes from:
5 | // https://github.com/dhbaird/easywsclient
6 | //
7 | // To get the latest version:
8 | // wget https://raw.github.com/dhbaird/easywsclient/master/easywsclient.hpp
9 | // wget https://raw.github.com/dhbaird/easywsclient/master/easywsclient.cpp
10 |
11 | #include
12 | #include
13 |
14 | namespace easywsclient {
15 |
16 | struct Callback_Imp { virtual void operator()(const std::string& message) = 0; };
17 | struct BytesCallback_Imp { virtual void operator()(const std::vector& message) = 0; };
18 |
19 | class WebSocket {
20 | public:
21 | typedef WebSocket * pointer;
22 | typedef enum readyStateValues { CLOSING, CLOSED, CONNECTING, OPEN } readyStateValues;
23 |
24 | // Factories:
25 | static pointer create_dummy();
26 | static pointer from_url(const std::string& url, const std::string& origin = std::string());
27 | static pointer from_url_no_mask(const std::string& url, const std::string& origin = std::string());
28 |
29 | // Interfaces:
30 | virtual ~WebSocket() { }
31 | virtual void poll(int timeout = 0) = 0; // timeout in milliseconds
32 | virtual void send(const std::string& message) = 0;
33 | virtual void sendBinary(const std::string& message) = 0;
34 | virtual void sendBinary(const std::vector& message) = 0;
35 | virtual void sendPing() = 0;
36 | virtual void close() = 0;
37 | virtual readyStateValues getReadyState() const = 0;
38 |
39 | template
40 | void dispatch(Callable callable)
41 | // For callbacks that accept a string argument.
42 | { // N.B. this is compatible with both C++11 lambdas, functors and C function pointers
43 | struct _Callback : public Callback_Imp {
44 | Callable& callable;
45 | _Callback(Callable& callable) : callable(callable) { }
46 | void operator()(const std::string& message) { callable(message); }
47 | };
48 | _Callback callback(callable);
49 | _dispatch(callback);
50 | }
51 |
52 | template
53 | void dispatchBinary(Callable callable)
54 | // For callbacks that accept a std::vector argument.
55 | { // N.B. this is compatible with both C++11 lambdas, functors and C function pointers
56 | struct _Callback : public BytesCallback_Imp {
57 | Callable& callable;
58 | _Callback(Callable& callable) : callable(callable) { }
59 | void operator()(const std::vector& message) { callable(message); }
60 | };
61 | _Callback callback(callable);
62 | _dispatchBinary(callback);
63 | }
64 |
65 | protected:
66 | virtual void _dispatch(Callback_Imp& callable) = 0;
67 | virtual void _dispatchBinary(BytesCallback_Imp& callable) = 0;
68 | };
69 |
70 | } // namespace easywsclient
71 |
72 | #endif /* EASYWSCLIENT_HPP_20120819_MIOFVASDTNUASZDQPLFD */
73 |
--------------------------------------------------------------------------------
/example-client-cpp11.cpp:
--------------------------------------------------------------------------------
1 | // Compile with:
2 | // g++ -std=gnu++0x example-client-cpp11.cpp -o example-client-cpp11
3 | #include "easywsclient.hpp"
4 | //#include "easywsclient.cpp" // <-- include only if you don't want compile separately
5 | #ifdef _WIN32
6 | #pragma comment( lib, "ws2_32" )
7 | #include
8 | #endif
9 | #include
10 | #include
11 | #include
12 | #include
13 |
14 | int main()
15 | {
16 | using easywsclient::WebSocket;
17 | #ifdef _WIN32
18 | INT rc;
19 | WSADATA wsaData;
20 |
21 | rc = WSAStartup(MAKEWORD(2, 2), &wsaData);
22 | if (rc) {
23 | printf("WSAStartup Failed.\n");
24 | return 1;
25 | }
26 | #endif
27 |
28 | std::unique_ptr ws(WebSocket::from_url("ws://localhost:8126/foo"));
29 | assert(ws);
30 | ws->send("goodbye");
31 | ws->send("hello");
32 | while (ws->getReadyState() != WebSocket::CLOSED) {
33 | WebSocket::pointer wsp = &*ws; // <-- because a unique_ptr cannot be copied into a lambda
34 | ws->poll();
35 | ws->dispatch([wsp](const std::string & message) {
36 | printf(">>> %s\n", message.c_str());
37 | if (message == "world") { wsp->close(); }
38 | });
39 | }
40 | #ifdef _WIN32
41 | WSACleanup();
42 | #endif
43 | // N.B. - unique_ptr will free the WebSocket instance upon return:
44 | return 0;
45 | }
46 |
--------------------------------------------------------------------------------
/example-client.cpp:
--------------------------------------------------------------------------------
1 | #include "easywsclient.hpp"
2 | //#include "easywsclient.cpp" // <-- include only if you don't want compile separately
3 | #ifdef _WIN32
4 | #pragma comment( lib, "ws2_32" )
5 | #include
6 | #endif
7 | #include
8 | #include
9 | #include
10 |
11 | using easywsclient::WebSocket;
12 | static WebSocket::pointer ws = NULL;
13 |
14 | void handle_message(const std::string & message)
15 | {
16 | printf(">>> %s\n", message.c_str());
17 | if (message == "world") { ws->close(); }
18 | }
19 |
20 | int main()
21 | {
22 | #ifdef _WIN32
23 | INT rc;
24 | WSADATA wsaData;
25 |
26 | rc = WSAStartup(MAKEWORD(2, 2), &wsaData);
27 | if (rc) {
28 | printf("WSAStartup Failed.\n");
29 | return 1;
30 | }
31 | #endif
32 |
33 | ws = WebSocket::from_url("ws://localhost:8126/foo");
34 | assert(ws); ////判断ws对象是否为空null ,当没有连接上的时候这个对象是NULL
35 | ws->send("goodbye");
36 | ws->send("hello");
37 | while (ws->getReadyState() != WebSocket::CLOSED) {
38 | ws->poll();//这个函数一定要在循环里调用,发送和接收都是基于这个函数进行异步处理的
39 | ws->dispatch(handle_message);
40 | }
41 | delete ws;
42 | #ifdef _WIN32
43 | WSACleanup();
44 | #endif
45 | return 0;
46 | }
47 |
--------------------------------------------------------------------------------
/example-server.js:
--------------------------------------------------------------------------------
1 | /*
2 | Prerequisites:
3 |
4 | 1. Install node.js and npm
5 | 2. npm install ws
6 |
7 | See also,
8 |
9 | http://einaros.github.com/ws/
10 |
11 | To run,
12 |
13 | node example-server.js
14 | */
15 |
16 | "use strict"; // http://ejohn.org/blog/ecmascript-5-strict-mode-json-and-more/
17 | var WebSocketServer = require('ws').Server;
18 | var http = require('http');
19 |
20 | var server = http.createServer();
21 | var wss = new WebSocketServer({server: server, path: '/foo'});
22 | wss.on('connection', function(ws) {
23 | console.log('/foo connected');
24 | ws.on('message', function(data, flags) {
25 | if (flags.binary) { return; }
26 | console.log('>>> ' + data);
27 | if (data == 'goodbye') { console.log('<<< galaxy'); ws.send('galaxy'); }
28 | if (data == 'hello') { console.log('<<< world'); ws.send('world'); }
29 | });
30 | ws.on('close', function() {
31 | console.log('Connection closed!');
32 | });
33 | ws.on('error', function(e) {
34 | });
35 | });
36 | server.listen(8126);
37 | console.log('Listening on port 8126...');
38 |
--------------------------------------------------------------------------------
/test/Makefile:
--------------------------------------------------------------------------------
1 | include gtest.mk
2 |
3 | CXXFLAGS = -std=gnu++1y -Wall -I..
4 | LDLIBS +=
5 | .PHONY: all clean
6 | test: easywsclient.t
7 | node testServer.js & sleep 1 && ./easywsclient.t
8 | clean:
9 | -rm easywsclient.t *.o
10 | vpath %.cpp ../
11 | vpath %.hpp ../
12 | easywsclient.t: easywsclient.t.o easywsclient.o gtest-all.o
13 | easywsclient.o: easywsclient.cpp easywsclient.hpp
14 |
--------------------------------------------------------------------------------
/test/easywsclient.t.cpp:
--------------------------------------------------------------------------------
1 | #include "easywsclient.hpp"
2 | #ifdef _WIN32
3 | #pragma comment( lib, "ws2_32" )
4 | #include
5 | #endif
6 | #include
7 | #include
8 | #include
9 | #include
10 | #include
11 | #include
12 | #include
13 | #include
14 | #include
15 |
16 | using easywsclient::WebSocket;
17 |
18 | namespace {
19 |
20 | #ifdef _WIN32
21 | class WSAInit
22 | {
23 | public:
24 | WSAInit()
25 | {
26 | INT rc;
27 | WSADATA wsaData;
28 | rc = WSAStartup(MAKEWORD(2, 2), &wsaData);
29 | if (rc) {
30 | throw std::runtime_error("WSAStartup failed");
31 | }
32 | }
33 | ~WSAInit()
34 | {
35 | WSACleanup();
36 | }
37 | };
38 | #endif
39 |
40 | class KillServer
41 | {
42 | public:
43 | KillServer() : d_ws(WebSocket::from_url("ws://localhost:8123/killServer"))
44 | {
45 | assert(d_ws);
46 | }
47 | ~KillServer()
48 | {
49 | d_ws->send("exit"); // sending any message instructs the server to die
50 | d_ws->poll();
51 | d_ws->poll();
52 | }
53 | private:
54 | std::unique_ptr d_ws;
55 | };
56 |
57 | std::string makeString(size_t length)
58 | {
59 | std::vector v;
60 | v.reserve(length + 1);
61 | for (size_t i = 0; i < length; ++i) {
62 | v.push_back('0' + (i % 10));
63 | }
64 | v.push_back(0);
65 | return &v[0];
66 | }
67 |
68 | }
69 |
70 | TEST(easywsclient, textFramesWork)
71 | {
72 |
73 | std::unique_ptr ws(WebSocket::from_url("ws://localhost:8123/echoWithSize"));
74 | assert(ws);
75 | ws->send("four");
76 | std::string message;
77 | while (ws->getReadyState() != WebSocket::CLOSED) {
78 | bool gotMessage = false;
79 | ws->poll();
80 | ws->dispatch([gotMessageOut=&gotMessage, messageOut=&message, ws=ws.get()](const std::string& message) {
81 | *gotMessageOut = true;
82 | *messageOut = message;
83 | });
84 | if (gotMessage) {
85 | break;
86 | }
87 | }
88 | ASSERT_EQ("4\nfour", message);
89 | ws->close(); // hmmm... shouldn't this be RAII?
90 | }
91 |
92 | TEST(easywsclient, longTextFramesWork)
93 | {
94 | std::unique_ptr ws(WebSocket::from_url("ws://localhost:8123/echoWithSize"));
95 | assert(ws);
96 | std::vector > v;
97 | v.emplace_back( "0", makeString(0));
98 | v.emplace_back( "1", makeString(1));
99 | v.emplace_back( "123", makeString(123));
100 | v.emplace_back( "124", makeString(124));
101 | v.emplace_back( "125", makeString(125));
102 | v.emplace_back( "126", makeString(126));
103 | v.emplace_back( "127", makeString(127));
104 | v.emplace_back( "128", makeString(128));
105 | v.emplace_back("10000", makeString(10000));
106 | v.emplace_back("32767", makeString(32767));
107 | v.emplace_back("65500", makeString(65500));
108 | v.emplace_back("65529", makeString(65529));
109 | v.emplace_back("65530", makeString(65530));
110 | v.emplace_back("65531", makeString(65531));
111 | v.emplace_back("65532", makeString(65532));
112 | v.emplace_back("65533", makeString(65533));
113 | v.emplace_back("65534", makeString(65534));
114 | v.emplace_back("65535", makeString(65535));
115 | v.emplace_back("65536", makeString(65536));
116 | v.emplace_back("65537", makeString(65537));
117 | for (auto i = v.begin(); i != v.end(); ++i) {
118 | ws->send(i->second);
119 | std::string message;
120 | while (ws->getReadyState() != WebSocket::CLOSED) {
121 | bool gotMessage = false;
122 | ws->poll();
123 | ws->dispatch([gotMessageOut=&gotMessage, messageOut=&message, ws=ws.get()](const std::string& message) {
124 | *gotMessageOut = true;
125 | *messageOut = message;
126 | });
127 | if (gotMessage) {
128 | break;
129 | }
130 | }
131 | ASSERT_EQ(i->first + "\n" + i->second, message);
132 | }
133 | ws->close(); // hmmm... shouldn't this be RAII?
134 | }
135 |
136 | TEST(easywsclient, binaryFramesWork)
137 | {
138 | std::unique_ptr ws(WebSocket::from_url("ws://localhost:8123/binaryEchoWithSize"));
139 | assert(ws);
140 | ws->sendBinary(std::vector({1, 2, 3}));
141 | std::vector message;
142 | while (ws->getReadyState() != WebSocket::CLOSED) {
143 | bool gotMessage = false;
144 | ws->poll();
145 | ws->dispatchBinary([gotMessageOut=&gotMessage, messageOut=&message, ws=ws.get()](const std::vector& message) {
146 | *gotMessageOut = true;
147 | *messageOut = message;
148 | });
149 | if (gotMessage) {
150 | break;
151 | }
152 | }
153 | ASSERT_EQ(std::vector({0, 0, 0, 3, 1, 2, 3}), message);
154 | ws->close(); // hmmm... shouldn't this be RAII?
155 | }
156 |
157 | int main(int argc, char **argv)
158 | {
159 | #ifdef _WIN32
160 | WSAInit wsaInit;
161 | #endif
162 | KillServer killServer; // RAII to ensure server gets terminated when tests terminate
163 | ::testing::InitGoogleTest(&argc, argv);
164 | return RUN_ALL_TESTS();
165 | }
166 |
--------------------------------------------------------------------------------
/test/gtest.mk:
--------------------------------------------------------------------------------
1 | # gtest.mk
2 | # Uses the source code version of GoogleTest, assumed to be installed at /usr/src/gtest.
3 | GTEST_PATH ?= /usr/src/gtest
4 | GTEST_OBJS = gtest-all.o
5 | LDLIBS += -lpthread
6 | LDLIBS += -lstdc++
7 | vpath %.cc $(GTEST_PATH)/src
8 |
9 | GTEST_FOUND = $(shell ls -d $(GTEST_PATH)/src/gtest-all.cc)
10 | ifeq (,$(GTEST_FOUND))
11 | $(info )
12 | $(info Error:)
13 | $(info GoogleTest sources were not found at the path:)
14 | $(info GTEST_PATH=$(GTEST_PATH))
15 | $(info Suggested corrective action: sudo apt-get install libgtest-dev)
16 | $(info )
17 | $(error Please setup GTEST_PATH so that gtest-all.cc can be found.)
18 | endif
19 |
20 | .PHONY: all gtest_clean
21 | all:
22 | gtest_clean:
23 | -rm gtest-all.o
24 | gtest-all.o: CXXFLAGS += -I$(GTEST_PATH)
25 |
--------------------------------------------------------------------------------
/test/testServer.js:
--------------------------------------------------------------------------------
1 | /*
2 | Prerequisites:
3 |
4 | 1. Install node.js and npm
5 | 2. npm install ws
6 |
7 | See also,
8 |
9 | http://einaros.github.com/ws/
10 |
11 | To run,
12 |
13 | node example-server.js
14 | */
15 |
16 | "use strict"; // http://ejohn.org/blog/ecmascript-5-strict-mode-json-and-more/
17 | var WebSocketServer = require('ws').Server;
18 | var http = require('http');
19 | var app = http.createServer();
20 | var server; // assigned by app.listen() below
21 |
22 | var wssEchoWithSize = new WebSocketServer({server: app, path: '/echoWithSize'});
23 | wssEchoWithSize.on('connection', function(ws) {
24 | ws.on('message', function(data, flags) {
25 | if (flags.binary) { return; }
26 | ws.send(data.length + '\n' + data);
27 | });
28 | ws.on('close', function() {
29 | });
30 | ws.on('error', function(e) {
31 | });
32 | });
33 |
34 | var wssBinaryEchoWithSize = new WebSocketServer({server: app, path: '/binaryEchoWithSize'});
35 | wssBinaryEchoWithSize.on('connection', function(ws) {
36 | ws.on('message', function(data, flags) {
37 | if (!flags.binary) { return; }
38 | //var result = new ArrayBuffer(data.length + 4);
39 | //new DataView(result).setInt32(0, data.length, false); // false = big endian
40 | var result = new Buffer(data.length + 4);
41 | result.writeInt32BE(data.length, 0);
42 | data.copy(result, 4, 0, data.length);
43 | ws.send(result, { binary: true });
44 | });
45 | ws.on('close', function() {
46 | });
47 | ws.on('error', function(e) {
48 | });
49 | });
50 |
51 | var wssKillServer = new WebSocketServer({server: app, path: '/killServer'});
52 | wssKillServer.on('connection', function(ws) {
53 | ws.on('message', function(data, flags) {
54 | if (flags.binary) { return; }
55 | server.close();
56 | });
57 | ws.on('close', function() {
58 | });
59 | ws.on('error', function(e) {
60 | });
61 | });
62 |
63 | var PORT = parseInt(process.env.PORT || '8123');
64 | server = app.listen(PORT);
65 | console.log('Listening on port ' + PORT + '...');
66 |
--------------------------------------------------------------------------------