├── .gitignore
├── .travis.yml
├── LICENSE
├── README.md
├── codecov.yml
├── deploy-docs.sh
├── docs
    ├── .gitignore
    ├── Makefile
    ├── _static
    │   └── .keep
    ├── _themes
    │   └── sphinx_rtd_theme
    │   │   ├── __init__.py
    │   │   ├── breadcrumbs.html
    │   │   ├── footer.html
    │   │   ├── layout.html
    │   │   ├── search.html
    │   │   ├── searchbox.html
    │   │   ├── static
    │   │       ├── css
    │   │       │   ├── badge_only.css
    │   │       │   └── theme.css
    │   │       ├── fonts
    │   │       │   ├── FontAwesome.otf
    │   │       │   ├── fontawesome-webfont.eot
    │   │       │   ├── fontawesome-webfont.svg
    │   │       │   ├── fontawesome-webfont.ttf
    │   │       │   ├── fontawesome-webfont.woff
    │   │       │   └── fontawesome-webfont.woff2
    │   │       └── js
    │   │       │   ├── modernizr.min.js
    │   │       │   └── theme.js
    │   │   ├── theme.conf
    │   │   └── versions.html
    ├── api.rst
    ├── conf.py
    ├── index.rst
    ├── install.rst
    ├── javadocs
    │   └── index.rst
    ├── requirements.txt
    ├── spring-integration.rst
    └── using.rst
├── engine.io-server-coverage
    └── pom.xml
├── engine.io-server-test
    ├── pom.xml
    └── src
    │   └── test
    │       ├── java
    │           └── io
    │           │   └── socket
    │           │       └── engineio
    │           │           └── server
    │           │               ├── JettyEngineIoWebSocketHandler.java
    │           │               ├── PollingJsonpTest.java
    │           │               ├── PollingTest.java
    │           │               ├── ServerWrapper.java
    │           │               ├── TestUtils.java
    │           │               ├── UpgradeTest.java
    │           │               └── WebSocketTest.java
    │       └── resources
    │           ├── helpers.js
    │           ├── package-lock.json
    │           ├── package.json
    │           ├── testPollingJsonp.html
    │           ├── testPollingJsonp_echo_string.js
    │           ├── testPollingJsonp_reverseEcho.js
    │           ├── testPolling_connect.js
    │           ├── testPolling_echo_base64.js
    │           ├── testPolling_echo_binary.js
    │           ├── testPolling_echo_string.js
    │           ├── testPolling_reverseEcho.js
    │           ├── testUpgrade_echo.js
    │           ├── testWebSocket_connect.js
    │           ├── testWebSocket_echo_base64.js
    │           ├── testWebSocket_echo_binary.js
    │           ├── testWebSocket_echo_string.js
    │           └── testWebSocket_reverseEcho.js
├── engine.io-server
    ├── pom.xml
    └── src
    │   ├── main
    │       └── java
    │       │   └── io
    │       │       └── socket
    │       │           └── engineio
    │       │               └── server
    │       │                   ├── Emitter.java
    │       │                   ├── EngineIoServer.java
    │       │                   ├── EngineIoServerOptions.java
    │       │                   ├── EngineIoSocket.java
    │       │                   ├── EngineIoWebSocket.java
    │       │                   ├── ReadyState.java
    │       │                   ├── ServerErrors.java
    │       │                   ├── Transport.java
    │       │                   ├── package-info.java
    │       │                   ├── parser
    │       │                       ├── Packet.java
    │       │                       ├── Parser.java
    │       │                       ├── ParserV3.java
    │       │                       ├── ParserV4.java
    │       │                       └── package-info.java
    │       │                   ├── transport
    │       │                       ├── Polling.java
    │       │                       ├── WebSocket.java
    │       │                       └── package-info.java
    │       │                   └── utils
    │       │                       ├── JsonUtils.java
    │       │                       ├── ParseQS.java
    │       │                       └── ServerYeast.java
    │   └── test
    │       ├── java
    │           └── io
    │           │   └── socket
    │           │       └── engineio
    │           │           └── server
    │           │               ├── DeadLockTest.java
    │           │               ├── EmitterTest.java
    │           │               ├── EngineIoServerOptionsTest.java
    │           │               ├── EngineIoServerTest.java
    │           │               ├── EngineIoSocketTest.java
    │           │               ├── HttpServletResponseImpl.java
    │           │               ├── ServletInputStreamWrapper.java
    │           │               ├── ServletOutputStreamWrapper.java
    │           │               ├── TestUtils.java
    │           │               ├── TransportTest.java
    │           │               ├── parser
    │           │                   ├── ParserV3Test.java
    │           │                   └── ParserV4Test.java
    │           │               └── transport
    │           │                   ├── PollingTest.java
    │           │                   └── WebSocketTest.java
    │       └── resources
    │           ├── helpers.js
    │           ├── parser_v3
    │               ├── package-lock.json
    │               ├── package.json
    │               ├── testEncodePacket_base64.js
    │               ├── testEncodePacket_binary.js
    │               ├── testEncodePacket_string.js
    │               ├── testEncodePayload_base64.js
    │               ├── testEncodePayload_binary.js
    │               └── testEncodePayload_string.js
    │           └── parser_v4
    │               ├── package-lock.json
    │               ├── package.json
    │               ├── testEncodePacket_base64.js
    │               ├── testEncodePacket_binary.js
    │               ├── testEncodePacket_string.js
    │               ├── testEncodePayload_base64.js
    │               ├── testEncodePayload_binary.js
    │               └── testEncodePayload_string.js
└── pom.xml


/.gitignore:
--------------------------------------------------------------------------------
 1 | *.class
 2 | 
 3 | # Package Files #
 4 | *.jar
 5 | *.war
 6 | *.ear
 7 | 
 8 | # Intellij project files
 9 | *.iml
10 | *.ipr
11 | *.iws
12 | .idea/
13 | 
14 | .DS_Store
15 | target/
16 | node_modules/
17 | 


--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
 1 | language: java
 2 | dist: xenial
 3 | sudo: false
 4 | 
 5 | branches:
 6 |   except:
 7 |     - gh-pages
 8 | 
 9 | env:
10 |   global:
11 |     - secure: Ce3oODysULOXpf+LAZgd4j942c5Ck5n7e/Lj0vEzdyMAYXVerraVctrFxlu90aCqqzWuMmlL5f0YWhPUwUFVBxtL0vUUT1g/2w95wix8p7SqkiE+fc//o/DIowGztUJ/5kIn4GMPyx4/RAk/YnYEptc8fpOcqWK52BAPgE9zX39Wmgl08VLwY1x474T3r0NG0YSldj7FUmt/R606DegP3YcqP6Tqwhv3xpp25HNw0qNu3yCJm8gpGCEzRElXBRts2bHU+nnW+BgQrhX+WOSI2UfCr4tDxprq2MP6yvDNZgaiJwJ9quBo4dbgjSKVLrVnQQYnCzaxDN4RuZxvfJVFXx7tim8Y4/ocZU8GZVXgcTBDcSjNUqNAlMZyfdoQEbNzHrFbsCk4KmTKsaAKmMV4MaLX2vFrl8WxLSAEXRboOgq3d+pXRKK/fWMQdG+bWWk0QbbasGb+gNadGgfPbNPh52ikASkRLEwkhJXIS9oU8ZgaXJvrgFmZwbXBqZkhv/ff6/cYHPx0BNR1gLeOnOwrkK67CRHQ2yIF4NWdRXmiZ0w4VmatYbHGaWrpM9/Jy2TOotCjDu3wEuUwZcTrFCma1dn06cUQrlBnxeCIJ/iA4hk7nI4SO1+oM0sXa/YTLxMUXOGV/kPPBcwyJ0DIu5IA6AakTOQNnBF8F5bqUBvlcFc=
12 | 
13 | addons:
14 |   apt:
15 |     update: true
16 | 
17 | matrix:
18 |   include:
19 |     - name: "Java 8 Tests"
20 |       jdk: openjdk8
21 |       env: TESTENV=tests
22 |       script: mvn test
23 |     - name: "GitHub Pages"
24 |       jdk: openjdk8
25 |       env: TESTENV=cover FYI="this also builds documentation for tags"
26 |       script: '[[ -n "$TRAVIS_TAG" ]] && ./deploy-docs.sh || true'
27 |       addons:
28 |         apt:
29 |           packages:
30 |             - python3
31 |             - python3-pip
32 |             - python-virtualenv
33 |             - make
34 | 
35 | after_success:
36 |   - '[[ "$TESTENV" == "tests" ]] && bash <(curl -s https://codecov.io/bash) -f engine.io-server-coverage/target/site/jacoco-aggregate/jacoco.xml'
37 | 
38 | cache:
39 |   directories:
40 |   - $HOME/.m2
41 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # Engine.IO Java
  2 | [![Build Status](https://travis-ci.org/socketio/engine.io-server-java.png?branch=master)](https://travis-ci.org/socketio/engine.io-server-java) [![codecov](https://codecov.io/gh/socketio/engine.io-server-java/branch/master/graph/badge.svg)](https://codecov.io/gh/socketio/engine.io-server-java)
  3 | 
  4 | This is the Engine.IO Server Library for Java ported from the [JavaScript server](https://github.com/socketio/engine.io).
  5 | 
  6 | **NOTE** This library will follow the major version of the JS library starting with version 4.
  7 | 
  8 | See also: [Socket.IO-server Java](https://github.com/socketio/socket.io-server-java), [Engine.IO-client Java](https://github.com/socketio/engine.io-client-java)
  9 | 
 10 | ## Documentation
 11 | Complete documentation can be found [here](https://socketio.github.io/engine.io-server-java/).
 12 | 
 13 | ## Installation
 14 | If you're looking for the socket.io library instead, please [see here](https://github.com/trinopoty/socket.io-server-java).
 15 | 
 16 | The latest artifact is available on Maven Central.
 17 | 
 18 | ### Maven
 19 | Add the following dependency to your `pom.xml`.
 20 | 
 21 | ```xml
 22 | <dependencies>
 23 |   <dependency>
 24 |     <groupId>io.socket</groupId>
 25 |     <artifactId>engine.io-server</artifactId>
 26 |     <version>6.2.1</version>
 27 |   </dependency>
 28 | </dependencies>
 29 | ```
 30 | 
 31 | ### Gradle
 32 | Add it as a gradle dependency in `build.gradle`.
 33 | 
 34 | ```groovy
 35 | implementation ('io.socket:engine.io-server:6.2.1')
 36 | ```
 37 | 
 38 | #### Engine.IO Protocol 1.x suppport
 39 | 
 40 | The current version of engine.io-java does not support protocol 1.x.
 41 | 
 42 | ## Usage
 43 | If you're looking for the socket.io library instead, please [see here](https://github.com/trinopoty/socket.io-server-java).
 44 | 
 45 | Usage is slightly different based on the server being used.
 46 | 
 47 | Create a servlet to handle the HTTP requests as follows:
 48 | ```java
 49 | public class EngineIoServlet extends HttpServlet {
 50 | 
 51 |     private final EngineIoServer mEngineIoServer = new EngineIoServer();
 52 | 
 53 |     @Override
 54 |     protected void service(HttpServletRequest request, HttpServletResponse response) throws IOException {
 55 |         mEngineIoServer.handleRequest(request, response);
 56 |     }
 57 | }
 58 | ```
 59 | 
 60 | Listen for new connections as follows:
 61 | ```java
 62 | EngineIoServer server;  // server instance
 63 | server.on("connection", new Emitter.Listener() {
 64 |     @Override
 65 |     public void call(Object... args) {
 66 |         EngineIoSocket socket = (EngineIoSocket) args[0];
 67 |         // Do something with socket like store it somewhere
 68 |     }
 69 | });
 70 | ```
 71 | 
 72 | Listen for raw packets received as follows:
 73 | ```java
 74 | EngineIoSocket socket;  // socket received in "connection" event
 75 | 
 76 | socket.on("packet", new Emitter.Listener() {
 77 |     @Override
 78 |     public void call(Object... args) {
 79 |         Packet packet = (Packet) args[0];
 80 |         // Do something with packet.
 81 |     }
 82 | });
 83 | ```
 84 | 
 85 | Listen for messages from the remote client as follows:
 86 | ```java
 87 | EngineIoSocket socket;  // socket received in "connection" event
 88 | 
 89 | socket.on("message", new Emitter.Listener() {
 90 |     @Override
 91 |     public void call(Object... args) {
 92 |         Object message = args[0];
 93 |         // message can be either String or byte[]
 94 |         // Do something with message.
 95 |     }
 96 | });
 97 | ```
 98 | 
 99 | Send a packet to client as follows:
100 | ```java
101 | EngineIoSocket socket;  // socket received in "connection" event
102 | 
103 | socket.send(new Packet<>(Packet.MESSAGE, "foo"));
104 | ```
105 | 
106 | ### WebSockets
107 | Please see the complete documentation on handling WebSockets [here](https://socketio.github.io/engine.io-server-java/using.html#websocket-connections).
108 | 
109 | ## Features
110 | This library supports all of the features the JS server does, including events, options and upgrading transport.
111 | 
112 | ## License
113 | 
114 | Apache 2.0
115 | 


--------------------------------------------------------------------------------
/codecov.yml:
--------------------------------------------------------------------------------
 1 | codecov:
 2 |   notify:
 3 |     require_ci_to_pass: yes
 4 | 
 5 | coverage:
 6 |   precision: 2
 7 |   round: down
 8 | 
 9 |   status:
10 |     project: yes
11 |     patch: yes
12 |     changes: no
13 | 
14 | parsers:
15 |   gcov:
16 |     branch_detection:
17 |       conditional: yes
18 |       loop: yes
19 |       method: no
20 |       macro: no
21 | 
22 | comment:
23 |   layout: "header, diff"
24 |   behavior: default
25 |   require_changes: no
26 | 
27 | 


--------------------------------------------------------------------------------
/deploy-docs.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | 
 3 | # This script builds the documentation and pushes it to github
 4 | 
 5 | GH_REPO_REF="github.com/$TRAVIS_REPO_SLUG"
 6 | 
 7 | set -e
 8 | 
 9 | JAVADOC_DIR=$(pwd)/target/site/apidocs
10 | 
11 | # Build the javadocs
12 | mvn -DskipTests clean javadoc:aggregate
13 | 
14 | # Activate virtualenv
15 | virtualenv -p python3 venv
16 | . venv/bin/activate
17 | 
18 | cd docs
19 | rm -rf ./_build
20 | 
21 | # Install dependencies
22 | pip install -r requirements.txt
23 | 
24 | # Build docs
25 | make html
26 | 
27 | cd _build
28 | 
29 | # Configure git
30 | git config --global push.default simple
31 | git config user.name "Travis CI"
32 | git config user.email "travis@travis-ci.org"
33 | 
34 | # Clone docs branch
35 | git clone -b gh-pages https://git@$GH_REPO_REF docs-upload
36 | cd docs-upload
37 | 
38 | # Remove existing docs
39 | rm -rf *
40 | 
41 | # Copy docs from build to repo
42 | cp -r ../html/* ./
43 | 
44 | # Copy javadocs
45 | rm -rf ./javadocs
46 | mv "$JAVADOC_DIR" ./javadocs
47 | 
48 | echo "" > .nojekyll
49 | 
50 | if [[ -f "index.html" ]]; then
51 |     # Commit
52 |     git add --all
53 |     git commit -m "Deploy code docs to GitHub Pages Travis build"
54 | 
55 |     export GH_REPO_TOKEN="trinopoty@${GH_TOKEN}"
56 |     git push --force "https://${GH_REPO_TOKEN}@${GH_REPO_REF}" > /dev/null 2>&1
57 | else
58 |     echo 'ERROR: index.html not found'
59 |     exit 1
60 | fi
61 | 


--------------------------------------------------------------------------------
/docs/.gitignore:
--------------------------------------------------------------------------------
1 | /_build
2 | 


--------------------------------------------------------------------------------
/docs/Makefile:
--------------------------------------------------------------------------------
 1 | # Minimal makefile for Sphinx documentation
 2 | #
 3 | 
 4 | # You can set these variables from the command line.
 5 | SPHINXOPTS    =
 6 | SPHINXBUILD   = sphinx-build
 7 | SPHINXPROJ    = EngineIO
 8 | SOURCEDIR     = .
 9 | BUILDDIR      = _build
10 | 
11 | # Put it first so that "make" without argument is like "make help".
12 | help:
13 | 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14 | 
15 | .PHONY: help Makefile
16 | 
17 | # Catch-all target: route all unknown targets to Sphinx using the new
18 | # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
19 | %: Makefile
20 | 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)


--------------------------------------------------------------------------------
/docs/_static/.keep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/socketio/engine.io-server-java/a74a55654ac37bcfa8848ea5dbbbd24adddb8884/docs/_static/.keep


--------------------------------------------------------------------------------
/docs/_themes/sphinx_rtd_theme/__init__.py:
--------------------------------------------------------------------------------
 1 | """Sphinx ReadTheDocs theme.
 2 | 
 3 | From https://github.com/ryan-roemer/sphinx-bootstrap-theme.
 4 | 
 5 | """
 6 | from os import path
 7 | 
 8 | __version__ = '0.4.1'
 9 | __version_full__ = __version__
10 | 
11 | 
12 | def get_html_theme_path():
13 |     """Return list of HTML theme paths."""
14 |     cur_dir = path.abspath(path.dirname(path.dirname(__file__)))
15 |     return cur_dir
16 | 
17 | # See http://www.sphinx-doc.org/en/stable/theming.html#distribute-your-theme-as-a-python-package
18 | def setup(app):
19 |     app.add_html_theme('sphinx_rtd_theme', path.abspath(path.dirname(__file__)))
20 | 


--------------------------------------------------------------------------------
/docs/_themes/sphinx_rtd_theme/breadcrumbs.html:
--------------------------------------------------------------------------------
 1 | {# Support for Sphinx 1.3+ page_source_suffix, but don't break old builds. #}
 2 | 
 3 | {% if page_source_suffix %}
 4 | {% set suffix = page_source_suffix %}
 5 | {% else %}
 6 | {% set suffix = source_suffix %}
 7 | {% endif %}
 8 | 
 9 | {% if meta is defined and meta is not none %}
10 | {% set check_meta = True %}
11 | {% else %}
12 | {% set check_meta = False %}
13 | {% endif %}
14 | 
15 | {% if check_meta and 'github_url' in meta %}
16 | {% set display_github = True %}
17 | {% endif %}
18 | 
19 | {% if check_meta and 'bitbucket_url' in meta %}
20 | {% set display_bitbucket = True %}
21 | {% endif %}
22 | 
23 | {% if check_meta and 'gitlab_url' in meta %}
24 | {% set display_gitlab = True %}
25 | {% endif %}
26 | 
27 | <div role="navigation" aria-label="breadcrumbs navigation">
28 | 
29 |   <ul class="wy-breadcrumbs">
30 |     {% block breadcrumbs %}
31 |       <li><a href="{{ pathto(master_doc) }}">{{ _('Docs') }}</a> &raquo;</li>
32 |         {% for doc in parents %}
33 |           <li><a href="{{ doc.link|e }}">{{ doc.title }}</a> &raquo;</li>
34 |         {% endfor %}
35 |       <li>{{ title }}</li>
36 |     {% endblock %}
37 |     {% block breadcrumbs_aside %}
38 |       <li class="wy-breadcrumbs-aside">
39 |         {% if hasdoc(pagename) %}
40 |             {% if display_github %}
41 |             {% if check_meta and 'github_url' in meta %}
42 |               <!-- User defined GitHub URL -->
43 |               <a href="{{ meta['github_url'] }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
44 |             {% else %}
45 |               <a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/{{ theme_vcs_pageview_mode|default("blob") }}/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
46 |             {% endif %}
47 |           {% elif display_bitbucket %}
48 |             {% if check_meta and 'bitbucket_url' in meta %}
49 |               <!-- User defined Bitbucket URL -->
50 |               <a href="{{ meta['bitbucket_url'] }}" class="fa fa-bitbucket"> {{ _('Edit on Bitbucket') }}</a>
51 |             {% else %}
52 |               <a href="https://bitbucket.org/{{ bitbucket_user }}/{{ bitbucket_repo }}/src/{{ bitbucket_version}}{{ conf_py_path }}{{ pagename }}{{ suffix }}?mode={{ theme_vcs_pageview_mode|default("view") }}" class="fa fa-bitbucket"> {{ _('Edit on Bitbucket') }}</a>
53 |             {% endif %}
54 |           {% elif display_gitlab %}
55 |             {% if check_meta and 'gitlab_url' in meta %}
56 |               <!-- User defined GitLab URL -->
57 |               <a href="{{ meta['gitlab_url'] }}" class="fa fa-gitlab"> {{ _('Edit on GitLab') }}</a>
58 |             {% else %}
59 |               <a href="https://{{ gitlab_host|default("gitlab.com") }}/{{ gitlab_user }}/{{ gitlab_repo }}/{{ theme_vcs_pageview_mode|default("blob") }}/{{ gitlab_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-gitlab"> {{ _('Edit on GitLab') }}</a>
60 |             {% endif %}
61 |           {% elif show_source and source_url_prefix %}
62 |             <a href="{{ source_url_prefix }}{{ pagename }}{{ suffix }}">{{ _('View page source') }}</a>
63 |           {% elif show_source and has_source and sourcename %}
64 |             <a href="{{ pathto('_sources/' + sourcename, true)|e }}" rel="nofollow"> {{ _('View page source') }}</a>
65 |           {% endif %}
66 |         {% endif %}
67 |       </li>
68 |     {% endblock %}
69 |   </ul>
70 | 
71 |   {% if (theme_prev_next_buttons_location == 'top' or theme_prev_next_buttons_location == 'both') and (next or prev) %}
72 |   <div class="rst-breadcrumbs-buttons" role="navigation" aria-label="breadcrumb navigation">
73 |       {% if next %}
74 |         <a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
75 |       {% endif %}
76 |       {% if prev %}
77 |         <a href="{{ prev.link|e }}" class="btn btn-neutral" title="{{ prev.title|striptags|e }}" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
78 |       {% endif %}
79 |   </div>
80 |   {% endif %}
81 |   <hr/>
82 | </div>
83 | 


--------------------------------------------------------------------------------
/docs/_themes/sphinx_rtd_theme/footer.html:
--------------------------------------------------------------------------------
 1 | <footer>
 2 |   {% if (theme_prev_next_buttons_location == 'bottom' or theme_prev_next_buttons_location == 'both') and (next or prev) %}
 3 |     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 4 |       {% if next %}
 5 |         <a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n" rel="next">{{ _('Next') }} <span class="fa fa-arrow-circle-right"></span></a>
 6 |       {% endif %}
 7 |       {% if prev %}
 8 |         <a href="{{ prev.link|e }}" class="btn btn-neutral" title="{{ prev.title|striptags|e }}" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> {{ _('Previous') }}</a>
 9 |       {% endif %}
10 |     </div>
11 |   {% endif %}
12 | 
13 |   <hr/>
14 | 
15 |   <div role="contentinfo">
16 |     <p>
17 |     {%- if show_copyright %}
18 |       {%- if hasdoc('copyright') %}
19 |         {% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
20 |       {%- else %}
21 |         {% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %}
22 |       {%- endif %}
23 |     {%- endif %}
24 | 
25 |     {%- if build_id and build_url %}
26 |       {% trans build_url=build_url, build_id=build_id %}
27 |         <span class="build">
28 |           Build
29 |           <a href="{{ build_url }}">{{ build_id }}</a>.
30 |         </span>
31 |       {% endtrans %}
32 |     {%- elif commit %}
33 |       {% trans commit=commit %}
34 |         <span class="commit">
35 |           Revision <code>{{ commit }}</code>.
36 |         </span>
37 |       {% endtrans %}
38 |     {%- elif last_updated %}
39 |       {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
40 |     {%- endif %}
41 | 
42 |     </p>
43 |   </div>
44 | 
45 |   {%- if show_sphinx %}
46 |   {% trans %}Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>{% endtrans %}.
47 |   {%- endif %}
48 | 
49 |   {%- block extrafooter %} {% endblock %}
50 | 
51 | </footer>
52 | 
53 | 


--------------------------------------------------------------------------------
/docs/_themes/sphinx_rtd_theme/layout.html:
--------------------------------------------------------------------------------
  1 | {# TEMPLATE VAR SETTINGS #}
  2 | {%- set url_root = pathto('', 1) %}
  3 | {%- if url_root == '#' %}{% set url_root = '' %}{% endif %}
  4 | {%- if not embedded and docstitle %}
  5 |   {%- set titlesuffix = " &mdash; "|safe + docstitle|e %}
  6 | {%- else %}
  7 |   {%- set titlesuffix = "" %}
  8 | {%- endif %}
  9 | {%- set lang_attr = 'en' if language == None else (language | replace('_', '-')) %}
 10 | 
 11 | <!DOCTYPE html>
 12 | <!--[if IE 8]><html class="no-js lt-ie9" lang="{{ lang_attr }}" > <![endif]-->
 13 | <!--[if gt IE 8]><!--> <html class="no-js" lang="{{ lang_attr }}" > <!--<![endif]-->
 14 | <head>
 15 |   <meta charset="utf-8">
 16 |   {{ metatags }}
 17 |   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 18 |   {% block htmltitle %}
 19 |   <title>{{ title|striptags|e }}{{ titlesuffix }}</title>
 20 |   {% endblock %}
 21 | 
 22 |   {# FAVICON #}
 23 |   {% if favicon %}
 24 |     <link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
 25 |   {% endif %}
 26 |   {# CANONICAL URL #}
 27 |   {% if theme_canonical_url %}
 28 |     <link rel="canonical" href="{{ theme_canonical_url }}{{ pagename }}.html"/>
 29 |   {% endif %}
 30 | 
 31 |   {# CSS #}
 32 | 
 33 |   {# OPENSEARCH #}
 34 |   {% if not embedded %}
 35 |     {% if use_opensearch %}
 36 |       <link rel="search" type="application/opensearchdescription+xml"
 37 |             title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}"
 38 |             href="{{ pathto('_static/opensearch.xml', 1) }}"/>
 39 |     {% endif %}
 40 | 
 41 |   {% endif %}
 42 | 
 43 |   <link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
 44 |   <link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css" />
 45 |   {%- for css in css_files %}
 46 |     {%- if css|attr("rel") %}
 47 |   <link rel="{{ css.rel }}" href="{{ pathto(css.filename, 1) }}" type="text/css"{% if css.title is not none %} title="{{ css.title }}"{% endif %} />
 48 |     {%- else %}
 49 |   <link rel="stylesheet" href="{{ pathto(css, 1) }}" type="text/css" />
 50 |     {%- endif %}
 51 |   {%- endfor %}
 52 |   {%- for cssfile in extra_css_files %}
 53 |     <link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
 54 |   {%- endfor %}
 55 | 
 56 |   {%- block linktags %}
 57 |     {%- if hasdoc('about') %}
 58 |     <link rel="author" title="{{ _('About these documents') }}" href="{{ pathto('about') }}" />
 59 |     {%- endif %}
 60 |     {%- if hasdoc('genindex') %}
 61 |     <link rel="index" title="{{ _('Index') }}" href="{{ pathto('genindex') }}" />
 62 |     {%- endif %}
 63 |     {%- if hasdoc('search') %}
 64 |     <link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}" />
 65 |     {%- endif %}
 66 |     {%- if hasdoc('copyright') %}
 67 |     <link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}" />
 68 |     {%- endif %}
 69 |     {%- if next %}
 70 |     <link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}" />
 71 |     {%- endif %}
 72 |     {%- if prev %}
 73 |     <link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}" />
 74 |     {%- endif %}
 75 |   {%- endblock %}
 76 |   {%- block extrahead %} {% endblock %}
 77 | 
 78 |   {# Keep modernizr in head - http://modernizr.com/docs/#installing #}
 79 |   <script src="{{ pathto('_static/js/modernizr.min.js', 1) }}"></script>
 80 | 
 81 | </head>
 82 | 
 83 | <body class="wy-body-for-nav">
 84 | 
 85 |   {% block extrabody %} {% endblock %}
 86 |   <div class="wy-grid-for-nav">
 87 | 
 88 |     {# SIDE NAV, TOGGLES ON MOBILE #}
 89 |     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
 90 |       <div class="wy-side-scroll">
 91 |         <div class="wy-side-nav-search">
 92 |           {% block sidebartitle %}
 93 | 
 94 |           {% if logo and theme_logo_only %}
 95 |             <a href="{{ pathto(master_doc) }}">
 96 |           {% else %}
 97 |             <a href="{{ pathto(master_doc) }}" class="icon icon-home"> {{ project }}
 98 |           {% endif %}
 99 | 
100 |           {% if logo %}
101 |             {# Not strictly valid HTML, but it's the only way to display/scale
102 |                it properly, without weird scripting or heaps of work
103 |             #}
104 |             <img src="{{ pathto('_static/' + logo, 1) }}" class="logo" alt="Logo"/>
105 |           {% endif %}
106 |           </a>
107 | 
108 |           {% if theme_display_version %}
109 |             {%- set nav_version = version %}
110 |             {% if READTHEDOCS and current_version %}
111 |               {%- set nav_version = current_version %}
112 |             {% endif %}
113 |             {% if nav_version %}
114 |               <div class="version">
115 |                 {{ nav_version }}
116 |               </div>
117 |             {% endif %}
118 |           {% endif %}
119 | 
120 |           {% include "searchbox.html" %}
121 | 
122 |           {% endblock %}
123 |         </div>
124 | 
125 |         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
126 |           {% block menu %}
127 |             {#
128 |               The singlehtml builder doesn't handle this toctree call when the
129 |               toctree is empty. Skip building this for now.
130 |             #}
131 |             {% if 'singlehtml' not in builder %}
132 |               {% set global_toc = toctree(maxdepth=theme_navigation_depth|int,
133 |                                           collapse=theme_collapse_navigation|tobool,
134 |                                           includehidden=theme_includehidden|tobool,
135 |                                           titles_only=theme_titles_only|tobool) %}
136 |             {% endif %}
137 |             {% if global_toc %}
138 |               {{ global_toc }}
139 |             {% else %}
140 |               <!-- Local TOC -->
141 |               <div class="local-toc">{{ toc }}</div>
142 |             {% endif %}
143 |           {% endblock %}
144 |         </div>
145 |       </div>
146 |     </nav>
147 | 
148 |     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
149 | 
150 |       {# MOBILE NAV, TRIGGLES SIDE NAV ON TOGGLE #}
151 |       <nav class="wy-nav-top" aria-label="top navigation">
152 |         {% block mobile_nav %}
153 |           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
154 |           <a href="{{ pathto(master_doc) }}">{{ project }}</a>
155 |         {% endblock %}
156 |       </nav>
157 | 
158 | 
159 |       <div class="wy-nav-content">
160 |       {%- block content %}
161 |         {% if theme_style_external_links|tobool %}
162 |         <div class="rst-content style-external-links">
163 |         {% else %}
164 |         <div class="rst-content">
165 |         {% endif %}
166 |           {% include "breadcrumbs.html" %}
167 |           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
168 |           {%- block document %}
169 |            <div itemprop="articleBody">
170 |             {% block body %}{% endblock %}
171 |            </div>
172 |            {% if self.comments()|trim %}
173 |            <div class="articleComments">
174 |             {% block comments %}{% endblock %}
175 |            </div>
176 |            {% endif%}
177 |           </div>
178 |           {%- endblock %}
179 |           {% include "footer.html" %}
180 |         </div>
181 |       {%- endblock %}
182 |       </div>
183 | 
184 |     </section>
185 | 
186 |   </div>
187 |   {% include "versions.html" %}
188 | 
189 |   {% if not embedded %}
190 | 
191 |     <script type="text/javascript">
192 |         var DOCUMENTATION_OPTIONS = {
193 |             URL_ROOT:'{{ url_root }}',
194 |             VERSION:'{{ release|e }}',
195 |             LANGUAGE:'{{ language }}',
196 |             COLLAPSE_INDEX:false,
197 |             FILE_SUFFIX:'{{ '' if no_search_suffix else file_suffix }}',
198 |             HAS_SOURCE:  {{ has_source|lower }},
199 |             SOURCELINK_SUFFIX: '{{ sourcelink_suffix }}'
200 |         };
201 |     </script>
202 |     {%- for scriptfile in script_files %}
203 |       <script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>
204 |     {%- endfor %}
205 | 
206 |   {% endif %}
207 | 
208 |   <script type="text/javascript" src="{{ pathto('_static/js/theme.js', 1) }}"></script>
209 | 
210 |   <script type="text/javascript">
211 |       jQuery(function () {
212 |           SphinxRtdTheme.Navigation.enable({{ 'true' if theme_sticky_navigation|tobool else 'false' }});
213 |       });
214 |   </script>
215 | 
216 |   {%- block footer %} {% endblock %}
217 | 
218 | </body>
219 | </html>
220 | 


--------------------------------------------------------------------------------
/docs/_themes/sphinx_rtd_theme/search.html:
--------------------------------------------------------------------------------
 1 | {#
 2 |     basic/search.html
 3 |     ~~~~~~~~~~~~~~~~~
 4 | 
 5 |     Template for the search page.
 6 | 
 7 |     :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
 8 |     :license: BSD, see LICENSE for details.
 9 | #}
10 | {%- extends "layout.html" %}
11 | {% set title = _('Search') %}
12 | {% set script_files = script_files + ['_static/searchtools.js'] %}
13 | {% block footer %}
14 |   <script type="text/javascript">
15 |     jQuery(function() { Search.loadIndex("{{ pathto('searchindex.js', 1) }}"); });
16 |   </script>
17 |   {# this is used when loading the search index using $.ajax fails,
18 |      such as on Chrome for documents on localhost #}
19 |   <script type="text/javascript" id="searchindexloader"></script>
20 |   {{ super() }}
21 | {% endblock %}
22 | {% block body %}
23 |   <noscript>
24 |   <div id="fallback" class="admonition warning">
25 |     <p class="last">
26 |       {% trans %}Please activate JavaScript to enable the search
27 |       functionality.{% endtrans %}
28 |     </p>
29 |   </div>
30 |   </noscript>
31 | 
32 |   {% if search_performed %}
33 |     <h2>{{ _('Search Results') }}</h2>
34 |     {% if not search_results %}
35 |       <p>{{ _('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.') }}</p>
36 |     {% endif %}
37 |   {% endif %}
38 |   <div id="search-results">
39 |   {% if search_results %}
40 |     <ul>
41 |     {% for href, caption, context in search_results %}
42 |       <li>
43 |         <a href="{{ pathto(item.href) }}">{{ caption }}</a>
44 |         <p class="context">{{ context|e }}</p>
45 |       </li>
46 |     {% endfor %}
47 |     </ul>
48 |   {% endif %}
49 |   </div>
50 | {% endblock %}
51 | 


--------------------------------------------------------------------------------
/docs/_themes/sphinx_rtd_theme/searchbox.html:
--------------------------------------------------------------------------------
 1 | {%- if builder != 'singlehtml' %}
 2 | <div role="search">
 3 |   <form id="rtd-search-form" class="wy-form" action="{{ pathto('search') }}" method="get">
 4 |     <input type="text" name="q" placeholder="{{ _('Search docs') }}" />
 5 |     <input type="hidden" name="check_keywords" value="yes" />
 6 |     <input type="hidden" name="area" value="default" />
 7 |   </form>
 8 | </div>
 9 | {%- endif %}
10 | 


--------------------------------------------------------------------------------
/docs/_themes/sphinx_rtd_theme/static/css/badge_only.css:
--------------------------------------------------------------------------------
1 | .fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-weight:normal;font-style:normal;src:url("../fonts/fontawesome-webfont.eot");src:url("../fonts/fontawesome-webfont.eot?#iefix") format("embedded-opentype"),url("../fonts/fontawesome-webfont.woff") format("woff"),url("../fonts/fontawesome-webfont.ttf") format("truetype"),url("../fonts/fontawesome-webfont.svg#FontAwesome") format("svg")}.fa:before{display:inline-block;font-family:FontAwesome;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa{display:inline-block;text-decoration:inherit}li .fa{display:inline-block}li .fa-large:before,li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-0.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before,ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before{content:""}.icon-book:before{content:""}.fa-caret-down:before{content:""}.icon-caret-down:before{content:""}.fa-caret-up:before{content:""}.icon-caret-up:before{content:""}.fa-caret-left:before{content:""}.icon-caret-left:before{content:""}.fa-caret-right:before{content:""}.icon-caret-right:before{content:""}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;z-index:400}.rst-versions a{color:#2980B9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27AE60;*zoom:1}.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#E74C3C;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#F1C40F;color:#000}.rst-versions.shift-up{height:auto;max-height:100%}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px}.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge .fa-book{float:none}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge .rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}
2 | 


--------------------------------------------------------------------------------
/docs/_themes/sphinx_rtd_theme/static/fonts/FontAwesome.otf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/socketio/engine.io-server-java/a74a55654ac37bcfa8848ea5dbbbd24adddb8884/docs/_themes/sphinx_rtd_theme/static/fonts/FontAwesome.otf


--------------------------------------------------------------------------------
/docs/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.eot:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/socketio/engine.io-server-java/a74a55654ac37bcfa8848ea5dbbbd24adddb8884/docs/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.eot


--------------------------------------------------------------------------------
/docs/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.ttf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/socketio/engine.io-server-java/a74a55654ac37bcfa8848ea5dbbbd24adddb8884/docs/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.ttf


--------------------------------------------------------------------------------
/docs/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.woff:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/socketio/engine.io-server-java/a74a55654ac37bcfa8848ea5dbbbd24adddb8884/docs/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.woff


--------------------------------------------------------------------------------
/docs/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.woff2:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/socketio/engine.io-server-java/a74a55654ac37bcfa8848ea5dbbbd24adddb8884/docs/_themes/sphinx_rtd_theme/static/fonts/fontawesome-webfont.woff2


--------------------------------------------------------------------------------
/docs/_themes/sphinx_rtd_theme/static/js/theme.js:
--------------------------------------------------------------------------------
1 | /* sphinx_rtd_theme version 0.4.1 | MIT license */
2 | /* Built 20180727 10:07 */
3 | require=function n(e,i,t){function o(s,a){if(!i[s]){if(!e[s]){var l="function"==typeof require&&require;if(!a&&l)return l(s,!0);if(r)return r(s,!0);var c=new Error("Cannot find module '"+s+"'");throw c.code="MODULE_NOT_FOUND",c}var u=i[s]={exports:{}};e[s][0].call(u.exports,function(n){var i=e[s][1][n];return o(i||n)},u,u.exports,n,e,i,t)}return i[s].exports}for(var r="function"==typeof require&&require,s=0;s<t.length;s++)o(t[s]);return o}({"sphinx-rtd-theme":[function(n,e,i){var jQuery="undefined"!=typeof window?window.jQuery:n("jquery");e.exports.ThemeNav={navBar:null,win:null,winScroll:!1,winResize:!1,linkScroll:!1,winPosition:0,winHeight:null,docHeight:null,isRunning:!1,enable:function(n){var e=this;void 0===n&&(n=!0),e.isRunning||(e.isRunning=!0,jQuery(function(i){e.init(i),e.reset(),e.win.on("hashchange",e.reset),n&&e.win.on("scroll",function(){e.linkScroll||e.winScroll||(e.winScroll=!0,requestAnimationFrame(function(){e.onScroll()}))}),e.win.on("resize",function(){e.winResize||(e.winResize=!0,requestAnimationFrame(function(){e.onResize()}))}),e.onResize()}))},enableSticky:function(){this.enable(!0)},init:function(n){n(document);var e=this;this.navBar=n("div.wy-side-scroll:first"),this.win=n(window),n(document).on("click","[data-toggle='wy-nav-top']",function(){n("[data-toggle='wy-nav-shift']").toggleClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift")}).on("click",".wy-menu-vertical .current ul li a",function(){var i=n(this);n("[data-toggle='wy-nav-shift']").removeClass("shift"),n("[data-toggle='rst-versions']").toggleClass("shift"),e.toggleCurrent(i),e.hashChange()}).on("click","[data-toggle='rst-current-version']",function(){n("[data-toggle='rst-versions']").toggleClass("shift-up")}),n("table.docutils:not(.field-list,.footnote,.citation)").wrap("<div class='wy-table-responsive'></div>"),n("table.docutils.footnote").wrap("<div class='wy-table-responsive footnote'></div>"),n("table.docutils.citation").wrap("<div class='wy-table-responsive citation'></div>"),n(".wy-menu-vertical ul").not(".simple").siblings("a").each(function(){var i=n(this);expand=n('<span class="toctree-expand"></span>'),expand.on("click",function(n){return e.toggleCurrent(i),n.stopPropagation(),!1}),i.prepend(expand)})},reset:function(){var n=encodeURI(window.location.hash)||"#";try{var e=$(".wy-menu-vertical"),i=e.find('[href="'+n+'"]');if(0===i.length){var t=$('.document [id="'+n.substring(1)+'"]').closest("div.section");0===(i=e.find('[href="#'+t.attr("id")+'"]')).length&&(i=e.find('[href="#"]'))}i.length>0&&($(".wy-menu-vertical .current").removeClass("current"),i.addClass("current"),i.closest("li.toctree-l1").addClass("current"),i.closest("li.toctree-l1").parent().addClass("current"),i.closest("li.toctree-l1").addClass("current"),i.closest("li.toctree-l2").addClass("current"),i.closest("li.toctree-l3").addClass("current"),i.closest("li.toctree-l4").addClass("current"))}catch(o){console.log("Error expanding nav for anchor",o)}},onScroll:function(){this.winScroll=!1;var n=this.win.scrollTop(),e=n+this.winHeight,i=this.navBar.scrollTop()+(n-this.winPosition);n<0||e>this.docHeight||(this.navBar.scrollTop(i),this.winPosition=n)},onResize:function(){this.winResize=!1,this.winHeight=this.win.height(),this.docHeight=$(document).height()},hashChange:function(){this.linkScroll=!0,this.win.one("hashchange",function(){this.linkScroll=!1})},toggleCurrent:function(n){var e=n.closest("li");e.siblings("li.current").removeClass("current"),e.siblings().find("li.current").removeClass("current"),e.find("> ul li.current").removeClass("current"),e.toggleClass("current")}},"undefined"!=typeof window&&(window.SphinxRtdTheme={Navigation:e.exports.ThemeNav,StickyNav:e.exports.ThemeNav}),function(){for(var n=0,e=["ms","moz","webkit","o"],i=0;i<e.length&&!window.requestAnimationFrame;++i)window.requestAnimationFrame=window[e[i]+"RequestAnimationFrame"],window.cancelAnimationFrame=window[e[i]+"CancelAnimationFrame"]||window[e[i]+"CancelRequestAnimationFrame"];window.requestAnimationFrame||(window.requestAnimationFrame=function(e,i){var t=(new Date).getTime(),o=Math.max(0,16-(t-n)),r=window.setTimeout(function(){e(t+o)},o);return n=t+o,r}),window.cancelAnimationFrame||(window.cancelAnimationFrame=function(n){clearTimeout(n)})}()},{jquery:"jquery"}]},{},["sphinx-rtd-theme"]);


--------------------------------------------------------------------------------
/docs/_themes/sphinx_rtd_theme/theme.conf:
--------------------------------------------------------------------------------
 1 | [theme]
 2 | inherit = basic
 3 | stylesheet = css/theme.css
 4 | pygments_style = default
 5 | 
 6 | [options]
 7 | canonical_url =
 8 | analytics_id =
 9 | collapse_navigation = True
10 | sticky_navigation = True
11 | navigation_depth = 4
12 | includehidden = True
13 | titles_only = 
14 | logo_only =
15 | display_version = True
16 | prev_next_buttons_location = bottom
17 | style_external_links = False
18 | 


--------------------------------------------------------------------------------
/docs/_themes/sphinx_rtd_theme/versions.html:
--------------------------------------------------------------------------------
 1 | {% if READTHEDOCS %}
 2 | {# Add rst-badge after rst-versions for small badge style. #}
 3 |   <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
 4 |     <span class="rst-current-version" data-toggle="rst-current-version">
 5 |       <span class="fa fa-book"> Read the Docs</span>
 6 |       v: {{ current_version }}
 7 |       <span class="fa fa-caret-down"></span>
 8 |     </span>
 9 |     <div class="rst-other-versions">
10 |       <dl>
11 |         <dt>{{ _('Versions') }}</dt>
12 |         {% for slug, url in versions %}
13 |           <dd><a href="{{ url }}">{{ slug }}</a></dd>
14 |         {% endfor %}
15 |       </dl>
16 |       <dl>
17 |         <dt>{{ _('Downloads') }}</dt>
18 |         {% for type, url in downloads %}
19 |           <dd><a href="{{ url }}">{{ type }}</a></dd>
20 |         {% endfor %}
21 |       </dl>
22 |       <dl>
23 |         <dt>{{ _('On Read the Docs') }}</dt>
24 |           <dd>
25 |             <a href="//{{ PRODUCTION_DOMAIN }}/projects/{{ slug }}/?fromdocs={{ slug }}">{{ _('Project Home') }}</a>
26 |           </dd>
27 |           <dd>
28 |             <a href="//{{ PRODUCTION_DOMAIN }}/builds/{{ slug }}/?fromdocs={{ slug }}">{{ _('Builds') }}</a>
29 |           </dd>
30 |       </dl>
31 |       <hr/>
32 |       {% trans %}Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.{% endtrans %}
33 | 
34 |     </div>
35 |   </div>
36 | {% endif %}
37 | 
38 | 


--------------------------------------------------------------------------------
/docs/api.rst:
--------------------------------------------------------------------------------
  1 | ===
  2 | API
  3 | ===
  4 | 
  5 | .. contents:: Table of Contents
  6 |    :local:
  7 | 
  8 | EngineIoServer
  9 | ==============
 10 | 
 11 | The ``EngineIoServer`` class contains the logic for accepting and handling
 12 | connections from the client.
 13 | 
 14 | Methods
 15 | -------
 16 | 
 17 | handleRequest
 18 | ^^^^^^^^^^^^^
 19 | 
 20 | Call this method to handle an incoming HTTP request.
 21 | 
 22 | handleWebSocket
 23 | ^^^^^^^^^^^^^^^
 24 | 
 25 | Call this method to handle an incoming WebSocket request.
 26 | 
 27 | Events
 28 | ------
 29 | 
 30 | ``EngineIoServer`` emits the following events:
 31 | 
 32 | connection
 33 | ^^^^^^^^^^
 34 | 
 35 | This event is emitted when a new client successfully connects to the server.
 36 | 
 37 | **Arguments**
 38 | 
 39 | 0. ``EngineIoSocket`` object
 40 | 
 41 | EngineIoSocket
 42 | ==============
 43 | 
 44 | The ``EngineIoSocket`` class represents one connection to a remote client.
 45 | 
 46 | Methods
 47 | -------
 48 | 
 49 | send
 50 | ^^^^
 51 | 
 52 | Call this method on a connected ``EngineIoSocket`` instance to queue a packet for sending to
 53 | remote client.
 54 | This method is thread safe.
 55 | 
 56 | close
 57 | ^^^^^
 58 | 
 59 | Call this method to close the connection with the remote socket.
 60 | 
 61 | Events
 62 | ------
 63 | 
 64 | ``EngineIoSocket`` emits the following events:
 65 | 
 66 | open
 67 | ^^^^
 68 | 
 69 | This event is emitted when a connection is established.
 70 | 
 71 | **Note** This event cannot be trapped as it occurs before the "connection" event of ``EngineIoServer``.
 72 | 
 73 | close
 74 | ^^^^^
 75 | 
 76 | This event is emitted when the socket is closed either by the server or the client.
 77 | 
 78 | **Arguments**
 79 | 
 80 | 0. ``String`` indicating reason for close
 81 | 1. ``String`` indicating description of reason or ``null``
 82 | 
 83 | packet
 84 | ^^^^^^
 85 | 
 86 | This event is emitted when a packet is received from the remote client.
 87 | 
 88 | **Arguments**
 89 | 
 90 | 0. ``Packet`` object
 91 | 
 92 | heartbeat
 93 | ^^^^^^^^^
 94 | 
 95 | This event is emitted when a *ping* packet is received from the remote client.
 96 | 
 97 | message
 98 | ^^^^^^^
 99 | 
100 | This event is emitted when a *message* packet is received from the remote client.
101 | 
102 | **Arguments**
103 | 
104 | 0. ``String`` or ``byte[]`` object sent by the remote client
105 | 
106 | data
107 | ^^^^
108 | 
109 | Same as ``message`` event.
110 | 
111 | flush
112 | ^^^^^
113 | 
114 | This event is raised just before sending packets to the remote client.
115 | 
116 | **Arguments**
117 | 
118 | 0. ``Collection<Packet<?>>`` being sent to the client
119 | 
120 | drain
121 | ^^^^^
122 | 
123 | This event is raised after queued packets have been sent to the remote client.
124 | 
125 | Sending Data
126 | ------------
127 | 
128 | Use the ``send`` method on ``EngineIoSocket`` to send packets to the remote client.
129 | Queuing of packets in case of polling transport are handled internally by ``EngineIoSocket``.
130 | 
131 | For example::
132 | 
133 |     EngineIoSocket socket;  // connected socket
134 |     socket.send(new Packet<>(Packet.MESSAGE, "foo"));
135 | 
136 | Receiving Data
137 | --------------
138 | 
139 | Listen on either the *message* or *data* event to receive data from the remote client.


--------------------------------------------------------------------------------
/docs/conf.py:
--------------------------------------------------------------------------------
  1 | # -*- coding: utf-8 -*-
  2 | #
  3 | # Configuration file for the Sphinx documentation builder.
  4 | #
  5 | # This file does only contain a selection of the most common options. For a
  6 | # full list see the documentation:
  7 | # http://www.sphinx-doc.org/en/master/config
  8 | 
  9 | # -- Path setup --------------------------------------------------------------
 10 | 
 11 | # If extensions (or modules to document with autodoc) are in another directory,
 12 | # add these directories to sys.path here. If the directory is relative to the
 13 | # documentation root, use os.path.abspath to make it absolute, like shown here.
 14 | #
 15 | # import os
 16 | # import sys
 17 | # sys.path.insert(0, os.path.abspath('.'))
 18 | 
 19 | 
 20 | # -- Project information -----------------------------------------------------
 21 | 
 22 | project = u'Engine.IO Java Server'
 23 | copyright = u'2018, Trinopoty Biswas'
 24 | author = u'Trinopoty Biswas'
 25 | 
 26 | # The short X.Y version
 27 | version = u''
 28 | # The full version, including alpha/beta/rc tags
 29 | release = u''
 30 | 
 31 | 
 32 | # -- General configuration ---------------------------------------------------
 33 | 
 34 | # If your documentation needs a minimal Sphinx version, state it here.
 35 | #
 36 | # needs_sphinx = '1.0'
 37 | 
 38 | # Add any Sphinx extension module names here, as strings. They can be
 39 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 40 | # ones.
 41 | extensions = [
 42 |     'sphinx.ext.todo',
 43 |     'sphinx.ext.githubpages',
 44 | ]
 45 | 
 46 | # Add any paths that contain templates here, relative to this directory.
 47 | templates_path = ['_templates']
 48 | 
 49 | # The suffix(es) of source filenames.
 50 | # You can specify multiple suffix as a list of string:
 51 | #
 52 | # source_suffix = ['.rst', '.md']
 53 | source_suffix = '.rst'
 54 | 
 55 | # The master toctree document.
 56 | master_doc = 'index'
 57 | 
 58 | # The language for content autogenerated by Sphinx. Refer to documentation
 59 | # for a list of supported languages.
 60 | #
 61 | # This is also used if you do content translation via gettext catalogs.
 62 | # Usually you set "language" from the command line for these cases.
 63 | language = None
 64 | 
 65 | # List of patterns, relative to source directory, that match files and
 66 | # directories to ignore when looking for source files.
 67 | # This pattern also affects html_static_path and html_extra_path .
 68 | exclude_patterns = [u'_build', 'Thumbs.db', '.DS_Store']
 69 | 
 70 | # The name of the Pygments (syntax highlighting) style to use.
 71 | pygments_style = 'sphinx'
 72 | 
 73 | 
 74 | # -- Options for HTML output -------------------------------------------------
 75 | 
 76 | # The theme to use for HTML and HTML Help pages.  See the documentation for
 77 | # a list of builtin themes.
 78 | #
 79 | html_theme = 'sphinx_rtd_theme'
 80 | html_theme_path = ['_themes']
 81 | 
 82 | # Theme options are theme-specific and customize the look and feel of a theme
 83 | # further.  For a list of options available for each theme, see the
 84 | # documentation.
 85 | #
 86 | # html_theme_options = {}
 87 | 
 88 | # Add any paths that contain custom static files (such as style sheets) here,
 89 | # relative to this directory. They are copied after the builtin static files,
 90 | # so a file named "default.css" will overwrite the builtin "default.css".
 91 | html_static_path = ['_static']
 92 | 
 93 | # Custom sidebar templates, must be a dictionary that maps document names
 94 | # to template names.
 95 | #
 96 | # The default sidebars (for documents that don't match any pattern) are
 97 | # defined by theme itself.  Builtin themes are using these templates by
 98 | # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
 99 | # 'searchbox.html']``.
100 | #
101 | # html_sidebars = {}
102 | 
103 | 
104 | # -- Options for HTMLHelp output ---------------------------------------------
105 | 
106 | # Output file base name for HTML help builder.
107 | htmlhelp_basename = 'EngineIOdoc'
108 | 
109 | 
110 | # -- Options for LaTeX output ------------------------------------------------
111 | 
112 | latex_elements = {
113 |     # The paper size ('letterpaper' or 'a4paper').
114 |     #
115 |     # 'papersize': 'letterpaper',
116 | 
117 |     # The font size ('10pt', '11pt' or '12pt').
118 |     #
119 |     # 'pointsize': '10pt',
120 | 
121 |     # Additional stuff for the LaTeX preamble.
122 |     #
123 |     # 'preamble': '',
124 | 
125 |     # Latex figure (float) alignment
126 |     #
127 |     # 'figure_align': 'htbp',
128 | }
129 | 
130 | # Grouping the document tree into LaTeX files. List of tuples
131 | # (source start file, target name, title,
132 | #  author, documentclass [howto, manual, or own class]).
133 | latex_documents = [
134 |     (master_doc, 'EngineIO.tex', u'Engine.IO Documentation',
135 |      u'Trinopoty Biswas', 'manual'),
136 | ]
137 | 
138 | 
139 | # -- Options for manual page output ------------------------------------------
140 | 
141 | # One entry per manual page. List of tuples
142 | # (source start file, name, description, authors, manual section).
143 | man_pages = [
144 |     (master_doc, 'engineio', u'Engine.IO Documentation',
145 |      [author], 1)
146 | ]
147 | 
148 | 
149 | # -- Options for Texinfo output ----------------------------------------------
150 | 
151 | # Grouping the document tree into Texinfo files. List of tuples
152 | # (source start file, target name, title, author,
153 | #  dir menu entry, description, category)
154 | texinfo_documents = [
155 |     (master_doc, 'EngineIO', u'Engine.IO Documentation',
156 |      author, 'EngineIO', 'One line description of project.',
157 |      'Miscellaneous'),
158 | ]
159 | 
160 | 
161 | # -- Extension configuration -------------------------------------------------
162 | 
163 | # -- Options for todo extension ----------------------------------------------
164 | 
165 | # If true, `todo` and `todoList` produce output, else they produce nothing.
166 | todo_include_todos = True
167 | 


--------------------------------------------------------------------------------
/docs/index.rst:
--------------------------------------------------------------------------------
 1 | .. Engine.IO documentation master file, created by
 2 |    sphinx-quickstart on Thu Aug  9 18:55:12 2018.
 3 |    You can adapt this file completely to your liking, but it should at least
 4 |    contain the root `toctree` directive.
 5 | 
 6 | Welcome to Engine.IO Java Server's documentation!
 7 | =================================================
 8 | 
 9 | .. toctree::
10 |    :maxdepth: 1
11 |    :caption: Contents:
12 | 
13 |    install
14 |    using
15 |    api
16 |    spring-integration
17 |    javadocs/index
18 | 


--------------------------------------------------------------------------------
/docs/install.rst:
--------------------------------------------------------------------------------
 1 | ============
 2 | Installation
 3 | ============
 4 | 
 5 | The latest artifact is available on Maven Central.
 6 | 
 7 | Engine.IO Java Server Library
 8 | =============================
 9 | 
10 | Maven
11 | -----
12 | 
13 | Add the following dependency to your ``pom.xml``.::
14 | 
15 |     <dependencies>
16 |       <dependency>
17 |         <groupId>io.socket</groupId>
18 |         <artifactId>engine.io-server</artifactId>
19 |         <version>6.2.1</version>
20 |       </dependency>
21 |     </dependencies>
22 | 
23 | Gradle
24 | ------
25 | 
26 | Add it as a gradle dependency in ``build.gradle``.::
27 | 
28 |     implementation ('io.socket:engine.io-server:6.2.1')
29 | 


--------------------------------------------------------------------------------
/docs/javadocs/index.rst:
--------------------------------------------------------------------------------
1 | ========
2 | Javadocs
3 | ========
4 | 


--------------------------------------------------------------------------------
/docs/requirements.txt:
--------------------------------------------------------------------------------
1 | sphinx
2 | sphinx-autobuild
3 | 


--------------------------------------------------------------------------------
/docs/spring-integration.rst:
--------------------------------------------------------------------------------
  1 | ==================
  2 | Spring Integration
  3 | ==================
  4 | 
  5 | This guide describes how to configure engine.io with Spring Framework and Spring Boot.
  6 | 
  7 | Add a class to contain the bulk of engine.io handling code::
  8 | 
  9 |     import io.socket.engineio.server.EngineIoServer;
 10 |     import io.socket.engineio.server.EngineIoWebSocket;
 11 |     import io.socket.engineio.server.utils.ParseQS;
 12 |     import org.springframework.http.server.ServerHttpRequest;
 13 |     import org.springframework.http.server.ServerHttpResponse;
 14 |     import org.springframework.stereotype.Controller;
 15 |     import org.springframework.web.bind.annotation.RequestMapping;
 16 |     import org.springframework.web.bind.annotation.RequestMethod;
 17 |     import org.springframework.web.socket.*;
 18 |     import org.springframework.web.socket.server.HandshakeInterceptor;
 19 | 
 20 |     import jakarta.servlet.http.HttpServletRequest;
 21 |     import jakarta.servlet.http.HttpServletResponse;
 22 |     import java.io.IOException;
 23 |     import java.util.HashMap;
 24 |     import java.util.Map;
 25 | 
 26 |     @Controller
 27 |     public final class EngineIoHandler implements HandshakeInterceptor, WebSocketHandler {
 28 | 
 29 |         private static final String ATTRIBUTE_ENGINEIO_BRIDGE = "engineIo.bridge";
 30 |         private static final String ATTRIBUTE_ENGINEIO_QUERY = "engineIo.query";
 31 |         private static final String ATTRIBUTE_ENGINEIO_HEADERS = "engineIo.headers";
 32 | 
 33 |         private final EngineIoServer mEngineIoServer;
 34 | 
 35 |         public EngineIoHandler(EngineIoServer engineIoServer) {
 36 |             mEngineIoServer = engineIoServer;
 37 |         }
 38 | 
 39 |         @RequestMapping(
 40 |                 value = "/engine.io/",
 41 |                 method = {RequestMethod.GET, RequestMethod.POST, RequestMethod.OPTIONS},
 42 |                 headers = "connection!=upgrade")
 43 |         public void httpHandler(HttpServletRequest request, HttpServletResponse response) throws IOException {
 44 |             mEngineIoServer.handleRequest(request, response);
 45 |         }
 46 | 
 47 |         /* HandshakeInterceptor */
 48 | 
 49 |         @Override
 50 |         public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Map<String, Object> attributes) {
 51 |             attributes.put(ATTRIBUTE_ENGINEIO_QUERY, request.getURI().getQuery());
 52 |             attributes.put(ATTRIBUTE_ENGINEIO_HEADERS, request.getHeaders());
 53 |             return true;
 54 |         }
 55 | 
 56 |         @Override
 57 |         public void afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Exception exception) {
 58 |         }
 59 | 
 60 |         /* WebSocketHandler */
 61 | 
 62 |         @Override
 63 |         public boolean supportsPartialMessages() {
 64 |             return false;
 65 |         }
 66 | 
 67 |         @Override
 68 |         public void afterConnectionEstablished(WebSocketSession webSocketSession) {
 69 |             final EngineIoSpringWebSocket webSocket = new EngineIoSpringWebSocket(webSocketSession);
 70 |             webSocketSession.getAttributes().put(ATTRIBUTE_ENGINEIO_BRIDGE, webSocket);
 71 |             mEngineIoServer.handleWebSocket(webSocket);
 72 |         }
 73 | 
 74 |         @Override
 75 |         public void afterConnectionClosed(WebSocketSession webSocketSession, CloseStatus closeStatus) {
 76 |             ((EngineIoSpringWebSocket)webSocketSession.getAttributes().get(ATTRIBUTE_ENGINEIO_BRIDGE))
 77 |                     .afterConnectionClosed(closeStatus);
 78 |         }
 79 | 
 80 |         @Override
 81 |         public void handleMessage(WebSocketSession webSocketSession, WebSocketMessage<?> webSocketMessage) {
 82 |             ((EngineIoSpringWebSocket)webSocketSession.getAttributes().get(ATTRIBUTE_ENGINEIO_BRIDGE))
 83 |                     .handleMessage(webSocketMessage);
 84 |         }
 85 | 
 86 |         @Override
 87 |         public void handleTransportError(WebSocketSession webSocketSession, Throwable throwable) {
 88 |             ((EngineIoSpringWebSocket)webSocketSession.getAttributes().get(ATTRIBUTE_ENGINEIO_BRIDGE))
 89 |                     .handleTransportError(throwable);
 90 |         }
 91 | 
 92 |         private static final class EngineIoSpringWebSocket extends EngineIoWebSocket {
 93 | 
 94 |             private final WebSocketSession mSession;
 95 |             private final Map<String, String> mQuery;
 96 |             private final Map<String, List<String>> mHeaders;
 97 | 
 98 |             EngineIoSpringWebSocket(WebSocketSession session) {
 99 |                 mSession = session;
100 | 
101 |                 final String queryString = (String)mSession.getAttributes().get(ATTRIBUTE_ENGINEIO_QUERY);
102 |                 if (queryString != null) {
103 |                     mQuery = ParseQS.decode(queryString);
104 |                 } else {
105 |                     mQuery = new HashMap<>();
106 |                 }
107 |                 this.mHeaders = (Map<String, List<String>>) mSession.getAttributes().get(ATTRIBUTE_ENGINEIO_HEADERS);
108 |             }
109 | 
110 |             /* EngineIoWebSocket */
111 | 
112 |             @Override
113 |             public Map<String, String> getQuery() {
114 |                 return mQuery;
115 |             }
116 | 
117 |             @Override
118 |             public Map<String, List<String>> getConnectionHeaders() {
119 |                 return mHeaders;
120 |             }
121 | 
122 |             @Override
123 |             public void write(String message) throws IOException {
124 |                 mSession.sendMessage(new TextMessage(message));
125 |             }
126 | 
127 |             @Override
128 |             public void write(byte[] message) throws IOException {
129 |                 mSession.sendMessage(new BinaryMessage(message));
130 |             }
131 | 
132 |             @Override
133 |             public void close() {
134 |                 try {
135 |                     mSession.close();
136 |                 } catch (IOException ignore) {
137 |                 }
138 |             }
139 | 
140 |             /* WebSocketHandler */
141 | 
142 |             void afterConnectionClosed(CloseStatus closeStatus) {
143 |                 emit("close");
144 |             }
145 | 
146 |             void handleMessage(WebSocketMessage<?> message) {
147 |                 if (message.getPayload() instanceof String || message.getPayload() instanceof byte[]) {
148 |                     emit("message", (Object) message.getPayload());
149 |                 } else {
150 |                     throw new RuntimeException(String.format(
151 |                             "Invalid message type received: %s. Expected String or byte[].",
152 |                             message.getPayload().getClass().getName()));
153 |                 }
154 |             }
155 | 
156 |             void handleTransportError(Throwable exception) {
157 |                 emit("error", "write error", exception.getMessage());
158 |             }
159 |         }
160 |     }
161 | 
162 | **NOTE** If this class is discovered/instantiated multiple times, it may cause problems so place it accordingly.
163 | 
164 | Next, add bean declarations for the engine.io server::
165 | 
166 |     <bean id="engineIoServer" class="io.socket.engineio.server.EngineIoServer" />
167 | 
168 | Next, add websocket handling for engine.io server in XML::
169 | 
170 |     <websocket:handlers>
171 |         <websocket:mapping path="/engine.io/" handler="engineIoHandler" />
172 | 
173 |         <websocket:handshake-interceptors>
174 |             <beans:ref bean="engineIoHandler" />
175 |         </websocket:handshake-interceptors>
176 |     </websocket:handlers>
177 | 
178 | Or in Java::
179 | 
180 |     @Configuration
181 |     @EnableWebSocket
182 |     public class EngineIoConfigurator implements WebSocketConfigurer {
183 |     
184 |         private final EngineIoHandler mEngineIoHandler;
185 |     
186 |         public EngineIoConfigurator(EngineIoHandler engineIoHandler) {
187 |             mEngineIoHandler = engineIoHandler;
188 |         }
189 |     
190 |         @Override
191 |         public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
192 |             registry.addHandler(mEngineIoHandler, "/engine.io/")
193 |                     .addInterceptors(mEngineIoHandler);
194 |         }
195 |     }
196 | 
197 | This serves as a gateway for engine.io and is same for all other server that builds on top of engine.io, viz. Socket.io .
198 | 


--------------------------------------------------------------------------------
/docs/using.rst:
--------------------------------------------------------------------------------
  1 | ===============
  2 | Getting Started
  3 | ===============
  4 | 
  5 | Create a servlet for handling incoming HTTP connections and call
  6 | ``EngineIoServer`` class's ``handleRequest`` method on receiving an HTTP
  7 | request.
  8 | 
  9 | Example servlet
 10 | ===============
 11 | Example servlet class::
 12 | 
 13 |     @WebServlet("/engine.io/*")
 14 |     public class EngineIoServlet extends HttpServlet {
 15 | 
 16 |         private final EngineIoServer mEngineIoServer = new EngineIoServer();
 17 | 
 18 |         @Override
 19 |         protected void service(HttpServletRequest request, HttpServletResponse response) throws IOException {
 20 |             mEngineIoServer.handleRequest(request, response);
 21 |         }
 22 |     }
 23 | 
 24 | In the example servlet above, a static instance of ``EngineIoServer`` is defined and
 25 | the method ``service`` is overridden to call ``handleRequest``.
 26 | 
 27 | Listening for connections
 28 | =========================
 29 | 
 30 | Attach a listener to the ``connection`` event of ``EngineIoServer`` to listen for
 31 | new connections.
 32 | 
 33 | Example::
 34 | 
 35 |     server.on("connection", new Emitter.Listener() {
 36 |         @Override
 37 |         public void call(Object... args) {
 38 |             EngineIoSocket socket = (EngineIoSocket) args[0];
 39 |             // Do something with socket
 40 |         }
 41 |     });
 42 | 
 43 | Listening for message from client
 44 | =================================
 45 | 
 46 | Attach a listener to the ``message`` event of ``EngineIoSocket`` to listen for
 47 | messages from client.
 48 | 
 49 | Example::
 50 | 
 51 |     socket.on("message", new Emitter.Listener() {
 52 |         @Override
 53 |         public void call(Object... args) {
 54 |             Object message = args[0];
 55 |             // message can be either String or byte[]
 56 |             // Do something with message.
 57 |         }
 58 |     });
 59 | 
 60 | Sending message to client
 61 | =========================
 62 | 
 63 | Call the ``send`` method on ``EngineIoSocket`` to send packet to remote client.
 64 | 
 65 | Example::
 66 | 
 67 |     socket.send(new Packet<>(Packet.MESSAGE, "foo"));
 68 | 
 69 | WebSocket connections
 70 | =====================
 71 | 
 72 | Handling WebSocket connections involves creating an instance of ``EngineIoWebSocket`` and
 73 | passing it in a call to ``handleWebSocket`` method of ``EngineIoServer``. The process to do
 74 | this is different for each server (*viz.* Tomcat, Jetty).
 75 | 
 76 | Generic server
 77 | --------------
 78 | 
 79 | Add an endpoint like the following::
 80 | 
 81 |     public final class EngineIoEndpoint extends Endpoint {
 82 | 
 83 |         private Session mSession;
 84 |         private Map<String, String> mQuery;
 85 |         private EngineIoWebSocket mEngineIoWebSocket;
 86 |         
 87 |         private EngineIoServer mEngineIoServer; // The engine.io server instance
 88 | 
 89 |         @Override
 90 |         public void onOpen(Session session, EndpointConfig endpointConfig) {
 91 |             mSession = session;
 92 |             mQuery = ParseQS.decode(session.getQueryString());
 93 | 
 94 |             mEngineIoWebSocket = new EngineIoWebSocketImpl();
 95 | 
 96 |             /*
 97 |              * These cannot be converted to lambda because of runtime type inference
 98 |              * by server.
 99 |              */
100 |             mSession.addMessageHandler(new MessageHandler.Whole<String>() {
101 |                 @Override
102 |                 public void onMessage(String message) {
103 |                     mEngineIoWebSocket.emit("message", message);
104 |                 }
105 |             });
106 |             mSession.addMessageHandler(new MessageHandler.Whole<byte[]>() {
107 |                 @Override
108 |                 public void onMessage(byte[] message) {
109 |                     mEngineIoWebSocket.emit("message", (Object)message);
110 |                 }
111 |             });
112 | 
113 |             mEngineIoServer.handleWebSocket(mEngineIoWebSocket);
114 |         }
115 | 
116 |         @Override
117 |         public void onClose(Session session, CloseReason closeReason) {
118 |             super.onClose(session, closeReason);
119 | 
120 |             mEngineIoWebSocket.emit("close");
121 |             mSession = null;
122 |         }
123 | 
124 |         @Override
125 |         public void onError(Session session, Throwable thr) {
126 |             super.onError(session, thr);
127 | 
128 |             mEngineIoWebSocket.emit("error", "unknown error", thr.getMessage());
129 |         }
130 |         
131 |         private class EngineIoWebSocketImpl extends EngineIoWebSocket {
132 | 
133 |             private RemoteEndpoint.Basic mBasic;
134 | 
135 |             EngineIoWebSocketImpl() {
136 |                 mBasic = mSession.getBasicRemote();
137 |             }
138 | 
139 |             @Override
140 |             public Map<String, String> getQuery() {
141 |                 return mQuery;
142 |             }
143 | 
144 |             @Override
145 |             public void write(String message) throws IOException {
146 |                 mBasic.sendText(message);
147 |             }
148 | 
149 |             @Override
150 |             public void write(byte[] message) throws IOException {
151 |                 mBasic.sendBinary(ByteBuffer.wrap(message));
152 |             }
153 | 
154 |             @Override
155 |             public void close() {
156 |                 try {
157 |                     mSession.close();
158 |                 } catch (IOException ignore) {
159 |                 }
160 |             }
161 |         }
162 |     }
163 | 
164 | The endpoint can be registered by annotation or a ``ServerApplicationConfig``
165 | class like the following::
166 | 
167 |     public final class ApplicationServerConfig implements ServerApplicationConfig {
168 | 
169 |         @Override
170 |         public Set<ServerEndpointConfig> getEndpointConfigs(Set<Class<? extends Endpoint>> endpointClasses) {
171 |             final HashSet<ServerEndpointConfig> result = new HashSet<>();
172 |             result.add(ServerEndpointConfig.Builder
173 |                     .create(EngineIoEndpoint.class, "/engine.io/")
174 |                     .build());
175 | 
176 |             return result;
177 |         }
178 | 
179 |         @Override
180 |         public Set<Class<?>> getAnnotatedEndpointClasses(Set<Class<?>> scanned) {
181 |             return null;
182 |         }
183 |     }
184 | 
185 | Async Polling
186 | =============
187 | 
188 | To enable async polling, mark the servlet with ``asyncSupported`` set to ``true``.
189 | This can be done with annotations as ``@WebServlet(value = "/engine.io/*", asyncSupported = true)``.
190 | Or with XML as ``<async-supported>true</async-supported>``.
191 | Enabling async is recommended as the server is bombarded with GET requests if async is disabled.
192 | 


--------------------------------------------------------------------------------
/engine.io-server-coverage/pom.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <project xmlns="http://maven.apache.org/POM/4.0.0"
 3 |          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 4 |          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 5 |     <modelVersion>4.0.0</modelVersion>
 6 |     <parent>
 7 |         <artifactId>engine.io-server-bom</artifactId>
 8 |         <groupId>io.socket</groupId>
 9 |         <version>6.3.2</version>
10 |     </parent>
11 | 
12 |     <artifactId>engine.io-server-coverage</artifactId>
13 | 
14 |     <properties>
15 |         <maven.deploy.skip>true</maven.deploy.skip>
16 |         <maven.install.skip>true</maven.install.skip>
17 |     </properties>
18 | 
19 |     <dependencies>
20 |         <dependency>
21 |             <groupId>io.socket</groupId>
22 |             <artifactId>engine.io-server</artifactId>
23 |         </dependency>
24 |     </dependencies>
25 | 
26 |     <build>
27 |         <plugins>
28 |             <plugin>
29 |                 <groupId>org.apache.maven.plugins</groupId>
30 |                 <artifactId>maven-surefire-plugin</artifactId>
31 |                 <version>3.1.2</version>
32 |                 <configuration>
33 |                     <argLine>${argLine} -Dfile.encoding=UTF-8</argLine>
34 |                     <systemPropertyVariables>
35 |                         <java.util.logging.config.file>./src/test/resources/logging.properties</java.util.logging.config.file>
36 |                     </systemPropertyVariables>
37 |                     <parallel>both</parallel>
38 |                     <useUnlimitedThreads>true</useUnlimitedThreads>
39 |                 </configuration>
40 |             </plugin>
41 |             <plugin>
42 |                 <groupId>org.jacoco</groupId>
43 |                 <artifactId>jacoco-maven-plugin</artifactId>
44 |                 <version>0.8.10</version>
45 |                 <executions>
46 |                     <execution>
47 |                         <id>prepare-agent</id>
48 |                         <goals>
49 |                             <goal>prepare-agent</goal>
50 |                         </goals>
51 |                     </execution>
52 |                     <execution>
53 |                         <id>report</id>
54 |                         <phase>test</phase>
55 |                         <goals>
56 |                             <goal>report-aggregate</goal>
57 |                         </goals>
58 |                         <configuration>
59 |                             <title>JaCoCo</title>
60 |                             <footer>Code Coverage Report for JaCoCo ${project.version}</footer>
61 |                             <formats></formats>
62 |                             <includes>
63 |                                 <include>**/*.class</include>
64 |                             </includes>
65 |                         </configuration>
66 |                     </execution>
67 |                 </executions>
68 |             </plugin>
69 |         </plugins>
70 |     </build>
71 | </project>


--------------------------------------------------------------------------------
/engine.io-server-test/pom.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8"?>
  2 | <project xmlns="http://maven.apache.org/POM/4.0.0">
  3 |     <modelVersion>4.0.0</modelVersion>
  4 |     <parent>
  5 |         <groupId>io.socket</groupId>
  6 |         <artifactId>engine.io-server-bom</artifactId>
  7 |         <version>6.3.2</version>
  8 |     </parent>
  9 | 
 10 |     <artifactId>engine.io-server-test</artifactId>
 11 |     <packaging>jar</packaging>
 12 |     <description>This module contains integration tests.</description>
 13 | 
 14 |     <properties>
 15 |         <maven.deploy.skip>true</maven.deploy.skip>
 16 |         <maven.install.skip>true</maven.install.skip>
 17 |     </properties>
 18 | 
 19 |     <dependencies>
 20 |         <dependency>
 21 |             <groupId>commons-io</groupId>
 22 |             <artifactId>commons-io</artifactId>
 23 |             <version>2.13.0</version>
 24 |         </dependency>
 25 | 
 26 |         <dependency>
 27 |             <groupId>org.json</groupId>
 28 |             <artifactId>json</artifactId>
 29 |             <version>20230618</version>
 30 |             <scope>test</scope>
 31 |         </dependency>
 32 |         <dependency>
 33 |             <groupId>org.junit.jupiter</groupId>
 34 |             <artifactId>junit-jupiter</artifactId>
 35 |             <version>5.6.3</version>
 36 |             <scope>test</scope>
 37 |         </dependency>
 38 |         <dependency>
 39 |             <groupId>org.junit.vintage</groupId>
 40 |             <artifactId>junit-vintage-engine</artifactId>
 41 |             <version>5.6.3</version>
 42 |             <scope>test</scope>
 43 |         </dependency>
 44 |         <dependency>
 45 |             <groupId>org.junit.platform</groupId>
 46 |             <artifactId>junit-platform-launcher</artifactId>
 47 |             <version>1.6.3</version>
 48 |             <scope>test</scope>
 49 |         </dependency>
 50 |         <dependency>
 51 |             <groupId>org.eclipse.jetty</groupId>
 52 |             <artifactId>jetty-server</artifactId>
 53 |             <version>${jetty.version}</version>
 54 |             <scope>test</scope>
 55 |         </dependency>
 56 |         <dependency>
 57 |             <groupId>org.eclipse.jetty</groupId>
 58 |             <artifactId>jetty-servlet</artifactId>
 59 |             <version>${jetty.version}</version>
 60 |             <scope>test</scope>
 61 |         </dependency>
 62 |         <dependency>
 63 |             <groupId>org.eclipse.jetty.websocket</groupId>
 64 |             <artifactId>websocket-jetty-server</artifactId>
 65 |             <version>${jetty.version}</version>
 66 |             <scope>test</scope>
 67 |         </dependency>
 68 |         <dependency>
 69 |             <groupId>org.seleniumhq.selenium</groupId>
 70 |             <artifactId>selenium-java</artifactId>
 71 |             <version>4.11.0</version>
 72 |             <scope>test</scope>
 73 |         </dependency>
 74 |         <dependency>
 75 |             <groupId>org.seleniumhq.selenium</groupId>
 76 |             <artifactId>selenium-firefox-driver</artifactId>
 77 |             <version>4.11.0</version>
 78 |             <scope>test</scope>
 79 |         </dependency>
 80 | 
 81 |         <dependency>
 82 |             <groupId>io.socket</groupId>
 83 |             <artifactId>engine.io-server</artifactId>
 84 |             <scope>test</scope>
 85 |         </dependency>
 86 |     </dependencies>
 87 | 
 88 |     <build>
 89 |         <plugins>
 90 |             <plugin>
 91 |                 <groupId>org.apache.maven.plugins</groupId>
 92 |                 <artifactId>maven-compiler-plugin</artifactId>
 93 |                 <version>3.11.0</version>
 94 |                 <configuration>
 95 |                     <source>1.8</source>
 96 |                     <target>1.8</target>
 97 |                     <encoding>UTF-8</encoding>
 98 |                     <compilerArgs>
 99 |                         <arg>-Xlint:unchecked</arg>
100 |                     </compilerArgs>
101 |                     <showWarnings>true</showWarnings>
102 |                     <showDeprecation>true</showDeprecation>
103 |                 </configuration>
104 |             </plugin>
105 |             <plugin>
106 |                 <groupId>org.apache.maven.plugins</groupId>
107 |                 <artifactId>maven-deploy-plugin</artifactId>
108 |                 <version>3.1.1</version>
109 |                 <configuration>
110 |                     <skip>true</skip>
111 |                 </configuration>
112 |             </plugin>
113 | 
114 |             <plugin>
115 |                 <groupId>org.codehaus.mojo</groupId>
116 |                 <artifactId>exec-maven-plugin</artifactId>
117 |                 <version>3.1.0</version>
118 |                 <executions>
119 |                     <execution>
120 |                         <id>npm-install</id>
121 |                         <phase>process-test-resources</phase>
122 |                         <goals>
123 |                             <goal>exec</goal>
124 |                         </goals>
125 |                         <configuration>
126 |                             <workingDirectory>./src/test/resources</workingDirectory>
127 |                             <executable>npm</executable>
128 |                             <arguments>
129 |                                 <argument>install</argument>
130 |                             </arguments>
131 |                         </configuration>
132 |                     </execution>
133 |                 </executions>
134 |             </plugin>
135 |             <plugin>
136 |                 <groupId>org.apache.maven.plugins</groupId>
137 |                 <artifactId>maven-surefire-plugin</artifactId>
138 |                 <version>3.1.2</version>
139 |                 <configuration>
140 |                     <argLine>-Dfile.encoding=UTF-8</argLine>
141 |                     <systemPropertyVariables>
142 |                         <java.util.logging.config.file>./src/test/resources/logging.properties</java.util.logging.config.file>
143 |                         <webdriver.gecko.driver>${WEBDRIVER_GECKO}</webdriver.gecko.driver>
144 |                     </systemPropertyVariables>
145 |                 </configuration>
146 |             </plugin>
147 |         </plugins>
148 |     </build>
149 | </project>
150 | 


--------------------------------------------------------------------------------
/engine.io-server-test/src/test/java/io/socket/engineio/server/JettyEngineIoWebSocketHandler.java:
--------------------------------------------------------------------------------
 1 | package io.socket.engineio.server;
 2 | 
 3 | import io.socket.engineio.server.utils.ParseQS;
 4 | import org.eclipse.jetty.websocket.api.Session;
 5 | import org.eclipse.jetty.websocket.api.WebSocketListener;
 6 | import org.eclipse.jetty.websocket.api.annotations.WebSocket;
 7 | 
 8 | import java.io.IOException;
 9 | import java.nio.ByteBuffer;
10 | import java.util.List;
11 | import java.util.Map;
12 | 
13 | @WebSocket
14 | final class JettyEngineIoWebSocketHandler extends EngineIoWebSocket implements WebSocketListener {
15 | 
16 |     private final EngineIoServer mEngineIoServer;
17 |     private Session mSession;
18 |     private Map<String, String> mQuery;
19 |     private Map<String, List<String>> mHeaders;
20 | 
21 |     public JettyEngineIoWebSocketHandler(EngineIoServer engineIoServer) {
22 |         mEngineIoServer = engineIoServer;
23 |     }
24 | 
25 |     @Override
26 |     public void onWebSocketConnect(Session session) {
27 |         mSession = session;
28 |         mQuery = ParseQS.decode(session.getUpgradeRequest().getQueryString());
29 |         mHeaders = session.getUpgradeRequest().getHeaders();
30 | 
31 |         mEngineIoServer.handleWebSocket(this);
32 |     }
33 | 
34 |     @Override
35 |     public void onWebSocketClose(int statusCode, String reason) {
36 |         emit("close");
37 |         mSession = null;
38 |     }
39 | 
40 |     @Override
41 |     public void onWebSocketError(Throwable cause) {
42 |         emit("error", "write error", cause.getMessage());
43 |     }
44 | 
45 |     @Override
46 |     public void onWebSocketText(String message) {
47 |         //noinspection RedundantCast
48 |         emit("message", (Object) message);
49 |     }
50 | 
51 |     @Override
52 |     public void onWebSocketBinary(byte[] payload, int offset, int len) {
53 |         byte[] message = payload;
54 |         if (!(offset == 0 && len == payload.length)) {
55 |             message = new byte[len];
56 |             System.arraycopy(payload, offset, message, 0, len);
57 |         }
58 | 
59 |         //noinspection RedundantCast
60 |         emit("message", (Object) message);
61 |     }
62 | 
63 |     @Override
64 |     public Map<String, String> getQuery() {
65 |         return mQuery;
66 |     }
67 | 
68 |     @Override
69 |     public Map<String, List<String>> getConnectionHeaders() {
70 |         return mHeaders;
71 |     }
72 | 
73 |     @Override
74 |     public void write(String message) throws IOException {
75 |         assert mSession != null;
76 | 
77 |         mSession.getRemote().sendString(message);
78 |     }
79 | 
80 |     @Override
81 |     public void write(byte[] message) throws IOException {
82 |         assert mSession != null;
83 | 
84 |         mSession.getRemote().sendBytes(ByteBuffer.wrap(message));
85 |     }
86 | 
87 |     @Override
88 |     public void close() {
89 |         if (mSession != null) {
90 |             mSession.close();
91 |         }
92 |     }
93 | }
94 | 


--------------------------------------------------------------------------------
/engine.io-server-test/src/test/java/io/socket/engineio/server/PollingJsonpTest.java:
--------------------------------------------------------------------------------
  1 | package io.socket.engineio.server;
  2 | 
  3 | import io.socket.engineio.server.parser.Packet;
  4 | import org.junit.Ignore;
  5 | import org.junit.Test;
  6 | import org.openqa.selenium.WebDriver;
  7 | import org.openqa.selenium.firefox.FirefoxDriver;
  8 | import org.openqa.selenium.firefox.FirefoxOptions;
  9 | import org.openqa.selenium.support.events.AbstractWebDriverEventListener;
 10 | import org.openqa.selenium.support.events.EventFiringWebDriver;
 11 | 
 12 | import java.io.FileInputStream;
 13 | import java.io.IOException;
 14 | import java.nio.charset.StandardCharsets;
 15 | 
 16 | import static org.junit.Assert.assertEquals;
 17 | 
 18 | /*
 19 |  * TODO: Find a way to test this.
 20 |  */
 21 | @Ignore
 22 | public final class PollingJsonpTest {
 23 | 
 24 |     /*private static SeleniumServer sSeleniumServer;*/
 25 | 
 26 |     /*@Before
 27 |     public void setup() {
 28 |         final StandaloneConfiguration configuration = new StandaloneConfiguration();
 29 |         configuration.port = 4444;
 30 | 
 31 |         sSeleniumServer = new SeleniumServer(configuration);
 32 |         sSeleniumServer.boot();
 33 |     }
 34 | 
 35 |     @After
 36 |     public void teardown() {
 37 |         sSeleniumServer.stop();
 38 |     }*/
 39 | 
 40 |     @Test
 41 |     public void echoTest_string() throws Exception {
 42 |         final ServerWrapper serverWrapper = new ServerWrapper();
 43 | 
 44 |         try {
 45 |             serverWrapper.startServer();
 46 |             serverWrapper.getEngineIoServer().on("connection", args -> {
 47 |                 final EngineIoSocket socket = (EngineIoSocket) args[0];
 48 |                 socket.on("message", args1 -> {
 49 |                     Packet packet = new Packet(Packet.MESSAGE);
 50 |                     packet.data = args1[0];
 51 |                     socket.send(packet);
 52 |                 });
 53 |             });
 54 | 
 55 |             assertEquals(0, executeScriptInBrowser(serverWrapper, "src/test/resources/testPollingJsonp_echo_string.js"));
 56 |         } finally {
 57 |             serverWrapper.stopServer();
 58 |         }
 59 |     }
 60 | 
 61 |     @Test
 62 |     public void reverseEchoTest() throws Exception {
 63 |         final ServerWrapper serverWrapper = new ServerWrapper();
 64 |         try {
 65 |             serverWrapper.startServer();
 66 |             serverWrapper.getEngineIoServer().on("connection", args -> {
 67 |                 final EngineIoSocket socket = (EngineIoSocket) args[0];
 68 |                 final String echoMessage = PollingTest.class.getSimpleName() + System.currentTimeMillis();
 69 |                 socket.on("message", args1 -> assertEquals(echoMessage, args1[0]));
 70 | 
 71 |                 Packet packet = new Packet(Packet.MESSAGE);
 72 |                 packet.data = echoMessage;
 73 |                 socket.send(packet);
 74 |             });
 75 | 
 76 |             assertEquals(0, executeScriptInBrowser(serverWrapper, "src/test/resources/testPollingJsonp_reverseEcho.js"));
 77 |         } finally {
 78 |             serverWrapper.stopServer();
 79 |         }
 80 |     }
 81 | 
 82 |     @SuppressWarnings("ResultOfMethodCallIgnored")
 83 |     private int executeScriptInBrowser(ServerWrapper serverWrapper, String script) throws IOException {
 84 |         class ScriptResult {
 85 |             int result = -1;
 86 |         }
 87 | 
 88 |         final FirefoxOptions firefoxOptions = new FirefoxOptions();
 89 |         firefoxOptions.addArguments("-headless");
 90 | 
 91 |         final FirefoxDriver firefoxDriver = new FirefoxDriver(firefoxOptions);
 92 |         final EventFiringWebDriver eventFiringWebDriver = new EventFiringWebDriver(firefoxDriver);
 93 |         final ScriptResult scriptResult = new ScriptResult();
 94 | 
 95 |         try (FileInputStream fis = new FileInputStream(script)) {
 96 |             final byte[] scriptBytes = new byte[fis.available()];
 97 |             fis.read(scriptBytes);
 98 |             final String scriptContent = new String(scriptBytes, StandardCharsets.UTF_8);
 99 | 
100 |             eventFiringWebDriver.get("http://127.0.0.1:" + serverWrapper.getPort() + "/testPollingJsonp.html");
101 |             eventFiringWebDriver.register(new AbstractWebDriverEventListener() {
102 | 
103 |                 @Override
104 |                 public void afterScript(String script, WebDriver driver) {
105 |                     final String url = eventFiringWebDriver.getCurrentUrl();
106 |                     if (url.startsWith("http://www.example.com/?result=")) {
107 |                         scriptResult.result = Integer.parseInt(url.substring("http://www.example.com/?result=".length()));
108 |                     }
109 |                 }
110 |             });
111 |             eventFiringWebDriver.executeScript(scriptContent, serverWrapper.getPort());
112 | 
113 |             try {
114 |                 Thread.sleep(3000);
115 |             } catch (InterruptedException ignore) {
116 |             }
117 | 
118 |             return scriptResult.result;
119 |         } finally {
120 |             firefoxDriver.close();
121 |         }
122 |     }
123 | }
124 | 


--------------------------------------------------------------------------------
/engine.io-server-test/src/test/java/io/socket/engineio/server/PollingTest.java:
--------------------------------------------------------------------------------
  1 | package io.socket.engineio.server;
  2 | 
  3 | import io.socket.engineio.server.parser.Packet;
  4 | import org.junit.Test;
  5 | 
  6 | import static org.junit.Assert.assertEquals;
  7 | 
  8 | /**
  9 |  * Test server against JS client.
 10 |  */
 11 | @SuppressWarnings("Duplicates")
 12 | public final class PollingTest {
 13 | 
 14 |     @Test
 15 |     public void connectTest() throws Exception {
 16 |         ServerWrapper serverWrapper = new ServerWrapper();
 17 |         try {
 18 |             serverWrapper.startServer();
 19 |             assertEquals(0, TestUtils.executeScriptForResult("src/test/resources/testPolling_connect.js", serverWrapper.getPort()));
 20 |         } finally {
 21 |             serverWrapper.stopServer();
 22 |         }
 23 |     }
 24 | 
 25 |     @Test
 26 |     public void echoTest_string() throws Exception {
 27 |         final ServerWrapper serverWrapper = new ServerWrapper();
 28 |         try {
 29 |             serverWrapper.startServer();
 30 |             serverWrapper.getEngineIoServer().on("connection", args -> {
 31 |                 final EngineIoSocket socket = (EngineIoSocket) args[0];
 32 |                 socket.on("message", args1 -> {
 33 |                     Packet<Object> packet = new Packet<>(Packet.MESSAGE);
 34 |                     packet.data = args1[0];
 35 |                     socket.send(packet);
 36 |                 });
 37 |             });
 38 | 
 39 |             assertEquals(0, TestUtils.executeScriptForResult("src/test/resources/testPolling_echo_string.js", serverWrapper.getPort()));
 40 |         } finally {
 41 |             serverWrapper.stopServer();
 42 |         }
 43 |     }
 44 | 
 45 |     @Test
 46 |     public void echoTest_binary() throws Exception {
 47 |         ServerWrapper serverWrapper = new ServerWrapper();
 48 |         try {
 49 |             serverWrapper.startServer();
 50 |             serverWrapper.getEngineIoServer().on("connection", args -> {
 51 |                 final EngineIoSocket socket = (EngineIoSocket) args[0];
 52 |                 socket.on("message", args1 -> {
 53 |                     Packet<Object> packet = new Packet<>(Packet.MESSAGE);
 54 |                     packet.data = args1[0];
 55 |                     socket.send(packet);
 56 |                 });
 57 |             });
 58 | 
 59 |             assertEquals(0, TestUtils.executeScriptForResult("src/test/resources/testPolling_echo_binary.js", serverWrapper.getPort()));
 60 |         } finally {
 61 |             serverWrapper.stopServer();
 62 |         }
 63 |     }
 64 | 
 65 |     @Test
 66 |     public void echoTest_base64() throws Exception {
 67 |         ServerWrapper serverWrapper = new ServerWrapper();
 68 |         try {
 69 |             serverWrapper.startServer();
 70 |             serverWrapper.getEngineIoServer().on("connection", args -> {
 71 |                 final EngineIoSocket socket = (EngineIoSocket) args[0];
 72 |                 socket.on("message", args1 -> {
 73 |                     Packet<Object> packet = new Packet<>(Packet.MESSAGE);
 74 |                     packet.data = args1[0];
 75 |                     socket.send(packet);
 76 |                 });
 77 |             });
 78 | 
 79 |             assertEquals(0, TestUtils.executeScriptForResult("src/test/resources/testPolling_echo_base64.js", serverWrapper.getPort()));
 80 |         } finally {
 81 |             serverWrapper.stopServer();
 82 |         }
 83 |     }
 84 | 
 85 |     @Test
 86 |     public void reverseEchoTest() throws Exception {
 87 |         final ServerWrapper serverWrapper = new ServerWrapper();
 88 |         try {
 89 |             serverWrapper.startServer();
 90 |             serverWrapper.getEngineIoServer().on("connection", args -> {
 91 |                 final EngineIoSocket socket = (EngineIoSocket) args[0];
 92 |                 final String echoMessage = PollingTest.class.getSimpleName() + System.currentTimeMillis();
 93 |                 socket.on("message", args1 -> assertEquals(echoMessage, args1[0]));
 94 | 
 95 |                 Packet<Object> packet = new Packet<>(Packet.MESSAGE);
 96 |                 packet.data = echoMessage;
 97 |                 socket.send(packet);
 98 |             });
 99 | 
100 |             assertEquals(0, TestUtils.executeScriptForResult("src/test/resources/testPolling_reverseEcho.js", serverWrapper.getPort()));
101 |         } finally {
102 |             serverWrapper.stopServer();
103 |         }
104 |     }
105 | }


--------------------------------------------------------------------------------
/engine.io-server-test/src/test/java/io/socket/engineio/server/ServerWrapper.java:
--------------------------------------------------------------------------------
  1 | package io.socket.engineio.server;
  2 | 
  3 | import jakarta.servlet.ServletException;
  4 | import jakarta.servlet.ServletRequest;
  5 | import jakarta.servlet.ServletResponse;
  6 | import jakarta.servlet.http.HttpServlet;
  7 | import jakarta.servlet.http.HttpServletRequest;
  8 | import jakarta.servlet.http.HttpServletResponse;
  9 | import org.apache.commons.io.IOUtils;
 10 | import org.eclipse.jetty.server.Server;
 11 | import org.eclipse.jetty.servlet.ServletContextHandler;
 12 | import org.eclipse.jetty.servlet.ServletHolder;
 13 | import org.eclipse.jetty.util.log.Log;
 14 | import org.eclipse.jetty.util.log.Logger;
 15 | import org.eclipse.jetty.websocket.server.JettyWebSocketServlet;
 16 | import org.eclipse.jetty.websocket.server.JettyWebSocketServletFactory;
 17 | import org.eclipse.jetty.websocket.server.config.JettyWebSocketServletContainerInitializer;
 18 | 
 19 | import java.io.File;
 20 | import java.io.FileInputStream;
 21 | import java.io.IOException;
 22 | import java.io.PrintWriter;
 23 | import java.nio.file.Files;
 24 | import java.util.concurrent.atomic.AtomicInteger;
 25 | 
 26 | final class ServerWrapper {
 27 | 
 28 |     private static final AtomicInteger PORT_START = new AtomicInteger(3000);
 29 | 
 30 |     private final int mPort;
 31 |     private final Server mServer;
 32 |     private final EngineIoServer mEngineIoServer;
 33 | 
 34 |     static {
 35 |         Log.setLog(new JettyNoLogging());
 36 |     }
 37 | 
 38 |     ServerWrapper() {
 39 |         mPort = PORT_START.getAndIncrement();
 40 |         mServer = new Server(mPort);
 41 |         mEngineIoServer = new EngineIoServer();
 42 | 
 43 |         ServletContextHandler servletContextHandler = new ServletContextHandler(ServletContextHandler.SESSIONS);
 44 |         servletContextHandler.setContextPath("/");
 45 | 
 46 |         /*final ServletHolder servletHolder = new ServletHolder(new HttpServlet() {
 47 |             private static final long serialVersionUID = 7089396507926086181L;
 48 | 
 49 |             @Override
 50 |             protected void service(HttpServletRequest request, HttpServletResponse response) throws IOException {
 51 |                 mEngineIoServer.handleRequest(request, response);
 52 |             }
 53 |         });
 54 |         servletHolder.setAsyncSupported(true);
 55 |         servletContextHandler.addServlet(servletHolder, "/engine.io/*");*/
 56 | 
 57 |         servletContextHandler.addServlet(new ServletHolder(new HttpServlet() {
 58 |             private static final long serialVersionUID = 6467153647501924502L;
 59 | 
 60 |             @Override
 61 |             protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
 62 |                 final String path = request.getPathInfo();
 63 |                 final File file = new File("src/test/resources", path);
 64 |                 if (file.exists()) {
 65 |                     response.setContentType(Files.probeContentType(file.toPath()));
 66 | 
 67 |                     try (FileInputStream fis = new FileInputStream(file)) {
 68 |                         IOUtils.copy(fis, response.getOutputStream());
 69 |                     }
 70 |                 } else {
 71 |                     response.setStatus(404);
 72 |                     try (PrintWriter writer = response.getWriter()) {
 73 |                         writer.print("Not Found");
 74 |                         writer.flush();
 75 |                     }
 76 |                 }
 77 |             }
 78 |         }), "/*");
 79 | 
 80 |         final JettyWebSocketServlet webSocketServlet = new JettyWebSocketServlet() {
 81 |             private static final long serialVersionUID = 4525525859144703715L;
 82 | 
 83 |             @Override
 84 |             protected void configure(JettyWebSocketServletFactory jettyWebSocketServletFactory) {
 85 |                 jettyWebSocketServletFactory.addMapping(
 86 |                         "/",
 87 |                         (request, response) -> new JettyEngineIoWebSocketHandler(mEngineIoServer));
 88 |             }
 89 | 
 90 |             @Override
 91 |             public void service(ServletRequest request, ServletResponse response) throws ServletException, IOException {
 92 |                 if (request instanceof HttpServletRequest) {
 93 |                     final String upgradeHeader = ((HttpServletRequest) request).getHeader("upgrade");
 94 |                     if (upgradeHeader != null) {
 95 |                         super.service(request, response);
 96 |                     } else {
 97 |                         mEngineIoServer.handleRequest((HttpServletRequest) request, (HttpServletResponse) response);
 98 |                     }
 99 |                 } else {
100 |                     super.service(request, response);
101 |                 }
102 |             }
103 |         };
104 |         final ServletHolder webSocketServletHolder = new ServletHolder(webSocketServlet);
105 |         webSocketServletHolder.setAsyncSupported(true);
106 |         servletContextHandler.addServlet(webSocketServletHolder, "/engine.io/*");
107 |         JettyWebSocketServletContainerInitializer.configure(servletContextHandler, null);
108 | 
109 |         mServer.setHandler(servletContextHandler);
110 |     }
111 | 
112 |     void startServer() throws Exception {
113 |         mServer.start();
114 |     }
115 | 
116 |     void stopServer() throws Exception {
117 |         mServer.stop();
118 |     }
119 | 
120 |     int getPort() {
121 |         return mPort;
122 |     }
123 | 
124 |     EngineIoServer getEngineIoServer() {
125 |         return mEngineIoServer;
126 |     }
127 | 
128 |     private static final class JettyNoLogging implements Logger {
129 | 
130 |         @Override public String getName() {
131 |             return "no";
132 |         }
133 | 
134 |         @Override
135 |         public void warn(String s, Object... objects) {
136 |         }
137 | 
138 |         @Override
139 |         public void warn(Throwable throwable) {
140 |         }
141 | 
142 |         @Override
143 |         public void warn(String s, Throwable throwable) {
144 |         }
145 | 
146 |         @Override
147 |         public void info(String s, Object... objects) {
148 |         }
149 | 
150 |         @Override
151 |         public void info(Throwable throwable) {
152 |         }
153 | 
154 |         @Override
155 |         public void info(String s, Throwable throwable) {
156 |         }
157 | 
158 |         @Override
159 |         public boolean isDebugEnabled() {
160 |             return false;
161 |         }
162 | 
163 |         @Override
164 |         public void setDebugEnabled(boolean b) {
165 |         }
166 | 
167 |         @Override
168 |         public void debug(String s, Object... objects) {
169 |         }
170 | 
171 |         @Override
172 |         public void debug(String s, long l) {
173 |         }
174 | 
175 |         @Override
176 |         public void debug(Throwable throwable) {
177 |         }
178 | 
179 |         @Override
180 |         public void debug(String s, Throwable throwable) {
181 |         }
182 | 
183 |         @Override
184 |         public Logger getLogger(String s) {
185 |             return this;
186 |         }
187 | 
188 |         @Override
189 |         public void ignore(Throwable throwable) {
190 |         }
191 |     }
192 | }
193 | 


--------------------------------------------------------------------------------
/engine.io-server-test/src/test/java/io/socket/engineio/server/TestUtils.java:
--------------------------------------------------------------------------------
 1 | package io.socket.engineio.server;
 2 | 
 3 | import java.io.IOException;
 4 | import java.io.InputStream;
 5 | import java.nio.charset.StandardCharsets;
 6 | 
 7 | final class TestUtils {
 8 | 
 9 |     private TestUtils() {
10 |     }
11 | 
12 |     static int executeScriptForResult(String script, int port) throws IOException {
13 |         final String nodeExec = (System.getenv("NODE_PATH") != null)? System.getenv("NODE_PATH") : "node";
14 | 
15 |         Process process = Runtime.getRuntime().exec(nodeExec + " " + script, new String[] {
16 |                 "PORT=" + port
17 |         });
18 |         try {
19 |             int result = process.waitFor();
20 | 
21 |             InputStream inputStream = process.getInputStream();
22 |             byte[] buffer = new byte[inputStream.available()];
23 |             //noinspection ResultOfMethodCallIgnored
24 |             inputStream.read(buffer);
25 |             System.out.println(new String(buffer, StandardCharsets.UTF_8));
26 | 
27 |             return result;
28 |         } catch (InterruptedException ex) {
29 |             throw new RuntimeException(ex);
30 |         }
31 |     }
32 | }


--------------------------------------------------------------------------------
/engine.io-server-test/src/test/java/io/socket/engineio/server/UpgradeTest.java:
--------------------------------------------------------------------------------
 1 | package io.socket.engineio.server;
 2 | 
 3 | import io.socket.engineio.server.parser.Packet;
 4 | import org.junit.Test;
 5 | 
 6 | import static org.junit.Assert.assertEquals;
 7 | 
 8 | @SuppressWarnings("Duplicates")
 9 | public final class UpgradeTest {
10 | 
11 |     @Test
12 |     public void echoTest_string() throws Exception {
13 |         final ServerWrapper serverWrapper = new ServerWrapper();
14 |         try {
15 |             serverWrapper.startServer();
16 |             serverWrapper.getEngineIoServer().on("connection", args -> {
17 |                 final EngineIoSocket socket = (EngineIoSocket) args[0];
18 |                 socket.on("message", args1 -> {
19 |                     assertEquals("Upgraded Hello World", args1[0]);
20 | 
21 |                     Packet packet = new Packet(Packet.MESSAGE);
22 |                     packet.data = args1[0];
23 |                     socket.send(packet);
24 |                 });
25 |             });
26 | 
27 |             assertEquals(0, TestUtils.executeScriptForResult("src/test/resources/testUpgrade_echo.js", serverWrapper.getPort()));
28 |         } finally {
29 |             serverWrapper.stopServer();
30 |         }
31 |     }
32 | }


--------------------------------------------------------------------------------
/engine.io-server-test/src/test/java/io/socket/engineio/server/WebSocketTest.java:
--------------------------------------------------------------------------------
  1 | package io.socket.engineio.server;
  2 | 
  3 | import io.socket.engineio.server.parser.Packet;
  4 | import org.junit.Test;
  5 | 
  6 | import static org.junit.Assert.assertEquals;
  7 | 
  8 | /**
  9 |  * Test server against JS client.
 10 |  */
 11 | @SuppressWarnings("Duplicates")
 12 | public final class WebSocketTest {
 13 | 
 14 |     @Test
 15 |     public void connectTest() throws Exception {
 16 |         ServerWrapper serverWrapper = new ServerWrapper();
 17 |         try {
 18 |             serverWrapper.startServer();
 19 |             assertEquals(0, TestUtils.executeScriptForResult("src/test/resources/testWebSocket_connect.js", serverWrapper.getPort()));
 20 |         } finally {
 21 |             serverWrapper.stopServer();
 22 |         }
 23 |     }
 24 | 
 25 |     @Test
 26 |     public void echoTest_string() throws Exception {
 27 |         final ServerWrapper serverWrapper = new ServerWrapper();
 28 |         try {
 29 |             serverWrapper.startServer();
 30 |             serverWrapper.getEngineIoServer().on("connection", args -> {
 31 |                 final EngineIoSocket socket = (EngineIoSocket) args[0];
 32 |                 socket.on("message", args1 -> {
 33 |                     Packet packet = new Packet(Packet.MESSAGE);
 34 |                     packet.data = args1[0];
 35 |                     socket.send(packet);
 36 |                 });
 37 |             });
 38 | 
 39 |             assertEquals(0, TestUtils.executeScriptForResult("src/test/resources/testWebSocket_echo_string.js", serverWrapper.getPort()));
 40 |         } finally {
 41 |             serverWrapper.stopServer();
 42 |         }
 43 |     }
 44 | 
 45 |     @Test
 46 |     public void echoTest_binary() throws Exception {
 47 |         ServerWrapper serverWrapper = new ServerWrapper();
 48 |         try {
 49 |             serverWrapper.startServer();
 50 |             serverWrapper.getEngineIoServer().on("connection", args -> {
 51 |                 final EngineIoSocket socket = (EngineIoSocket) args[0];
 52 |                 socket.on("message", args1 -> {
 53 |                     Packet packet = new Packet(Packet.MESSAGE);
 54 |                     packet.data = args1[0];
 55 |                     socket.send(packet);
 56 |                 });
 57 |             });
 58 | 
 59 |             assertEquals(0, TestUtils.executeScriptForResult("src/test/resources/testWebSocket_echo_binary.js", serverWrapper.getPort()));
 60 |         } finally {
 61 |             serverWrapper.stopServer();
 62 |         }
 63 |     }
 64 | 
 65 |     @Test
 66 |     public void echoTest_base64() throws Exception {
 67 |         ServerWrapper serverWrapper = new ServerWrapper();
 68 |         try {
 69 |             serverWrapper.startServer();
 70 |             serverWrapper.getEngineIoServer().on("connection", args -> {
 71 |                 final EngineIoSocket socket = (EngineIoSocket) args[0];
 72 |                 socket.on("message", args1 -> {
 73 |                     Packet packet = new Packet(Packet.MESSAGE);
 74 |                     packet.data = args1[0];
 75 |                     socket.send(packet);
 76 |                 });
 77 |             });
 78 | 
 79 |             assertEquals(0, TestUtils.executeScriptForResult("src/test/resources/testWebSocket_echo_base64.js", serverWrapper.getPort()));
 80 |         } finally {
 81 |             serverWrapper.stopServer();
 82 |         }
 83 |     }
 84 | 
 85 |     @Test
 86 |     public void reverseEchoTest() throws Exception {
 87 |         final ServerWrapper serverWrapper = new ServerWrapper();
 88 |         try {
 89 |             serverWrapper.startServer();
 90 |             serverWrapper.getEngineIoServer().on("connection", args -> {
 91 |                 final EngineIoSocket socket = (EngineIoSocket) args[0];
 92 |                 final String echoMessage = PollingTest.class.getSimpleName() + System.currentTimeMillis();
 93 |                 socket.on("message", args1 -> assertEquals(echoMessage, args1[0]));
 94 | 
 95 |                 Packet packet = new Packet(Packet.MESSAGE);
 96 |                 packet.data = echoMessage;
 97 |                 socket.send(packet);
 98 |             });
 99 | 
100 |             assertEquals(0, TestUtils.executeScriptForResult("src/test/resources/testWebSocket_reverseEcho.js", serverWrapper.getPort()));
101 |         } finally {
102 |             serverWrapper.stopServer();
103 |         }
104 |     }
105 | }


--------------------------------------------------------------------------------
/engine.io-server-test/src/test/resources/helpers.js:
--------------------------------------------------------------------------------
 1 | /* Helper methods */
 2 | 
 3 | module.exports = {};
 4 | 
 5 | module.exports.toArrayBuffer = function (buf) {
 6 |     var ab = new ArrayBuffer(buf.length);
 7 |     var view = new Uint8Array(ab);
 8 |     for (var i = 0; i < buf.length; ++i) {
 9 |         view[i] = buf[i];
10 |     }
11 |     return ab;
12 | };
13 | 
14 | module.exports.compareArrayBuffer = function (arr1, arr2) {
15 |     if(arr1.byteLength !== arr2.byteLength) {
16 |         return false;
17 |     }
18 | 
19 |     for (var i = 0; i < arr1.byteLength; i++) {
20 |         if(arr1[i] !== arr2[i]) {
21 |             return false;
22 |         }
23 |     }
24 | 
25 |     return true;
26 | };


--------------------------------------------------------------------------------
/engine.io-server-test/src/test/resources/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "private": true,
 3 |   "dependencies": {
 4 |     "engine.io": "^5.1.0",
 5 |     "engine.io-client": "^5.1.1",
 6 |     "engine.io-parser": "^4.0.2",
 7 |     "get-stdin": "^6.0.0"
 8 |   }
 9 | }
10 | 


--------------------------------------------------------------------------------
/engine.io-server-test/src/test/resources/testPollingJsonp.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <html lang="en">
 3 | <head>
 4 |     <meta charset="UTF-8">
 5 | 
 6 |     <title>Polling Test - JSONP</title>
 7 | 
 8 |     <script type="text/javascript" src="node_modules/engine.io-client/engine.io.js"></script>
 9 |     <script type="text/javascript">
10 |         window.setResult = function (result) {
11 |             window.location = "http://www.example.com/?result=" + result;
12 |         };
13 |     </script>
14 | </head>
15 | <body>
16 | </body>
17 | </html>


--------------------------------------------------------------------------------
/engine.io-server-test/src/test/resources/testPollingJsonp_echo_string.js:
--------------------------------------------------------------------------------
 1 | var returnError = function () {
 2 |     window.setResult(1);
 3 | };
 4 | 
 5 | var port = arguments[0];
 6 | socket = eio('http://127.0.0.1:' + port, {
 7 |     transports: ['polling'],
 8 |     jsonp: true,
 9 |     forceJSONP: true
10 | });
11 | socket.on('open', function () {
12 |     var echoMessage = "Hello World";
13 |     socket.on('message', function (message) {
14 |         if(message === echoMessage) {
15 |             window.setResult(0);
16 |         } else {
17 |             returnError();
18 |         }
19 |     });
20 |     socket.send(echoMessage);
21 | });
22 | socket.on('error', returnError);
23 | setTimeout(returnError, 750);
24 | 


--------------------------------------------------------------------------------
/engine.io-server-test/src/test/resources/testPollingJsonp_reverseEcho.js:
--------------------------------------------------------------------------------
 1 | var returnError = function () {
 2 |     window.setResult(1);
 3 | };
 4 | 
 5 | var port = arguments[0];
 6 | socket = eio('http://127.0.0.1:' + port, {
 7 |     transports: ['polling'],
 8 |     jsonp: true,
 9 |     forceJSONP: true
10 | });
11 | socket.on("message", function (message) {
12 |     socket.sendPacket("message", message);
13 | 
14 |     setTimeout(function () {
15 |         window.setResult(0);
16 |     }, 100);
17 | });
18 | socket.on('error', returnError);
19 | setTimeout(returnError, 750);


--------------------------------------------------------------------------------
/engine.io-server-test/src/test/resources/testPolling_connect.js:
--------------------------------------------------------------------------------
 1 | var engine = require('engine.io-client');
 2 | 
 3 | var port = process.env.PORT || 3000;
 4 | socket = engine('http://127.0.0.1:' + port, {
 5 |     transports: ['polling']
 6 | });
 7 | socket.on('open', function () {
 8 |     process.exit(0);
 9 | });
10 | socket.on('error', function () {
11 |     process.exit(1);
12 | });


--------------------------------------------------------------------------------
/engine.io-server-test/src/test/resources/testPolling_echo_base64.js:
--------------------------------------------------------------------------------
 1 | var engine = require('engine.io-client');
 2 | var helpers = require('./helpers');
 3 | 
 4 | var returnError = function (err) {
 5 |     process.exit(1);
 6 | };
 7 | 
 8 | var port = process.env.PORT || 3000;
 9 | socket = engine('http://127.0.0.1:' + port, {
10 |     transports: ['polling'],
11 |     forceBase64: true
12 | });
13 | socket.on('open', function () {
14 |     var echoMessage = helpers.toArrayBuffer([1, 2, 3, 4, 5, 6, 7, 8]);
15 |     socket.on('message', function (message) {
16 |         message = helpers.toArrayBuffer(message);
17 | 
18 |         if(helpers.compareArrayBuffer(message, echoMessage)) {
19 |             process.exit(0);
20 |         } else {
21 |             returnError();
22 |         }
23 |     });
24 |     socket.send(echoMessage);
25 | });
26 | socket.on('error', returnError);
27 | setTimeout(returnError, 750);


--------------------------------------------------------------------------------
/engine.io-server-test/src/test/resources/testPolling_echo_binary.js:
--------------------------------------------------------------------------------
 1 | var engine = require('engine.io-client');
 2 | var helpers = require('./helpers');
 3 | 
 4 | var returnError = function (err) {
 5 |     process.exit(1);
 6 | };
 7 | 
 8 | var port = process.env.PORT || 3000;
 9 | socket = engine('http://127.0.0.1:' + port, {
10 |     transports: ['polling']
11 | });
12 | socket.on('open', function () {
13 |     var echoMessage = helpers.toArrayBuffer([1, 2, 3, 4, 5, 6, 7, 8]);
14 |     socket.on('message', function (message) {
15 |         message = helpers.toArrayBuffer(message);
16 | 
17 |         if(helpers.compareArrayBuffer(message, echoMessage)) {
18 |             process.exit(0);
19 |         } else {
20 |             returnError();
21 |         }
22 |     });
23 |     socket.send(echoMessage);
24 | });
25 | socket.on('error', returnError);
26 | setTimeout(returnError, 750);


--------------------------------------------------------------------------------
/engine.io-server-test/src/test/resources/testPolling_echo_string.js:
--------------------------------------------------------------------------------
 1 | var engine = require('engine.io-client');
 2 | 
 3 | var returnError = function () {
 4 |     process.exit(1);
 5 | };
 6 | 
 7 | var port = process.env.PORT || 3000;
 8 | socket = engine('http://127.0.0.1:' + port, {
 9 |     transports: ['polling']
10 | });
11 | socket.on('open', function () {
12 |     var echoMessage = "Hello World";
13 |     socket.on('message', function (message) {
14 |         if(message === echoMessage) {
15 |             process.exit(0);
16 |         } else {
17 |             returnError();
18 |         }
19 |     });
20 |     socket.send(echoMessage);
21 | });
22 | socket.on('error', returnError);
23 | setTimeout(returnError, 750);


--------------------------------------------------------------------------------
/engine.io-server-test/src/test/resources/testPolling_reverseEcho.js:
--------------------------------------------------------------------------------
 1 | var engine = require('engine.io-client');
 2 | var helpers = require('./helpers');
 3 | 
 4 | var returnError = function (err) {
 5 |     process.exit(1);
 6 | };
 7 | 
 8 | var port = process.env.PORT || 3000;
 9 | socket = engine('http://127.0.0.1:' + port, {
10 |     transports: ['polling']
11 | });
12 | socket.on("message", function (message) {
13 |     socket.sendPacket("message", message);
14 | 
15 |     setTimeout(function () {
16 |         process.exit(0);
17 |     }, 100);
18 | });
19 | socket.on('error', returnError);
20 | setTimeout(returnError, 750);


--------------------------------------------------------------------------------
/engine.io-server-test/src/test/resources/testUpgrade_echo.js:
--------------------------------------------------------------------------------
 1 | var engine = require('engine.io-client');
 2 | 
 3 | var returnError = function () {
 4 |     process.exit(1);
 5 | };
 6 | 
 7 | var port = process.env.PORT || 3000;
 8 | socket = engine('http://127.0.0.1:' + port, {});
 9 | socket.on('upgrade', function () {
10 |     var echoMessage = "Upgraded Hello World";
11 |     socket.on('message', function (message) {
12 |         if(message === echoMessage) {
13 |             process.exit(0);
14 |         } else {
15 |             returnError();
16 |         }
17 |     });
18 |     socket.send(echoMessage);
19 | });
20 | socket.on('error', returnError);
21 | setTimeout(returnError, 3000);


--------------------------------------------------------------------------------
/engine.io-server-test/src/test/resources/testWebSocket_connect.js:
--------------------------------------------------------------------------------
 1 | var engine = require('engine.io-client');
 2 | 
 3 | var port = process.env.PORT || 3000;
 4 | socket = engine('http://127.0.0.1:' + port, {
 5 |     transports: ['websocket']
 6 | });
 7 | socket.on('open', function () {
 8 |     process.exit(0);
 9 | });
10 | socket.on('error', function () {
11 |     process.exit(1);
12 | });
13 | 
14 | setTimeout(function () {
15 |     process.exit(1);
16 | }, 1500);


--------------------------------------------------------------------------------
/engine.io-server-test/src/test/resources/testWebSocket_echo_base64.js:
--------------------------------------------------------------------------------
 1 | var engine = require('engine.io-client');
 2 | var helpers = require('./helpers');
 3 | 
 4 | var returnError = function (err) {
 5 |     process.exit(1);
 6 | };
 7 | 
 8 | var port = process.env.PORT || 3000;
 9 | socket = engine('http://127.0.0.1:' + port, {
10 |     transports: ['websocket'],
11 |     forceBase64: true
12 | });
13 | socket.on('open', function () {
14 |     var echoMessage = helpers.toArrayBuffer([1, 2, 3, 4, 5, 6, 7, 8]);
15 |     socket.on('message', function (message) {
16 |         message = helpers.toArrayBuffer(message);
17 | 
18 |         if(helpers.compareArrayBuffer(message, echoMessage)) {
19 |             process.exit(0);
20 |         } else {
21 |             returnError();
22 |         }
23 |     });
24 |     socket.send(echoMessage);
25 | });
26 | socket.on('error', returnError);
27 | setTimeout(returnError, 1500);


--------------------------------------------------------------------------------
/engine.io-server-test/src/test/resources/testWebSocket_echo_binary.js:
--------------------------------------------------------------------------------
 1 | var engine = require('engine.io-client');
 2 | var helpers = require('./helpers');
 3 | 
 4 | var returnError = function (err) {
 5 |     process.exit(1);
 6 | };
 7 | 
 8 | var port = process.env.PORT || 3000;
 9 | socket = engine('http://127.0.0.1:' + port, {
10 |     transports: ['websocket']
11 | });
12 | socket.on('open', function () {
13 |     var echoMessage = helpers.toArrayBuffer([1, 2, 3, 4, 5, 6, 7, 8]);
14 |     socket.on('message', function (message) {
15 |         message = helpers.toArrayBuffer(message);
16 | 
17 |         if(helpers.compareArrayBuffer(message, echoMessage)) {
18 |             process.exit(0);
19 |         } else {
20 |             returnError();
21 |         }
22 |     });
23 |     socket.send(echoMessage);
24 | });
25 | socket.on('error', returnError);
26 | setTimeout(returnError, 1500);


--------------------------------------------------------------------------------
/engine.io-server-test/src/test/resources/testWebSocket_echo_string.js:
--------------------------------------------------------------------------------
 1 | var engine = require('engine.io-client');
 2 | 
 3 | var returnError = function () {
 4 |     process.exit(1);
 5 | };
 6 | 
 7 | var port = process.env.PORT || 3000;
 8 | socket = engine('http://127.0.0.1:' + port, {
 9 |     transports: ['websocket']
10 | });
11 | socket.on('open', function () {
12 |     var echoMessage = "Hello World";
13 |     socket.on('message', function (message) {
14 |         if(message === echoMessage) {
15 |             process.exit(0);
16 |         } else {
17 |             returnError();
18 |         }
19 |     });
20 |     socket.send(echoMessage);
21 | });
22 | socket.on('error', returnError);
23 | setTimeout(returnError, 1500);


--------------------------------------------------------------------------------
/engine.io-server-test/src/test/resources/testWebSocket_reverseEcho.js:
--------------------------------------------------------------------------------
 1 | var engine = require('engine.io-client');
 2 | var helpers = require('./helpers');
 3 | 
 4 | var returnError = function (err) {
 5 |     process.exit(1);
 6 | };
 7 | 
 8 | var port = process.env.PORT || 3000;
 9 | socket = engine('http://127.0.0.1:' + port, {
10 |     transports: ['websocket']
11 | });
12 | socket.on("message", function (message) {
13 |     socket.sendPacket("message", message);
14 | 
15 |     setTimeout(function () {
16 |         process.exit(0);
17 |     }, 100);
18 | });
19 | socket.on('error', returnError);
20 | setTimeout(returnError, 1500);


--------------------------------------------------------------------------------
/engine.io-server/pom.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8"?>
  2 | <project xmlns="http://maven.apache.org/POM/4.0.0">
  3 |     <modelVersion>4.0.0</modelVersion>
  4 |     <parent>
  5 |         <groupId>io.socket</groupId>
  6 |         <artifactId>engine.io-server-bom</artifactId>
  7 |         <version>6.3.2</version>
  8 |     </parent>
  9 | 
 10 |     <artifactId>engine.io-server</artifactId>
 11 |     <packaging>jar</packaging>
 12 |     <name>engine.io-server</name>
 13 |     <description>Engine.IO server library for Java</description>
 14 | 
 15 |     <dependencies>
 16 |         <dependency>
 17 |             <groupId>jakarta.platform</groupId>
 18 |             <artifactId>jakarta.jakartaee-api</artifactId>
 19 |             <version>10.0.0</version>
 20 |             <scope>provided</scope>
 21 |         </dependency>
 22 | 
 23 |         <!-- Test dependencies -->
 24 |         <dependency>
 25 |             <groupId>jakarta.servlet</groupId>
 26 |             <artifactId>jakarta.servlet-api</artifactId>
 27 |             <version>6.0.0</version>
 28 |             <scope>test</scope>
 29 |         </dependency>
 30 |         <dependency>
 31 |             <groupId>org.junit.jupiter</groupId>
 32 |             <artifactId>junit-jupiter</artifactId>
 33 |             <version>5.6.3</version>
 34 |             <scope>test</scope>
 35 |         </dependency>
 36 |         <dependency>
 37 |             <groupId>org.junit.vintage</groupId>
 38 |             <artifactId>junit-vintage-engine</artifactId>
 39 |             <version>5.6.3</version>
 40 |             <scope>test</scope>
 41 |         </dependency>
 42 |         <dependency>
 43 |             <groupId>org.junit.platform</groupId>
 44 |             <artifactId>junit-platform-launcher</artifactId>
 45 |             <version>1.6.3</version>
 46 |             <scope>test</scope>
 47 |         </dependency>
 48 |         <dependency>
 49 |             <groupId>org.mockito</groupId>
 50 |             <artifactId>mockito-core</artifactId>
 51 |             <version>5.4.0</version>
 52 |             <scope>test</scope>
 53 |         </dependency>
 54 |         <dependency>
 55 |             <groupId>org.json</groupId>
 56 |             <artifactId>json</artifactId>
 57 |             <version>20230618</version>
 58 |             <scope>test</scope>
 59 |         </dependency>
 60 |     </dependencies>
 61 | 
 62 |     <build>
 63 |         <plugins>
 64 |             <plugin>
 65 |                 <groupId>org.apache.maven.plugins</groupId>
 66 |                 <artifactId>maven-compiler-plugin</artifactId>
 67 |                 <version>3.11.0</version>
 68 |                 <configuration>
 69 |                     <source>1.8</source>
 70 |                     <target>1.8</target>
 71 |                     <encoding>UTF-8</encoding>
 72 |                     <compilerArgs>
 73 |                         <arg>-Xlint:unchecked</arg>
 74 |                     </compilerArgs>
 75 |                     <showWarnings>true</showWarnings>
 76 |                     <showDeprecation>true</showDeprecation>
 77 |                 </configuration>
 78 |             </plugin>
 79 |             <plugin>
 80 |                 <groupId>org.apache.maven.plugins</groupId>
 81 |                 <artifactId>maven-source-plugin</artifactId>
 82 |                 <version>3.3.0</version>
 83 |                 <executions>
 84 |                     <execution>
 85 |                         <id>attach-sources</id>
 86 |                         <goals>
 87 |                             <goal>jar-no-fork</goal>
 88 |                         </goals>
 89 |                     </execution>
 90 |                 </executions>
 91 |             </plugin>
 92 |             <plugin>
 93 |                 <groupId>org.apache.maven.plugins</groupId>
 94 |                 <artifactId>maven-javadoc-plugin</artifactId>
 95 |                 <version>3.5.0</version>
 96 |                 <executions>
 97 |                     <execution>
 98 |                         <id>attach-javadocs</id>
 99 |                         <goals>
100 |                             <goal>jar</goal>
101 |                         </goals>
102 |                     </execution>
103 |                 </executions>
104 |                 <configuration>
105 |                     <additionalOptions>-Xdoclint:none</additionalOptions>
106 |                 </configuration>
107 |             </plugin>
108 |             <plugin>
109 |                 <groupId>org.apache.maven.plugins</groupId>
110 |                 <artifactId>maven-jar-plugin</artifactId>
111 |                 <version>3.3.0</version>
112 |             </plugin>
113 | 
114 |             <plugin>
115 |                 <groupId>org.codehaus.mojo</groupId>
116 |                 <artifactId>exec-maven-plugin</artifactId>
117 |                 <version>3.1.0</version>
118 |                 <executions>
119 |                     <execution>
120 |                         <id>npm-install-parser_v3</id>
121 |                         <phase>process-test-resources</phase>
122 |                         <goals>
123 |                             <goal>exec</goal>
124 |                         </goals>
125 |                         <configuration>
126 |                             <workingDirectory>./src/test/resources/parser_v3</workingDirectory>
127 |                             <executable>npm</executable>
128 |                             <arguments>
129 |                                 <argument>install</argument>
130 |                             </arguments>
131 |                         </configuration>
132 |                     </execution>
133 |                     <execution>
134 |                         <id>npm-install-parser_v4</id>
135 |                         <phase>process-test-resources</phase>
136 |                         <goals>
137 |                             <goal>exec</goal>
138 |                         </goals>
139 |                         <configuration>
140 |                             <workingDirectory>./src/test/resources/parser_v4</workingDirectory>
141 |                             <executable>npm</executable>
142 |                             <arguments>
143 |                                 <argument>install</argument>
144 |                             </arguments>
145 |                         </configuration>
146 |                     </execution>
147 |                 </executions>
148 |             </plugin>
149 |             <plugin>
150 |                 <groupId>org.apache.maven.plugins</groupId>
151 |                 <artifactId>maven-surefire-plugin</artifactId>
152 |                 <version>3.1.2</version>
153 |                 <configuration>
154 |                     <argLine>${argLine} -Dfile.encoding=UTF-8</argLine>
155 |                     <systemPropertyVariables>
156 |                         <java.util.logging.config.file>./src/test/resources/logging.properties</java.util.logging.config.file>
157 |                     </systemPropertyVariables>
158 |                     <parallel>both</parallel>
159 |                     <useUnlimitedThreads>true</useUnlimitedThreads>
160 |                 </configuration>
161 |             </plugin>
162 | 
163 |             <plugin>
164 |                 <groupId>org.jacoco</groupId>
165 |                 <artifactId>jacoco-maven-plugin</artifactId>
166 |                 <version>0.8.10</version>
167 |                 <executions>
168 |                     <execution>
169 |                         <id>prepare-agent</id>
170 |                         <goals>
171 |                             <goal>prepare-agent</goal>
172 |                         </goals>
173 |                     </execution>
174 |                     <execution>
175 |                         <id>report</id>
176 |                         <phase>test</phase>
177 |                         <goals>
178 |                             <goal>report</goal>
179 |                         </goals>
180 |                         <configuration>
181 |                             <includes>
182 |                                 <include>**/*.class</include>
183 |                             </includes>
184 |                         </configuration>
185 |                     </execution>
186 |                 </executions>
187 |             </plugin>
188 |         </plugins>
189 |     </build>
190 | </project>
191 | 


--------------------------------------------------------------------------------
/engine.io-server/src/main/java/io/socket/engineio/server/Emitter.java:
--------------------------------------------------------------------------------
  1 | package io.socket.engineio.server;
  2 | 
  3 | import java.util.ArrayList;
  4 | import java.util.Collections;
  5 | import java.util.Iterator;
  6 | import java.util.List;
  7 | import java.util.concurrent.ConcurrentHashMap;
  8 | import java.util.concurrent.ConcurrentLinkedQueue;
  9 | import java.util.concurrent.ConcurrentMap;
 10 | 
 11 | /**
 12 |  * The event emitter which is ported from the JavaScript module. This class is thread-safe.
 13 |  *
 14 |  * @see <a href="https://github.com/component/emitter">https://github.com/component/emitter</a>
 15 |  */
 16 | @SuppressWarnings({"UnusedReturnValue", "unused"})
 17 | public class Emitter {
 18 | 
 19 |     public interface Listener {
 20 | 
 21 |         void call(Object... args);
 22 |     }
 23 | 
 24 |     private class OnceListener implements Listener {
 25 | 
 26 |         public final String event;
 27 |         public final Listener fn;
 28 | 
 29 |         public OnceListener(String event, Listener fn) {
 30 |             this.event = event;
 31 |             this.fn = fn;
 32 |         }
 33 | 
 34 |         @Override
 35 |         public void call(Object... args) {
 36 |             Emitter.this.off(this.event, this);
 37 |             this.fn.call(args);
 38 |         }
 39 |     }
 40 | 
 41 |     private final ConcurrentMap<String, ConcurrentLinkedQueue<Listener>> mCallbacks = new ConcurrentHashMap<>();
 42 | 
 43 |     /**
 44 |      * Listens on the event.
 45 |      * @param event event name.
 46 |      * @param fn Event listener.
 47 |      * @return a reference to this object.
 48 |      */
 49 |     public Emitter on(String event, Listener fn) {
 50 |         this.mCallbacks.computeIfAbsent(event, s -> new ConcurrentLinkedQueue<>());
 51 |         final ConcurrentLinkedQueue<Listener> callbacks = this.mCallbacks.get(event);
 52 |         callbacks.add(fn);
 53 |         return this;
 54 |     }
 55 | 
 56 |     /**
 57 |      * Adds a one time listener for the event.
 58 |      *
 59 |      * @param event an event name.
 60 |      * @param fn Event listener.
 61 |      * @return a reference to this object.
 62 |      */
 63 |     public Emitter once(final String event, final Listener fn) {
 64 |         this.on(event, new OnceListener(event, fn));
 65 |         return this;
 66 |     }
 67 | 
 68 |     /**
 69 |      * Removes all registered listeners.
 70 |      *
 71 |      * @return a reference to this object.
 72 |      */
 73 |     public Emitter off() {
 74 |         this.mCallbacks.clear();
 75 |         return this;
 76 |     }
 77 | 
 78 |     /**
 79 |      * Removes all listeners of the specified event.
 80 |      *
 81 |      * @param event an event name.
 82 |      * @return a reference to this object.
 83 |      */
 84 |     public Emitter off(String event) {
 85 |         this.mCallbacks.remove(event);
 86 |         return this;
 87 |     }
 88 | 
 89 |     /**
 90 |      * Removes the listener.
 91 |      *
 92 |      * @param event an event name.
 93 |      * @param fn Event listener.
 94 |      * @return a reference to this object.
 95 |      */
 96 |     public Emitter off(String event, Listener fn) {
 97 |         final ConcurrentLinkedQueue<Listener> callbacks = this.mCallbacks.get(event);
 98 |         if (callbacks != null) {
 99 |             Iterator<Listener> it = callbacks.iterator();
100 |             while (it.hasNext()) {
101 |                 Listener internal = it.next();
102 |                 if (Emitter.sameAs(fn, internal)) {
103 |                     it.remove();
104 |                     break;
105 |                 }
106 |             }
107 |         }
108 |         return this;
109 |     }
110 | 
111 |     /**
112 |      * Executes each of listeners with the given args.
113 |      *
114 |      * @param event an event name.
115 |      * @param args Data to emit.
116 |      * @return a reference to this object.
117 |      */
118 |     public Emitter emit(String event, Object... args) {
119 |         final ConcurrentLinkedQueue<Listener> callbacks = this.mCallbacks.get(event);
120 |         if (callbacks != null) {
121 |             for (Listener fn : callbacks) {
122 |                 try {
123 |                     fn.call(args);
124 |                 } catch (Exception ignore) {
125 |                 }
126 |             }
127 |         }
128 |         return this;
129 |     }
130 | 
131 |     /**
132 |      * Returns a list of listeners for the specified event.
133 |      * The returned list is not modifiable.
134 |      *
135 |      * @param event an event name.
136 |      * @return a reference to this object.
137 |      */
138 |     public List<Listener> listeners(String event) {
139 |         final ConcurrentLinkedQueue<Listener> callbacks = this.mCallbacks.get(event);
140 |         return callbacks != null ? Collections.unmodifiableList(new ArrayList<>(callbacks)) : Collections.emptyList();
141 |     }
142 | 
143 |     /**
144 |      * Check if this emitter has listeners for the specified event.
145 |      *
146 |      * @param event an event name.
147 |      * @return a reference to this object.
148 |      */
149 |     public boolean hasListeners(String event) {
150 |         final ConcurrentLinkedQueue<Listener> callbacks = this.mCallbacks.get(event);
151 |         return callbacks != null && !callbacks.isEmpty();
152 |     }
153 | 
154 |     private static boolean sameAs(Listener fn, Listener internal) {
155 |         if (fn.equals(internal)) {
156 |             return true;
157 |         } else if (internal instanceof OnceListener) {
158 |             return fn.equals(((OnceListener) internal).fn);
159 |         } else {
160 |             return false;
161 |         }
162 |     }
163 | }
164 | 


--------------------------------------------------------------------------------
/engine.io-server/src/main/java/io/socket/engineio/server/EngineIoWebSocket.java:
--------------------------------------------------------------------------------
 1 | package io.socket.engineio.server;
 2 | 
 3 | import java.io.IOException;
 4 | import java.util.List;
 5 | import java.util.Map;
 6 | 
 7 | /**
 8 |  * Adapter between different WebSocket implementations and Engine.IO.
 9 |  */
10 | public abstract class EngineIoWebSocket extends Emitter {
11 | 
12 |     /**
13 |      * Get the query of the initial HTTP request.
14 |      *
15 |      * @return Query parameters of the initial HTTP request.
16 |      */
17 |     public abstract Map<String, String> getQuery();
18 | 
19 |     /**
20 |      * Get the headers in the initial HTTP request.
21 |      *
22 |      * @return Headers of the initial HTTP request.
23 |      */
24 |     public abstract Map<String, List<String>> getConnectionHeaders();
25 | 
26 |     /**
27 |      * Write a string to the WebSocket and send to remote client.
28 |      *
29 |      * @param message String payload to send.
30 |      * @throws IOException On write error.
31 |      */
32 |     public abstract void write(String message) throws IOException;
33 | 
34 |     /**
35 |      * Write a byte array to the WebSocket and send to remote client.
36 |      *
37 |      * @param message Binary payload to send.
38 |      * @throws IOException On write error.
39 |      */
40 |     public abstract void write(byte[] message) throws IOException;
41 | 
42 |     /**
43 |      * Close the WebSocket.
44 |      */
45 |     public abstract void close();
46 | }


--------------------------------------------------------------------------------
/engine.io-server/src/main/java/io/socket/engineio/server/ReadyState.java:
--------------------------------------------------------------------------------
 1 | package io.socket.engineio.server;
 2 | 
 3 | /**
 4 |  * The possible states a connection can be in at any given time.
 5 |  * These states also apply to transports.
 6 |  */
 7 | public enum ReadyState {
 8 |     /**
 9 |      * The connection is opening. No IO operation can be performed.
10 |      */
11 |     OPENING,
12 |     /**
13 |      * The connection is open. IO operations can be performed on it.
14 |      */
15 |     OPEN,
16 |     /**
17 |      * The connection is closing. No IO operation can be performed.
18 |      */
19 |     CLOSING,
20 |     /**
21 |      * The connection is closed. No IO operation can be performed.
22 |      */
23 |     CLOSED
24 | }


--------------------------------------------------------------------------------
/engine.io-server/src/main/java/io/socket/engineio/server/ServerErrors.java:
--------------------------------------------------------------------------------
 1 | package io.socket.engineio.server;
 2 | 
 3 | enum ServerErrors {
 4 |     UNKNOWN_TRANSPORT(0, "Transport unknown"),
 5 |     UNKNOWN_SID(1, "Session ID unknown"),
 6 |     BAD_HANDSHAKE_METHOD(2, "Bad handshake method"),
 7 |     BAD_REQUEST(3, "Bad request"),
 8 |     FORBIDDEN(4, "Forbidden"),
 9 |     UNSUPPORTED_PROTOCOL_VERSION(5, "Unsupported protocol version");
10 | 
11 |     private final int mCode;
12 |     private final String mMessage;
13 | 
14 |     ServerErrors(int code, String message) {
15 |         mCode = code;
16 |         mMessage = message;
17 |     }
18 | 
19 |     public int getCode() {
20 |         return mCode;
21 |     }
22 | 
23 |     public String getMessage() {
24 |         return mMessage;
25 |     }
26 | }


--------------------------------------------------------------------------------
/engine.io-server/src/main/java/io/socket/engineio/server/Transport.java:
--------------------------------------------------------------------------------
  1 | package io.socket.engineio.server;
  2 | 
  3 | import io.socket.engineio.server.parser.Packet;
  4 | import io.socket.engineio.server.parser.Parser;
  5 | import jakarta.servlet.http.HttpServletRequest;
  6 | import jakarta.servlet.http.HttpServletResponse;
  7 | 
  8 | import java.io.IOException;
  9 | import java.util.List;
 10 | import java.util.Map;
 11 | 
 12 | /**
 13 |  * Base class for all transports.
 14 |  */
 15 | public abstract class Transport extends Emitter {
 16 | 
 17 |     protected final Parser mParser;
 18 |     protected ReadyState mReadyState;
 19 | 
 20 |     protected Transport(Parser parser) {
 21 |         mParser = parser;
 22 |         mReadyState = ReadyState.OPEN;
 23 |     }
 24 | 
 25 |     /**
 26 |      * Get the query parameters of the initial HTTP request.
 27 |      *
 28 |      * @return Query parameters of the initial HTTP request.
 29 |      */
 30 |     public abstract Map<String, String> getInitialQuery();
 31 | 
 32 |     /**
 33 |      * Get the headers of the initial HTTP request.
 34 |      *
 35 |      * @return Headers of the initial HTTP request.
 36 |      */
 37 |     public abstract Map<String, List<String>> getInitialHeaders();
 38 | 
 39 |     /**
 40 |      * Handle a client HTTP request.
 41 |      *
 42 |      * @param request The HTTP request object.
 43 |      * @param response The HTTP response object.
 44 |      * @throws IOException On IO error.
 45 |      */
 46 |     public abstract void onRequest(HttpServletRequest request, HttpServletResponse response) throws IOException;
 47 | 
 48 |     /**
 49 |      * Send a list of packets over the transport.
 50 |      *
 51 |      * @param packets List of packets to send.
 52 |      */
 53 |     public abstract void send(List<Packet<?>> packets);
 54 | 
 55 |     /**
 56 |      * Checks whether the transport is currently writable.
 57 |      *
 58 |      * @return Boolean value indicating if transport can be written to.
 59 |      */
 60 |     public abstract boolean isWritable();
 61 | 
 62 |     /**
 63 |      * Get the name of this transport.
 64 |      *
 65 |      * @return Name of transport.
 66 |      */
 67 |     public abstract String getName();
 68 | 
 69 |     /**
 70 |      * Transport specific logic for closing transport.
 71 |      */
 72 |     protected abstract void doClose();
 73 | 
 74 |     /**
 75 |      * Close the transport if not already closed.
 76 |      */
 77 |     public void close() {
 78 |         if(mReadyState != ReadyState.CLOSED && mReadyState != ReadyState.CLOSING) {
 79 |             mReadyState = ReadyState.CLOSING;
 80 |             doClose();
 81 |         }
 82 |     }
 83 | 
 84 |     /**
 85 |      * Called by child class to indicate error with transport.
 86 |      *
 87 |      * @param reason Reason of error.
 88 |      * @param description Description of error.
 89 |      */
 90 |     protected void onError(String reason, String description) {
 91 |         if(this.listeners("error").size() > 0) {
 92 |             emit("error", reason, description);
 93 |         }
 94 |     }
 95 | 
 96 |     /**
 97 |      * Called by child to indicate a packet receive from remote client.
 98 |      *
 99 |      * @param packet Packet received by transport.
100 |      */
101 |     protected void onPacket(Packet<?> packet) {
102 |         emit("packet", packet);
103 |     }
104 | 
105 |     /**
106 |      * Called by child to indicate data received from remote client.
107 |      *
108 |      * @param data Encoded data received by transport.
109 |      */
110 |     protected void onData(Object data) {
111 |         onPacket(mParser.decodePacket(data));
112 |     }
113 | 
114 |     /**
115 |      * Called by child to indicate closure of transport.
116 |      */
117 |     protected void onClose() {
118 |         mReadyState = ReadyState.CLOSED;
119 |         emit("close");
120 |     }
121 | }


--------------------------------------------------------------------------------
/engine.io-server/src/main/java/io/socket/engineio/server/package-info.java:
--------------------------------------------------------------------------------
1 | /**
2 |  * Main engine.io classes.
3 |  */
4 | package io.socket.engineio.server;


--------------------------------------------------------------------------------
/engine.io-server/src/main/java/io/socket/engineio/server/parser/Packet.java:
--------------------------------------------------------------------------------
 1 | package io.socket.engineio.server.parser;
 2 | 
 3 | public final class Packet<T> {
 4 | 
 5 |     static final public String OPEN = "open";
 6 |     static final public String CLOSE = "close";
 7 |     static final public String PING = "ping";
 8 |     static final public String PONG = "pong";
 9 |     static final public String UPGRADE = "upgrade";
10 |     static final public String MESSAGE = "message";
11 |     static final public String NOOP = "noop";
12 |     static final public String ERROR = "error";
13 | 
14 |     public String type;
15 |     public T data;
16 | 
17 |     public Packet(String type) {
18 |         this(type, null);
19 |     }
20 | 
21 |     public Packet(String type, T data) {
22 |         this.type = type;
23 |         this.data = data;
24 |     }
25 | }
26 | 


--------------------------------------------------------------------------------
/engine.io-server/src/main/java/io/socket/engineio/server/parser/Parser.java:
--------------------------------------------------------------------------------
 1 | package io.socket.engineio.server.parser;
 2 | 
 3 | import java.util.Collections;
 4 | import java.util.HashMap;
 5 | import java.util.List;
 6 | import java.util.Map;
 7 | 
 8 | public interface Parser {
 9 | 
10 |     Map<String, Integer> PACKETS = Collections.unmodifiableMap(new HashMap<String, Integer>() {{
11 |         put(Packet.OPEN, 0);
12 |         put(Packet.CLOSE, 1);
13 |         put(Packet.PING, 2);
14 |         put(Packet.PONG, 3);
15 |         put(Packet.MESSAGE, 4);
16 |         put(Packet.UPGRADE, 5);
17 |         put(Packet.NOOP, 6);
18 |     }});
19 |     Map<Integer, String> PACKETS_REVERSE = Collections.unmodifiableMap(new HashMap<Integer, String>() {{
20 |         put(0, Packet.OPEN);
21 |         put(1, Packet.CLOSE);
22 |         put(2, Packet.PING);
23 |         put(3, Packet.PONG);
24 |         put(4, Packet.MESSAGE);
25 |         put(5, Packet.UPGRADE);
26 |         put(6, Packet.NOOP);
27 |     }});
28 | 
29 |     Packet<String> ERROR_PACKET = new Packet<>(Packet.ERROR, "parser error");
30 | 
31 |     Parser PROTOCOL_V3 = new ParserV3();
32 |     Parser PROTOCOL_V4 = new ParserV4();
33 | 
34 |     interface EncodeCallback<T> {
35 |         void call(T data);
36 |     }
37 | 
38 |     interface DecodePayloadCallback<T> {
39 |         boolean call(Packet<T> packet, int index, int total);
40 |     }
41 | 
42 |     int getProtocolVersion();
43 | 
44 |     void encodePacket(Packet<?> packet, boolean supportsBinary, EncodeCallback<Object> callback);
45 |     Packet<?> decodePacket(Object data);
46 | 
47 |     void encodePayload(List<Packet<?>> packets, boolean supportsBinary, EncodeCallback<Object> callback);
48 |     void decodePayload(Object data, DecodePayloadCallback<Object> callback);
49 | }
50 | 


--------------------------------------------------------------------------------
/engine.io-server/src/main/java/io/socket/engineio/server/parser/ParserV3.java:
--------------------------------------------------------------------------------
  1 | package io.socket.engineio.server.parser;
  2 | 
  3 | import java.nio.charset.StandardCharsets;
  4 | import java.util.ArrayList;
  5 | import java.util.Base64;
  6 | import java.util.List;
  7 | 
  8 | @SuppressWarnings("unchecked")
  9 | public final class ParserV3 implements Parser {
 10 | 
 11 |     public static final int PROTOCOL = 3;
 12 | 
 13 |     @Override
 14 |     public int getProtocolVersion() {
 15 |         return PROTOCOL;
 16 |     }
 17 | 
 18 |     /**
 19 |      * Encode a packet for transfer over transport.
 20 |      *
 21 |      * @param packet The packet to encode.
 22 |      * @param supportsBinary Whether the transport supports binary encoding.
 23 |      * @param callback The callback to be called with the encoded data.
 24 |      */
 25 |     @Override
 26 |     public void encodePacket(Packet<?> packet, boolean supportsBinary, EncodeCallback<Object> callback) {
 27 |         if (packet.data instanceof byte[]) {
 28 |             encodeByteArray((Packet<byte[]>) packet, supportsBinary, callback);
 29 |         } else {
 30 |             String encoded = String.valueOf(PACKETS.get(packet.type));
 31 | 
 32 |             if (null != packet.data) {
 33 |                 encoded += String.valueOf(packet.data);
 34 |             }
 35 | 
 36 |             callback.call(encoded);
 37 |         }
 38 |     }
 39 | 
 40 |     public static void encodeByteArray(Packet<byte[]> packet, boolean supportsBinary, EncodeCallback<Object> callback) {
 41 |         if (supportsBinary) {
 42 |             byte[] data = packet.data;
 43 |             byte[] resultArray = new byte[1 + data.length];
 44 |             resultArray[0] = PACKETS.get(packet.type).byteValue();
 45 |             System.arraycopy(data, 0, resultArray, 1, data.length);
 46 |             callback.call(resultArray);
 47 |         } else {
 48 |             String resultBuilder = "b" +
 49 |                     PACKETS.get(packet.type).byteValue() +
 50 |                     Base64.getEncoder().encodeToString(packet.data);
 51 |             callback.call(resultBuilder);
 52 |         }
 53 |     }
 54 | 
 55 |     /**
 56 |      * Encode an array of packets into a payload for transfer over transport.
 57 |      *
 58 |      * @param packets Array of packets to encode.
 59 |      * @param supportsBinary Whether the transport supports binary encoding.
 60 |      * @param callback The callback to be called with the encoded data.
 61 |      */
 62 |     @Override
 63 |     public void encodePayload(List<Packet<?>> packets, boolean supportsBinary, EncodeCallback<Object> callback) {
 64 |         boolean isBinary = false;
 65 |         for (Packet<?> packet : packets) {
 66 |             if (packet.data instanceof byte[]) {
 67 |                 isBinary = true;
 68 |                 break;
 69 |             }
 70 |         }
 71 | 
 72 |         if (isBinary && supportsBinary) {
 73 |             encodePayloadAsBinary(packets, callback);
 74 |             return;
 75 |         }
 76 | 
 77 |         if (packets.size() == 0) {
 78 |             callback.call("0:");
 79 |             return;
 80 |         }
 81 | 
 82 |         final StringBuilder result = new StringBuilder();
 83 | 
 84 |         for (Packet<?> packet : packets) {
 85 |             encodePacket(packet, false, data -> result.append(setLengthHeader((String) data)));
 86 |         }
 87 | 
 88 |         callback.call(result.toString());
 89 |     }
 90 | 
 91 |     /**
 92 |      * Decode payload received from transport.
 93 |      *
 94 |      * @param data Data received from transport.
 95 |      * @param callback The callback to be called with each decoded packet in payload.
 96 |      */
 97 |     @Override
 98 |     public void decodePayload(Object data, DecodePayloadCallback<Object> callback) {
 99 |         assert callback != null;
100 | 
101 |         final ArrayList<Packet<?>> packets = new ArrayList<>();
102 |         if(data instanceof String) {
103 |             final String stringData = (String) data;
104 |             for (int payloadIdx = 0; payloadIdx < stringData.length(); ) {
105 |                 final int separatorIdx = stringData.indexOf(':', payloadIdx);
106 |                 if(separatorIdx < 0) {
107 |                     throw new IllegalArgumentException("Invalid payload: " + stringData);
108 |                 }
109 | 
110 |                 int length = Integer.parseInt(stringData.substring(payloadIdx, separatorIdx));
111 |                 String packetData = stringData.substring(
112 |                         separatorIdx + 1,
113 |                         length + separatorIdx + 1);
114 |                 packets.add(decodePacket(packetData));
115 | 
116 |                 payloadIdx = length + separatorIdx + 1;
117 |             }
118 |         } else if(data instanceof byte[]) {
119 |             final byte[] byteData = (byte[]) data;
120 |             for (int payloadIdx = 0; payloadIdx < byteData.length; ) {
121 |                 final boolean isBinary = (byteData[payloadIdx] == 1);
122 |                 final int lengthStartIdx = payloadIdx + 1;
123 |                 int lengthEndIdx = lengthStartIdx;
124 |                 while (byteData[lengthEndIdx] != -1) {
125 |                     lengthEndIdx++;
126 |                 }
127 | 
128 |                 StringBuilder lengthString = new StringBuilder();
129 |                 for (int l = lengthStartIdx; l < lengthEndIdx; l++) {
130 |                     char digit = (char) ('0' + byteData[l]);
131 |                     lengthString.append(digit);
132 |                 }
133 |                 final int length = Integer.parseInt(lengthString.toString());
134 | 
135 |                 byte[] bufferData = new byte[length];
136 |                 System.arraycopy(byteData, lengthEndIdx + 1, bufferData, 0, bufferData.length);
137 | 
138 |                 Packet<?> packet;
139 |                 if(isBinary) {
140 |                     packet = decodePacket(bufferData);
141 |                 } else {
142 |                     packet = decodePacket(new String(bufferData, StandardCharsets.UTF_8));
143 |                 }
144 |                 packets.add(packet);
145 | 
146 |                 payloadIdx = lengthEndIdx + length + 1;
147 |             }
148 |         }
149 | 
150 |         for (int i = 0; i < packets.size(); i++) {
151 |             if(!callback.call((Packet<Object>) packets.get(i), i, packets.size())) {
152 |                 return;
153 |             }
154 |         }
155 |     }
156 | 
157 |     /**
158 |      * Encode an array of packets into a binary payload for transfer over transport.
159 |      *  @param packets Array of packets to encode.
160 |      * @param callback The callback to be called with the encoded data.
161 |      */
162 |     @SuppressWarnings("Duplicates")
163 |     public void encodePayloadAsBinary(List<Packet<?>> packets, EncodeCallback<Object> callback) {
164 |         if (packets.size() == 0) {
165 |             callback.call(new byte[0]);
166 |             return;
167 |         }
168 | 
169 |         final ArrayList<byte[]> results = new ArrayList<>(packets.size());
170 | 
171 |         for (Packet<?> packet : packets) {
172 |             encodePacket(packet, true, encodedPacket -> {
173 |                 if (encodedPacket instanceof String) {
174 |                     final String encodingLength = Integer.toString(((String) encodedPacket).length(), 10);
175 |                     final byte[] sizeBuffer = new byte[encodingLength.length() + 2];
176 | 
177 |                     sizeBuffer[0] = (byte)0; // is a string
178 |                     for (int i = 0; i < encodingLength.length(); i ++) {
179 |                         sizeBuffer[i + 1] = (byte)(encodingLength.charAt(i) - '0');
180 |                     }
181 |                     sizeBuffer[sizeBuffer.length - 1] = (byte)255;
182 |                     results.add(concatBuffer(sizeBuffer, ((String) encodedPacket).getBytes(StandardCharsets.UTF_8)));
183 |                 } else {
184 |                     final String encodingLength = String.valueOf(((byte[]) encodedPacket).length);
185 |                     final byte[] sizeBuffer = new byte[encodingLength.length() + 2];
186 | 
187 |                     sizeBuffer[0] = (byte)1; // is binary
188 |                     for (int i = 0; i < encodingLength.length(); i ++) {
189 |                         sizeBuffer[i + 1] = (byte)(encodingLength.charAt(i) - '0');
190 |                     }
191 |                     sizeBuffer[sizeBuffer.length - 1] = (byte)255;
192 |                     results.add(concatBuffer(sizeBuffer, (byte[]) encodedPacket));
193 |                 }
194 |             });
195 |         }
196 | 
197 |         callback.call(concatBuffer(results.toArray(new byte[results.size()][])));
198 |     }
199 | 
200 |     /**
201 |      * Decode a packet received from transport.
202 |      *
203 |      * @param data Data received from transport.
204 |      * @return Packet decoded from data.
205 |      */
206 |     @Override
207 |     public Packet<?> decodePacket(Object data) {
208 |         if(data == null) {
209 |             return ERROR_PACKET;
210 |         }
211 | 
212 |         if(data instanceof String) {
213 |             final String stringData = (String) data;
214 |             if(stringData.charAt(0) == 'b') {
215 |                 final Packet<byte[]> packet = new Packet<>(PACKETS_REVERSE.get(
216 |                         Integer.parseInt(String.valueOf(stringData.charAt(1)))));
217 |                 packet.data = Base64.getDecoder().decode(stringData.substring(2));
218 |                 return packet;
219 |             } else {
220 |                 final Packet<String> packet = new Packet<>(PACKETS_REVERSE.get(
221 |                         Integer.parseInt(String.valueOf(stringData.charAt(0)))));
222 |                 packet.data = stringData.substring(1);
223 |                 return packet;
224 |             }
225 |         } else if(data instanceof byte[]) {
226 |             final byte[] byteData = (byte[]) data;
227 |             final Packet<byte[]> packet = new Packet<>(PACKETS_REVERSE.get((int) byteData[0]));
228 |             packet.data = new byte[byteData.length - 1];
229 |             System.arraycopy(byteData, 1, packet.data, 0, packet.data.length);
230 |             return packet;
231 |         } else {
232 |             throw new IllegalArgumentException("Invalid type for data: " + data.getClass().getSimpleName());
233 |         }
234 |     }
235 | 
236 |     private static String setLengthHeader(String message) {
237 |         return message.length() + ":" + message;
238 |     }
239 | 
240 |     private static byte[] concatBuffer(byte[]... arrays) {
241 |         int length = 0;
242 |         for (byte[] item : arrays) {
243 |             length += item.length;
244 |         }
245 | 
246 |         final byte[] result = new byte[length];
247 |         int idx = 0;
248 |         for (byte[] item : arrays) {
249 |             System.arraycopy(item, 0, result, idx, item.length);
250 |             idx += item.length;
251 |         }
252 | 
253 |         return result;
254 |     }
255 | }
256 | 


--------------------------------------------------------------------------------
/engine.io-server/src/main/java/io/socket/engineio/server/parser/ParserV4.java:
--------------------------------------------------------------------------------
  1 | package io.socket.engineio.server.parser;
  2 | 
  3 | import java.util.ArrayList;
  4 | import java.util.Base64;
  5 | import java.util.List;
  6 | 
  7 | @SuppressWarnings("unchecked")
  8 | public final class ParserV4 implements Parser {
  9 | 
 10 |     public static final int PROTOCOL = 4;
 11 |     private static final String SEPARATOR = "\u001E";   // (char) 30
 12 | 
 13 |     @Override
 14 |     public int getProtocolVersion() {
 15 |         return PROTOCOL;
 16 |     }
 17 | 
 18 |     /**
 19 |      * Encode a packet for transfer over transport.
 20 |      *
 21 |      * @param packet The packet to encode.
 22 |      * @param supportsBinary Whether the transport supports binary encoding.
 23 |      * @param callback The callback to be called with the encoded data.
 24 |      */
 25 |     @Override
 26 |     public void encodePacket(Packet<?> packet, boolean supportsBinary, EncodeCallback<Object> callback) {
 27 |         if (packet.data instanceof byte[]) {
 28 |             encodeByteArray((Packet<byte[]>) packet, supportsBinary, callback);
 29 |         } else {
 30 |             String encoded = String.valueOf(PACKETS.get(packet.type));
 31 | 
 32 |             if (null != packet.data) {
 33 |                 encoded += String.valueOf(packet.data);
 34 |             }
 35 | 
 36 |             callback.call(encoded);
 37 |         }
 38 |     }
 39 | 
 40 |     public static void encodeByteArray(Packet<byte[]> packet, boolean supportsBinary, EncodeCallback<Object> callback) {
 41 |         if (supportsBinary) {
 42 |             callback.call(packet.data);
 43 |         } else {
 44 |             final String resultBuilder = "b" +
 45 |                     Base64.getEncoder().encodeToString(packet.data);
 46 |             callback.call(resultBuilder);
 47 |         }
 48 |     }
 49 | 
 50 |     /**
 51 |      * Encode an array of packets into a payload for transfer over transport.
 52 |      *
 53 |      * @param packets Array of packets to encode.
 54 |      * @param callback The callback to be called with the encoded data.
 55 |      */
 56 |     @Override
 57 |     public void encodePayload(List<Packet<?>> packets, boolean supportsBinary, EncodeCallback<Object> callback) {
 58 |         final String[] encodedPackets = new String[packets.size()];
 59 |         for (int i = 0; i < encodedPackets.length; i++) {
 60 |             final Packet<?> packet = packets.get(i);
 61 | 
 62 |             final int packetIdx = i;
 63 |             encodePacket(packet, false, data -> encodedPackets[packetIdx] = (String) data);
 64 |         }
 65 | 
 66 |         callback.call(String.join(SEPARATOR, encodedPackets));
 67 |     }
 68 | 
 69 |     /**
 70 |      * Decode payload received from transport.
 71 |      *
 72 |      * @param data Data received from transport.
 73 |      * @param callback The callback to be called with each decoded packet in payload.
 74 |      */
 75 |     @Override
 76 |     public void decodePayload(Object data, DecodePayloadCallback<Object> callback) {
 77 |         assert callback != null;
 78 | 
 79 |         final ArrayList<Packet<?>> packets = new ArrayList<>();
 80 |         if(data instanceof String) {
 81 |             final String[] encodedPackets = ((String) data).split(SEPARATOR);
 82 |             for (String encodedPacket : encodedPackets) {
 83 |                 final Packet<?> packet = decodePacket(encodedPacket);
 84 |                 packets.add(packet);
 85 | 
 86 |                 if (packet.type.equals("error")) {
 87 |                     break;
 88 |                 }
 89 |             }
 90 |         } else {
 91 |             throw new IllegalArgumentException("data must be a String");
 92 |         }
 93 | 
 94 |         for (int i = 0; i < packets.size(); i++) {
 95 |             if(!callback.call((Packet<Object>) packets.get(i), i, packets.size())) {
 96 |                 return;
 97 |             }
 98 |         }
 99 |     }
100 | 
101 |     /**
102 |      * Decode a packet received from transport.
103 |      *
104 |      * @param data Data received from transport.
105 |      * @return Packet decoded from data.
106 |      */
107 |     @Override
108 |     public Packet<?> decodePacket(Object data) {
109 |         if(data == null) {
110 |             return ERROR_PACKET;
111 |         }
112 | 
113 |         if(data instanceof String) {
114 |             final String stringData = (String) data;
115 |             if(stringData.charAt(0) == 'b') {
116 |                 final Packet<byte[]> packet = new Packet<>(Packet.MESSAGE);
117 |                 packet.data = java.util.Base64.getDecoder().decode(stringData.substring(1));
118 |                 return packet;
119 |             } else {
120 |                 final Packet<String> packet = new Packet<>(PACKETS_REVERSE.get(
121 |                         Integer.parseInt(String.valueOf(stringData.charAt(0)))));
122 |                 packet.data = stringData.substring(1);
123 |                 return packet;
124 |             }
125 |         } else if(data instanceof byte[]) {
126 |             return new Packet<>(Packet.MESSAGE, (byte[]) data);
127 |         } else {
128 |             throw new IllegalArgumentException("Invalid type for data: " + data.getClass().getSimpleName());
129 |         }
130 |     }
131 | }
132 | 


--------------------------------------------------------------------------------
/engine.io-server/src/main/java/io/socket/engineio/server/parser/package-info.java:
--------------------------------------------------------------------------------
1 | /**
2 |  * Parser classes used by engine.io.
3 |  */
4 | package io.socket.engineio.server.parser;


--------------------------------------------------------------------------------
/engine.io-server/src/main/java/io/socket/engineio/server/transport/WebSocket.java:
--------------------------------------------------------------------------------
 1 | package io.socket.engineio.server.transport;
 2 | 
 3 | import io.socket.engineio.server.parser.Parser;
 4 | import io.socket.engineio.server.parser.Packet;
 5 | import io.socket.engineio.server.EngineIoWebSocket;
 6 | import io.socket.engineio.server.Transport;
 7 | import jakarta.servlet.http.HttpServletRequest;
 8 | import jakarta.servlet.http.HttpServletResponse;
 9 | 
10 | import java.io.IOException;
11 | import java.util.List;
12 | import java.util.Map;
13 | 
14 | /**
15 |  * WebSocket transport.
16 |  */
17 | public final class WebSocket extends Transport {
18 | 
19 |     public static final String NAME = "websocket";
20 | 
21 |     private final EngineIoWebSocket mConnection;
22 | 
23 |     public WebSocket(EngineIoWebSocket webSocket, Parser parser) {
24 |         super(parser);
25 |         mConnection = webSocket;
26 |         mConnection.on("message", args -> onData(args[0]));
27 |         mConnection.on("close", args -> onClose());
28 |         mConnection.on("error", args -> onError((String) args[0], (String) args[1]));
29 |     }
30 | 
31 |     @Override
32 |     public Map<String, String> getInitialQuery() {
33 |         return mConnection.getQuery();
34 |     }
35 | 
36 |     @Override
37 |     public Map<String, List<String>> getInitialHeaders() {
38 |         return mConnection.getConnectionHeaders();
39 |     }
40 | 
41 |     @Override
42 |     public void onRequest(HttpServletRequest request, HttpServletResponse response) { }
43 | 
44 |     @Override
45 |     public void send(List<Packet<?>> packets) {
46 |         final Parser.EncodeCallback<Object> encodeCallback = data -> {
47 |             try {
48 |                 if(data instanceof String) {
49 |                     mConnection.write((String) data);
50 |                 } else if(data instanceof byte[]) {
51 |                     mConnection.write((byte[]) data);
52 |                 }
53 |             } catch (IOException ex) {
54 |                 onError("write error", ex.getMessage());
55 |             }
56 |         };
57 |         for (Packet<?> packet : packets) {
58 |             mParser.encodePacket(packet, true, encodeCallback);
59 |         }
60 |     }
61 | 
62 |     @Override
63 |     public boolean isWritable() {
64 |         return true;
65 |     }
66 | 
67 |     @Override
68 |     public String getName() {
69 |         return NAME;
70 |     }
71 | 
72 |     @Override
73 |     protected void doClose() {
74 |         mConnection.close();
75 |     }
76 | }


--------------------------------------------------------------------------------
/engine.io-server/src/main/java/io/socket/engineio/server/transport/package-info.java:
--------------------------------------------------------------------------------
1 | /**
2 |  * Transport classes used by engine.io.
3 |  */
4 | package io.socket.engineio.server.transport;


--------------------------------------------------------------------------------
/engine.io-server/src/main/java/io/socket/engineio/server/utils/JsonUtils.java:
--------------------------------------------------------------------------------
 1 | package io.socket.engineio.server.utils;
 2 | 
 3 | import java.util.Arrays;
 4 | import java.util.Locale;
 5 | 
 6 | public interface JsonUtils {
 7 | 
 8 |     /**
 9 |      * Replacements for the first 255 characters
10 |      */
11 |     String[] REPLACEMENTS = new String[] {
12 |             "\\u0000", "\\u0001", "\\u0002", "\\u0003", "\\u0004", "\\u0005", "\\u0006", "\\u0007", "\\u0008", "\\u0009", "\\u000A", "\\u000B", "\\u000C", "\\u000D", "\\u000E", "\\u000F",
13 |             "\\u0010", "\\u0011", "\\u0012", "\\u0013", "\\u0014", "\\u0015", "\\u0016", "\\u0017", "\\u0018", "\\u0019", "\\u001A", "\\u001B", "\\u001C", "\\u001D", "\\u001E", "\\u001F",
14 |             null, null, "\\\"", null, null, null, null, null, null, null, null, null, null, null, null, null,
15 |             null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null,
16 |             null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null,
17 |             null, null, null, null, null, null, null, null, null, null, null, null, "\\\\", null, null, null,
18 |             null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null,
19 |             null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null,
20 |     };
21 | 
22 |     String EMPTY_ARRAY = "[]";
23 | 
24 |     static String toJson(String[] array) {
25 |         if (array.length <= 0) {
26 |             return EMPTY_ARRAY;
27 |         }
28 | 
29 |         return '[' +
30 |                 String.join(",", Arrays.stream(array).map(s -> "\"" + escape(s) + "\"").toArray(String[]::new)) +
31 |                 ']';
32 |     }
33 | 
34 |     static String escape(String input) {
35 |         if (input == null) {
36 |             return null;
37 |         }
38 | 
39 |         final StringBuilder sb = new StringBuilder(input.length());
40 |         for (int i = 0; i < input.length(); i++) {
41 |             final char ch = input.charAt(i);
42 |             if (ch < 0x80) {
43 |                 final String replacement = REPLACEMENTS[ch];
44 |                 if (replacement != null) {
45 |                     sb.append(replacement);
46 |                     continue;
47 |                 }
48 |             } else if (ch < 0x100) {
49 |                 sb.append("\\u00").append(Integer.toHexString(ch).toLowerCase(Locale.ROOT));
50 |                 continue;
51 |             }
52 | 
53 |             sb.append(ch);
54 |         }
55 |         return sb.toString();
56 |     }
57 | }
58 | 


--------------------------------------------------------------------------------
/engine.io-server/src/main/java/io/socket/engineio/server/utils/ParseQS.java:
--------------------------------------------------------------------------------
 1 | package io.socket.engineio.server.utils;
 2 | 
 3 | 
 4 | import java.io.UnsupportedEncodingException;
 5 | import java.net.URLDecoder;
 6 | import java.net.URLEncoder;
 7 | import java.nio.charset.StandardCharsets;
 8 | import java.util.Arrays;
 9 | import java.util.Map;
10 | import java.util.stream.Collectors;
11 | 
12 | public interface ParseQS {
13 | 
14 |     static String encode(Map<String, String> query) {
15 |         return query.entrySet().stream()
16 |                 .map(entry -> {
17 |                     try {
18 |                         return URLEncoder.encode(entry.getKey(), StandardCharsets.UTF_8.name()) +
19 |                                 ((entry.getValue() != null && !entry.getValue().equals("")) ?
20 |                                         ("=" + URLEncoder.encode(entry.getValue(), StandardCharsets.UTF_8.name())) : "");
21 |                     } catch (UnsupportedEncodingException ignore) {
22 |                         throw new RuntimeException("This will never happen");
23 |                     }
24 |                 })
25 |                 .reduce((s1, s2) -> s1 + "&" + s2)
26 |                 .orElse("");
27 |     }
28 | 
29 |     static Map<String, String> decode(String qs) {
30 |         return Arrays.stream(qs.split("&"))
31 |                 .map(s -> s.split("="))
32 |                 .collect(Collectors.toMap(
33 |                         s -> {
34 |                             try {
35 |                                 return URLDecoder.decode(s[0], StandardCharsets.UTF_8.name());
36 |                             } catch (UnsupportedEncodingException ignore) {
37 |                                 throw new RuntimeException("This will never happen");
38 |                             }
39 |                         },
40 |                         s -> {
41 |                             try {
42 |                                 return (s.length > 1) ? URLDecoder.decode(s[1], StandardCharsets.UTF_8.name()) : "";
43 |                             } catch (UnsupportedEncodingException ignore) {
44 |                                 throw new RuntimeException("This will never happen");
45 |                             }
46 |                         }));
47 |     }
48 | }
49 | 


--------------------------------------------------------------------------------
/engine.io-server/src/main/java/io/socket/engineio/server/utils/ServerYeast.java:
--------------------------------------------------------------------------------
 1 | package io.socket.engineio.server.utils;
 2 | 
 3 | import java.security.SecureRandom;
 4 | 
 5 | public interface ServerYeast {
 6 | 
 7 |     /**
 8 |      * A ThreadLocal is used to improve thread performance since {@link SecureRandom} do not perform well with
 9 |      * thread contention.
10 |      */
11 |     ThreadLocal<SecureRandom> THREAD_RANDOM = new ThreadLocal<>();
12 |     char[] ALPHABET = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-_".toCharArray();
13 | 
14 |     static String yeast() {
15 |         SecureRandom secureRandom = THREAD_RANDOM.get();
16 |         if (secureRandom == null) {
17 |             secureRandom = new SecureRandom();
18 |             THREAD_RANDOM.set(secureRandom);
19 |         }
20 | 
21 |         return encode(secureRandom.nextLong() & 0x7fffffffffffffffL);
22 |     }
23 | 
24 |     static String encode(long num) {
25 |         final StringBuilder encoded = new StringBuilder();
26 |         long dividedNum = num;
27 |         do {
28 |             encoded.insert(0, ALPHABET[(int)(dividedNum % ALPHABET.length)]);
29 |             dividedNum = dividedNum / ALPHABET.length;
30 |         } while (dividedNum > 0);
31 | 
32 |         return encoded.toString();
33 |     }
34 | }
35 | 


--------------------------------------------------------------------------------
/engine.io-server/src/test/java/io/socket/engineio/server/DeadLockTest.java:
--------------------------------------------------------------------------------
  1 | package io.socket.engineio.server;
  2 | 
  3 | import io.socket.engineio.server.parser.Packet;
  4 | import io.socket.engineio.server.parser.Parser;
  5 | import io.socket.engineio.server.parser.ParserV4;
  6 | import io.socket.engineio.server.transport.Polling;
  7 | import io.socket.engineio.server.utils.ParseQS;
  8 | import io.socket.engineio.server.utils.ServerYeast;
  9 | import jakarta.servlet.http.HttpServletRequest;
 10 | import org.junit.Assert;
 11 | import org.junit.Test;
 12 | import org.mockito.Mockito;
 13 | 
 14 | import java.io.IOException;
 15 | import java.lang.management.ManagementFactory;
 16 | import java.lang.management.ThreadMXBean;
 17 | import java.util.HashMap;
 18 | import java.util.Map;
 19 | import java.util.concurrent.Executors;
 20 | 
 21 | public final class DeadLockTest {
 22 | 
 23 | 	/**
 24 | 	 * Tests for deadlock of server.
 25 | 	 * If this runs for 60 seconds, we consider it a success.
 26 | 	 */
 27 | 	@Test
 28 | 	public void testTransportDeadlock() {
 29 | 		final Object lockObject = new Object();
 30 | 		final EngineIoSocket socket = new EngineIoSocket(lockObject,
 31 | 				ServerYeast.yeast(),
 32 | 				ParserV4.PROTOCOL,
 33 | 				new EngineIoServer(),
 34 | 				Executors.newSingleThreadScheduledExecutor());
 35 | 		final Transport transport = new Polling(lockObject, Parser.PROTOCOL_V4);
 36 | 		socket.init(transport);
 37 | 
 38 | 		final HttpServletRequest request = getConnectRequest(new HashMap<String, String>() {{
 39 | 				put("transport", Polling.NAME);
 40 | 		}});
 41 | 
 42 | 		final boolean[] terminate = new boolean[3];
 43 | 
 44 | 		final Thread sender = new Thread(() -> {
 45 | 			while (!terminate[1]) {
 46 | 				Packet<String> packet = new Packet<>(Packet.NOOP);
 47 | 				socket.send(packet);
 48 | 			}
 49 | 		});
 50 | 		sender.start();
 51 | 
 52 | 		final Thread poller = new Thread(() -> {
 53 | 			while (!terminate[2]) {
 54 | 				HttpServletResponseImpl response = new HttpServletResponseImpl();
 55 | 				try {
 56 | 					socket.onRequest(request, response);
 57 | 				} catch (IOException e) {
 58 | 					e.printStackTrace();
 59 | 					System.exit(-1);
 60 | 				}
 61 | 			}
 62 | 		});
 63 | 		poller.start();
 64 | 
 65 | 		final Thread interrupter = new Thread(() -> {
 66 | 			try {
 67 | 				Thread.sleep(60 * 1000);
 68 | 			} catch (InterruptedException ignore) {
 69 | 			}
 70 | 
 71 | 			terminate[0] = true;
 72 | 		});
 73 | 		interrupter.start();
 74 | 
 75 | 		boolean isDeadlocked = false;
 76 | 		while (!terminate[0]) {
 77 | 			ThreadMXBean mbean = ManagementFactory.getThreadMXBean();
 78 | 			long[] deadlockedThreadIds = mbean.findDeadlockedThreads();
 79 | 			if (deadlockedThreadIds != null && deadlockedThreadIds.length > 1) {
 80 | 				/*ThreadInfo[] threadInfos = mbean.getThreadInfo(deadlockedThreadIds);
 81 | 				Map<Thread, StackTraceElement[]> stackTraceMap = Thread.getAllStackTraces();
 82 | 				for (ThreadInfo threadInfo : threadInfos) {
 83 | 					if (threadInfo != null) {
 84 | 						for (Thread thread : stackTraceMap.keySet()) {
 85 | 							if (thread.getId() == threadInfo.getThreadId()) {
 86 | 								System.out.println(threadInfo.toString().trim());
 87 | 
 88 | 								for (StackTraceElement ste : thread.getStackTrace()) {
 89 | 									System.out.println("\t" + ste.toString().trim());
 90 | 								}
 91 | 							}
 92 | 						}
 93 | 					}
 94 | 				}*/
 95 | 				isDeadlocked = true;
 96 | 				terminate[0] = true;
 97 | 			}
 98 | 		}
 99 | 
100 | 		terminate[1] = true;
101 | 		terminate[2] = true;
102 | 
103 | 		Assert.assertFalse(isDeadlocked);
104 | 	}
105 | 
106 | 	private HttpServletRequest getConnectRequest(final Map<String, String> query) {
107 | 		final HashMap<String, Object> attributes = new HashMap<>();
108 | 		attributes.put("transport", Polling.NAME);
109 | 		attributes.put("j", "100");
110 | 		attributes.put("query", query);
111 | 		HttpServletRequest request = Mockito.mock(HttpServletRequest.class);
112 | 		Mockito.doAnswer(invocationOnMock -> ParseQS.encode(query)).when(request).getQueryString();
113 | 		Mockito.when(request.getMethod()).thenReturn("GET");
114 | 		Mockito.doAnswer(invocationOnMock -> {
115 | 			final String name = invocationOnMock.getArgument(0);
116 | 			final Object value = invocationOnMock.getArgument(1);
117 | 			attributes.put(name, value);
118 | 			return null;
119 | 		}).when(request).setAttribute(Mockito.anyString(), Mockito.any());
120 | 		Mockito.doAnswer(invocationOnMock -> attributes.get((String)invocationOnMock.getArgument(0)))
121 | 				.when(request)
122 | 				.getAttribute(Mockito.anyString());
123 | 		return request;
124 | 	}
125 | }


--------------------------------------------------------------------------------
/engine.io-server/src/test/java/io/socket/engineio/server/EmitterTest.java:
--------------------------------------------------------------------------------
  1 | package io.socket.engineio.server;
  2 | 
  3 | import org.junit.Assert;
  4 | import org.junit.Test;
  5 | import org.mockito.Mockito;
  6 | 
  7 | public final class EmitterTest {
  8 | 
  9 |     @Test
 10 |     public void testSingleListener() {
 11 |         final Emitter emitter = new Emitter();
 12 |         final Emitter.Listener listener = Mockito.mock(Emitter.Listener.class);
 13 | 
 14 |         emitter.on("event", listener);
 15 |         emitter.emit("event", "Engine.IO");
 16 | 
 17 |         Assert.assertTrue(emitter.hasListeners("event"));
 18 | 
 19 |         Mockito.verify(listener, Mockito.times(1))
 20 |                 .call(Mockito.eq("Engine.IO"));
 21 |     }
 22 | 
 23 |     @Test
 24 |     public void testMultipleListenersSameEvent() {
 25 |         final Emitter emitter = new Emitter();
 26 |         final Emitter.Listener[] listeners = new Emitter.Listener[3];
 27 |         for (int i = 0; i < listeners.length; i++) {
 28 |             listeners[i] = Mockito.mock(Emitter.Listener.class);
 29 |             emitter.on("event", listeners[i]);
 30 |         }
 31 | 
 32 |         emitter.emit("event", "Engine.IO");
 33 | 
 34 |         for (Emitter.Listener listener : listeners) {
 35 |             Mockito.verify(listener, Mockito.times(1))
 36 |                     .call(Mockito.eq("Engine.IO"));
 37 |         }
 38 |     }
 39 | 
 40 |     @Test
 41 |     public void testMultipleListenersDifferentEvents() {
 42 |         final Emitter emitter = new Emitter();
 43 |         final Emitter.Listener[] listeners = new Emitter.Listener[4];
 44 |         for (int i = 0; i < listeners.length; i++) {
 45 |             listeners[i] = Mockito.mock(Emitter.Listener.class);
 46 |         }
 47 | 
 48 |         emitter.on("event0", listeners[0]);
 49 |         emitter.on("event1", listeners[0]);
 50 |         emitter.on("event2", listeners[0]);
 51 |         emitter.on("event1", listeners[1]);
 52 |         emitter.on("event2", listeners[2]);
 53 | 
 54 |         emitter.emit("event0");
 55 |         emitter.emit("event1");
 56 |         emitter.emit("event2");
 57 |         emitter.emit("event3");
 58 | 
 59 |         Mockito.verify(listeners[0], Mockito.times(3)).call();
 60 |         Mockito.verify(listeners[1], Mockito.times(1)).call();
 61 |         Mockito.verify(listeners[2], Mockito.times(1)).call();
 62 |         Mockito.verify(listeners[3], Mockito.times(0)).call();
 63 |     }
 64 | 
 65 |     @Test
 66 |     public void testOnceListener() {
 67 |         final Emitter emitter = new Emitter();
 68 |         final Emitter.Listener listener1 = Mockito.mock(Emitter.Listener.class);
 69 |         final Emitter.Listener listener2 = Mockito.mock(Emitter.Listener.class);
 70 | 
 71 |         emitter.once("event", listener1);
 72 |         emitter.on("event", listener2);
 73 | 
 74 |         emitter.emit("event");
 75 |         emitter.emit("event");
 76 | 
 77 |         Mockito.verify(listener1, Mockito.times(1)).call();
 78 |         Mockito.verify(listener2, Mockito.times(2)).call();
 79 |     }
 80 | 
 81 |     @Test
 82 |     public void testAllOff() {
 83 |         final Emitter emitter = new Emitter();
 84 |         final Emitter.Listener listener = Mockito.mock(Emitter.Listener.class);
 85 | 
 86 |         emitter.on("event0", listener);
 87 |         emitter.on("event1", listener);
 88 | 
 89 |         emitter.emit("event0");
 90 |         emitter.emit("event1");
 91 | 
 92 |         Mockito.verify(listener, Mockito.times(2)).call();
 93 | 
 94 |         emitter.off();
 95 |         emitter.emit("event0");
 96 |         emitter.emit("event1");
 97 | 
 98 |         Mockito.verify(listener, Mockito.times(2)).call();
 99 |     }
100 | 
101 |     @Test
102 |     public void testEventOff() {
103 |         final Emitter emitter = new Emitter();
104 |         final Emitter.Listener listener = Mockito.mock(Emitter.Listener.class);
105 | 
106 |         emitter.on("event0", listener);
107 |         emitter.on("event1", listener);
108 | 
109 |         Assert.assertTrue(emitter.hasListeners("event0"));
110 |         Assert.assertTrue(emitter.hasListeners("event1"));
111 | 
112 |         emitter.emit("event0");
113 |         emitter.emit("event1");
114 | 
115 |         Mockito.verify(listener, Mockito.times(2)).call();
116 | 
117 |         emitter.off("event0");
118 | 
119 |         Assert.assertFalse(emitter.hasListeners("event0"));
120 |         Assert.assertTrue(emitter.hasListeners("event1"));
121 | 
122 |         emitter.emit("event0");
123 |         emitter.emit("event1");
124 | 
125 |         Mockito.verify(listener, Mockito.times(3)).call();
126 |     }
127 | 
128 |     @Test
129 |     public void testListenerOff() {
130 |         final Emitter emitter = new Emitter();
131 |         final Emitter.Listener listener0 = Mockito.mock(Emitter.Listener.class);
132 |         final Emitter.Listener listener1 = Mockito.mock(Emitter.Listener.class);
133 | 
134 |         emitter.on("event0", listener0);
135 |         emitter.on("event1", listener0);
136 |         emitter.on("event0", listener1);
137 |         emitter.on("event1", listener1);
138 | 
139 |         emitter.emit("event0");
140 |         emitter.emit("event1");
141 | 
142 |         Mockito.verify(listener0, Mockito.times(2)).call();
143 |         Mockito.verify(listener1, Mockito.times(2)).call();
144 | 
145 |         emitter.off("event0", listener1);
146 | 
147 |         emitter.emit("event0");
148 |         emitter.emit("event1");
149 | 
150 |         Mockito.verify(listener0, Mockito.times(4)).call();
151 |         Mockito.verify(listener1, Mockito.times(3)).call();
152 |     }
153 | 
154 |     @Test
155 |     public void testListenerException() {
156 |         final Emitter emitter = new Emitter();
157 | 
158 |         final Emitter.Listener listener0 = Mockito.mock(Emitter.Listener.class);
159 |         Mockito.doThrow(new RuntimeException("Here")).when(listener0).call();
160 | 
161 |         final Emitter.Listener listener1 = Mockito.mock(Emitter.Listener.class);
162 | 
163 |         emitter.on("event0", listener0);
164 |         emitter.on("event1", listener0);
165 |         emitter.on("event0", listener1);
166 |         emitter.on("event1", listener1);
167 | 
168 |         emitter.emit("event0");
169 |         emitter.emit("event1");
170 | 
171 |         Mockito.verify(listener0, Mockito.times(2)).call();
172 |         Mockito.verify(listener1, Mockito.times(2)).call();
173 |     }
174 | }
175 | 


--------------------------------------------------------------------------------
/engine.io-server/src/test/java/io/socket/engineio/server/EngineIoServerOptionsTest.java:
--------------------------------------------------------------------------------
 1 | package io.socket.engineio.server;
 2 | 
 3 | import io.socket.engineio.server.parser.Packet;
 4 | import org.junit.Assert;
 5 | import org.junit.Test;
 6 | 
 7 | public final class EngineIoServerOptionsTest {
 8 | 
 9 |     @Test(expected = IllegalStateException.class)
10 |     public void testDefaultLocked1() {
11 |         EngineIoServerOptions.DEFAULT.setPingTimeout(0);
12 |     }
13 | 
14 |     @Test(expected = IllegalStateException.class)
15 |     public void testDefaultLocked2() {
16 |         EngineIoServerOptions.DEFAULT.setPingInterval(0);
17 |     }
18 | 
19 |     @Test(expected = IllegalStateException.class)
20 |     public void testDefaultLocked3() {
21 |         EngineIoServerOptions.DEFAULT.setAllowedCorsOrigins(EngineIoServerOptions.ALLOWED_CORS_ORIGIN_ALL);
22 |     }
23 | 
24 |     @Test(expected = IllegalStateException.class)
25 |     public void testDefaultLocked4() {
26 |         EngineIoServerOptions.DEFAULT.setInitialPacket(null);
27 |     }
28 | 
29 |     @Test
30 |     public void testSetAllowedCorsOrigins() {
31 |         EngineIoServerOptions options = EngineIoServerOptions.newFromDefault();
32 | 
33 |         String[] origins = new String[] {
34 |                 "https://www.example.com",
35 |                 "https://www.example.org",
36 |                 "https://example.com",
37 |                 "https://example.org",
38 |         };
39 |         options.setAllowedCorsOrigins(origins);
40 |         Assert.assertArrayEquals(origins, options.getAllowedCorsOrigins());
41 |     }
42 | 
43 |     @Test(expected = IllegalArgumentException.class)
44 |     public void testSetInitialPacket_error1() {
45 |         EngineIoServerOptions.newFromDefault().setInitialPacket(new Packet<>(Packet.PING));
46 |     }
47 | 
48 |     @Test(expected = IllegalArgumentException.class)
49 |     public void testSetInitialPacket_error2() {
50 |         EngineIoServerOptions.newFromDefault().setInitialPacket(new Packet<>(Packet.MESSAGE));
51 |     }
52 | 
53 |     @Test(expected = IllegalStateException.class)
54 |     public void testLock() {
55 |         EngineIoServerOptions options = EngineIoServerOptions.newFromDefault();
56 |         options.setPingInterval(500);
57 |         options.lock();
58 | 
59 |         options.setPingTimeout(1000);
60 |     }
61 | }


--------------------------------------------------------------------------------
/engine.io-server/src/test/java/io/socket/engineio/server/HttpServletResponseImpl.java:
--------------------------------------------------------------------------------
  1 | package io.socket.engineio.server;
  2 | 
  3 | import jakarta.servlet.ServletOutputStream;
  4 | import jakarta.servlet.http.Cookie;
  5 | import jakarta.servlet.http.HttpServletResponse;
  6 | 
  7 | import java.io.ByteArrayOutputStream;
  8 | import java.io.PrintWriter;
  9 | import java.io.UnsupportedEncodingException;
 10 | import java.net.URLEncoder;
 11 | import java.nio.charset.StandardCharsets;
 12 | import java.util.Collection;
 13 | import java.util.Locale;
 14 | 
 15 | public final class HttpServletResponseImpl implements HttpServletResponse {
 16 | 
 17 |     private final ServletOutputStreamWrapper mServletOutputStreamWrapper = new ServletOutputStreamWrapper();
 18 | 
 19 |     private int mStatus = HttpServletResponse.SC_OK;
 20 |     private PrintWriter mPrintWriter = null;
 21 | 
 22 |     @Override
 23 |     public void addCookie(Cookie cookie) {
 24 |     }
 25 | 
 26 |     @Override
 27 |     public boolean containsHeader(String s) {
 28 |         return false;
 29 |     }
 30 | 
 31 |     @Override
 32 |     public String encodeURL(String s) {
 33 |         try {
 34 |             return URLEncoder.encode(s, StandardCharsets.UTF_8.name());
 35 |         } catch (UnsupportedEncodingException ignore) {
 36 |             return null;
 37 |         }
 38 |     }
 39 | 
 40 |     @Override
 41 |     public String encodeRedirectURL(String s) {
 42 |         try {
 43 |             return URLEncoder.encode(s, StandardCharsets.UTF_8.name());
 44 |         } catch (UnsupportedEncodingException ignore) {
 45 |             return null;
 46 |         }
 47 |     }
 48 | 
 49 |     @Override
 50 |     public void sendError(int i, String s) {
 51 |     }
 52 | 
 53 |     @Override
 54 |     public void sendError(int i) {
 55 |     }
 56 | 
 57 |     @Override
 58 |     public void sendRedirect(String s) {
 59 |     }
 60 | 
 61 |     @Override
 62 |     public void setDateHeader(String s, long l) {
 63 |     }
 64 | 
 65 |     @Override
 66 |     public void addDateHeader(String s, long l) {
 67 |     }
 68 | 
 69 |     @Override
 70 |     public void setHeader(String s, String s1) {
 71 |     }
 72 | 
 73 |     @Override
 74 |     public void addHeader(String s, String s1) {
 75 |     }
 76 | 
 77 |     @Override
 78 |     public void setIntHeader(String s, int i) {
 79 |     }
 80 | 
 81 |     @Override
 82 |     public void addIntHeader(String s, int i) {
 83 |     }
 84 | 
 85 |     @Override
 86 |     public void setStatus(int i) {
 87 |         mStatus = i;
 88 |     }
 89 | 
 90 |     @Override
 91 |     public int getStatus() {
 92 |         return mStatus;
 93 |     }
 94 | 
 95 |     @Override
 96 |     public String getHeader(String s) {
 97 |         return null;
 98 |     }
 99 | 
100 |     @Override
101 |     public Collection<String> getHeaders(String s) {
102 |         return null;
103 |     }
104 | 
105 |     @Override
106 |     public Collection<String> getHeaderNames() {
107 |         return null;
108 |     }
109 | 
110 |     @Override
111 |     public String getCharacterEncoding() {
112 |         return null;
113 |     }
114 | 
115 |     @Override
116 |     public String getContentType() {
117 |         return null;
118 |     }
119 | 
120 |     @Override
121 |     public ServletOutputStream getOutputStream() {
122 |         return mServletOutputStreamWrapper;
123 |     }
124 | 
125 |     @Override
126 |     public PrintWriter getWriter() {
127 |         if (mPrintWriter == null) {
128 |             mPrintWriter = new PrintWriter(mServletOutputStreamWrapper, true);
129 |         }
130 |         return mPrintWriter;
131 |     }
132 | 
133 |     @Override
134 |     public void setCharacterEncoding(String s) {
135 |     }
136 | 
137 |     @Override
138 |     public void setContentLength(int i) {
139 |     }
140 | 
141 |     @Override
142 |     public void setContentLengthLong(long l) {
143 |     }
144 | 
145 |     @Override
146 |     public void setContentType(String s) {
147 |     }
148 | 
149 |     @Override
150 |     public void setBufferSize(int i) {
151 |     }
152 | 
153 |     @Override
154 |     public int getBufferSize() {
155 |         return 0;
156 |     }
157 | 
158 |     @Override
159 |     public void flushBuffer() {
160 |     }
161 | 
162 |     @Override
163 |     public void resetBuffer() {
164 |     }
165 | 
166 |     @Override
167 |     public boolean isCommitted() {
168 |         return false;
169 |     }
170 | 
171 |     @Override
172 |     public void reset() {
173 |     }
174 | 
175 |     @Override
176 |     public void setLocale(Locale locale) {
177 |     }
178 | 
179 |     @Override
180 |     public Locale getLocale() {
181 |         return null;
182 |     }
183 | 
184 |     public ByteArrayOutputStream getByteOutputStream() {
185 |         return mServletOutputStreamWrapper.getByteStream();
186 |     }
187 | 
188 |     synchronized void flushWriterIfNecessary() {
189 |         if (mPrintWriter != null) {
190 |             mPrintWriter.flush();
191 |         }
192 |     }
193 | }
194 | 


--------------------------------------------------------------------------------
/engine.io-server/src/test/java/io/socket/engineio/server/ServletInputStreamWrapper.java:
--------------------------------------------------------------------------------
 1 | package io.socket.engineio.server;
 2 | 
 3 | import jakarta.servlet.ReadListener;
 4 | import jakarta.servlet.ServletInputStream;
 5 | 
 6 | import java.io.IOException;
 7 | import java.io.InputStream;
 8 | 
 9 | public final class ServletInputStreamWrapper extends ServletInputStream {
10 | 
11 |     private InputStream mInputStream;
12 | 
13 |     public ServletInputStreamWrapper(InputStream inputStream) {
14 |         mInputStream = inputStream;
15 |     }
16 | 
17 |     @Override
18 |     public boolean isReady() {
19 |         return true;
20 |     }
21 | 
22 |     @Override
23 |     public boolean isFinished() {
24 |         return false;
25 |     }
26 | 
27 |     @Override
28 |     public void setReadListener(ReadListener readListener) {
29 |     }
30 | 
31 |     @Override
32 |     public int read(byte[] b) throws IOException {
33 |         return mInputStream.read(b);
34 |     }
35 | 
36 |     @Override
37 |     public int read(byte[] b, int off, int len) throws IOException {
38 |         return mInputStream.read(b, off, len);
39 |     }
40 | 
41 |     @Override
42 |     public int read() throws IOException {
43 |         return mInputStream.read();
44 |     }
45 | 
46 |     @Override
47 |     public long skip(long n) throws IOException {
48 |         return mInputStream.skip(n);
49 |     }
50 | 
51 |     @Override
52 |     public int available() throws IOException {
53 |         return mInputStream.available();
54 |     }
55 | 
56 |     @Override
57 |     public void close() throws IOException {
58 |         mInputStream.close();
59 |     }
60 | 
61 |     @Override
62 |     public synchronized void reset() throws IOException {
63 |         mInputStream.reset();
64 |     }
65 | 
66 |     @Override
67 |     public boolean markSupported() {
68 |         return mInputStream.markSupported();
69 |     }
70 | 
71 |     @Override
72 |     public synchronized void mark(int readlimit) {
73 |         mInputStream.mark(readlimit);
74 |     }
75 | }


--------------------------------------------------------------------------------
/engine.io-server/src/test/java/io/socket/engineio/server/ServletOutputStreamWrapper.java:
--------------------------------------------------------------------------------
 1 | package io.socket.engineio.server;
 2 | 
 3 | import jakarta.servlet.ServletOutputStream;
 4 | import jakarta.servlet.WriteListener;
 5 | 
 6 | import java.io.ByteArrayOutputStream;
 7 | import java.io.IOException;
 8 | 
 9 | public final class ServletOutputStreamWrapper extends ServletOutputStream {
10 | 
11 |     private final ByteArrayOutputStream mByteOutputStream = new ByteArrayOutputStream();
12 | 
13 |     @Override
14 |     public boolean isReady() {
15 |         return true;
16 |     }
17 | 
18 |     @Override
19 |     public void setWriteListener(WriteListener writeListener) {
20 |     }
21 | 
22 |     @Override
23 |     public void write(byte[] b) throws IOException {
24 |         mByteOutputStream.write(b);
25 |     }
26 | 
27 |     @Override
28 |     public void write(byte[] b, int off, int len) {
29 |         mByteOutputStream.write(b, off, len);
30 |     }
31 | 
32 |     @Override
33 |     public void write(int b) {
34 |         mByteOutputStream.write(b);
35 |     }
36 | 
37 |     @Override
38 |     public void flush() {
39 |     }
40 | 
41 |     @Override
42 |     public void close() {
43 |     }
44 | 
45 |     ByteArrayOutputStream getByteStream() {
46 |         return mByteOutputStream;
47 |     }
48 | }
49 | 


--------------------------------------------------------------------------------
/engine.io-server/src/test/java/io/socket/engineio/server/TestUtils.java:
--------------------------------------------------------------------------------
 1 | package io.socket.engineio.server;
 2 | 
 3 | import java.io.IOException;
 4 | import java.io.InputStream;
 5 | import java.io.OutputStream;
 6 | import java.nio.charset.StandardCharsets;
 7 | 
 8 | public final class TestUtils {
 9 | 
10 |     @SuppressWarnings({"ConstantConditions", "ResultOfMethodCallIgnored"})
11 |     public static <T> T runScriptAndGetOutput(String script, Object input, Class<T> outputClass) {
12 |         byte[] nodeInputBytes;
13 |         if (input instanceof String) {
14 |             nodeInputBytes = ((String) input).getBytes(StandardCharsets.UTF_8);
15 |         } else if (input instanceof byte[]) {
16 |             nodeInputBytes = (byte[]) input;
17 |         } else {
18 |             throw new RuntimeException("Invalid input type: " + input.getClass().getSimpleName());
19 |         }
20 | 
21 |         if(!outputClass.equals(String.class) && !outputClass.equals(byte[].class)) {
22 |             throw new RuntimeException("Invalid output type: " + outputClass.getSimpleName());
23 |         }
24 | 
25 |         final String nodeExec = (System.getenv("NODE_PATH") != null)? System.getenv("NODE_PATH") : "node";
26 | 
27 |         try {
28 |             Process process = Runtime.getRuntime().exec(nodeExec + " " + script);
29 | 
30 |             OutputStream processOutputStream = process.getOutputStream();
31 |             processOutputStream.write(nodeInputBytes);
32 |             processOutputStream.close();
33 | 
34 |             process.waitFor();
35 | 
36 |             if (process.exitValue() != 0) {
37 |                 throw new RuntimeException("Script exited with code: " + process.exitValue());
38 |             }
39 | 
40 |             InputStream processInputStream = process.getInputStream();
41 |             byte[] result = new byte[processInputStream.available()];
42 |             processInputStream.read(result);
43 |             processInputStream.close();
44 | 
45 |             if(outputClass.equals(String.class)) {
46 |                 @SuppressWarnings("unchecked") T t = (T) new String(result, StandardCharsets.UTF_8);
47 |                 return t;
48 |             } else if (outputClass.equals(byte[].class)) {
49 |                 return (T) result;
50 |             } else {
51 |                 throw new RuntimeException("Should never be here.");
52 |             }
53 |         } catch (IOException | InterruptedException ex) {
54 |             throw new RuntimeException(ex);
55 |         }
56 |     }
57 | }
58 | 


--------------------------------------------------------------------------------
/engine.io-server/src/test/java/io/socket/engineio/server/TransportTest.java:
--------------------------------------------------------------------------------
  1 | package io.socket.engineio.server;
  2 | 
  3 | import io.socket.engineio.server.parser.Packet;
  4 | import io.socket.engineio.server.parser.Parser;
  5 | import jakarta.servlet.http.HttpServletRequest;
  6 | import jakarta.servlet.http.HttpServletResponse;
  7 | import org.junit.Test;
  8 | import org.mockito.Mockito;
  9 | 
 10 | import java.util.List;
 11 | import java.util.Map;
 12 | 
 13 | import static org.junit.Assert.assertEquals;
 14 | 
 15 | public final class TransportTest {
 16 | 
 17 |     private static final class TestTransport extends Transport {
 18 | 
 19 |         TestTransport() {
 20 |             super(Parser.PROTOCOL_V4);
 21 |         }
 22 | 
 23 |         /* Abstract overrides */
 24 | 
 25 |         @Override
 26 |         public Map<String, String> getInitialQuery() {
 27 |             return null;
 28 |         }
 29 | 
 30 |         @Override
 31 |         public Map<String, List<String>> getInitialHeaders() {
 32 |             return null;
 33 |         }
 34 | 
 35 |         @Override
 36 |         public String getName() {
 37 |             return null;
 38 |         }
 39 | 
 40 |         @Override
 41 |         public boolean isWritable() {
 42 |             return false;
 43 |         }
 44 | 
 45 |         @Override
 46 |         public void send(List<Packet<?>> packets) {
 47 |         }
 48 | 
 49 |         @Override
 50 |         protected void doClose() {
 51 |         }
 52 | 
 53 |         @Override
 54 |         public void onRequest(HttpServletRequest request, HttpServletResponse response) {
 55 |         }
 56 | 
 57 |         /* Test overrides */
 58 | 
 59 |         @Override
 60 |         public void onError(String reason, String description) {
 61 |             super.onError(reason, description);
 62 |         }
 63 | 
 64 |         @Override
 65 |         public void onPacket(Packet<?> packet) {
 66 |             super.onPacket(packet);
 67 |         }
 68 | 
 69 |         @Override
 70 |         public void onData(Object data) {
 71 |             super.onData(data);
 72 |         }
 73 | 
 74 |         @Override
 75 |         public void onClose() {
 76 |             super.onClose();
 77 |         }
 78 | 
 79 |         /* Test methods */
 80 | 
 81 |         ReadyState getState() {
 82 |             return mReadyState;
 83 |         }
 84 | 
 85 |         @SuppressWarnings("SameParameterValue")
 86 |         void setState(ReadyState state) {
 87 |             mReadyState = state;
 88 |         }
 89 |     }
 90 | 
 91 |     @Test
 92 |     public void testInitialState() {
 93 |         final TestTransport transport = new TestTransport();
 94 |         assertEquals(ReadyState.OPEN, transport.getState());
 95 |     }
 96 | 
 97 |     @Test
 98 |     public void testClose_open() {
 99 |         final TestTransport transport = Mockito.spy(new TestTransport());
100 | 
101 |         transport.close();
102 |         Mockito.verify(transport, Mockito.times(1)).doClose();
103 |         assertEquals(ReadyState.CLOSING, transport.getState());
104 |     }
105 | 
106 |     @Test
107 |     public void testClose_closed() {
108 |         final TestTransport transport = Mockito.spy(new TestTransport());
109 | 
110 |         transport.setState(ReadyState.CLOSED);
111 |         transport.close();
112 |         Mockito.verify(transport, Mockito.times(0)).doClose();
113 |         assertEquals(ReadyState.CLOSED, transport.getState());
114 |     }
115 | 
116 |     @Test
117 |     public void testOnError() {
118 |         final TestTransport transport = Mockito.spy(new TestTransport());
119 | 
120 |         transport.on("error", args -> { });
121 |         transport.onError("test", null);
122 |         Mockito.verify(transport, Mockito.times(1)).emit("error", "test", null);
123 |     }
124 | 
125 |     @Test
126 |     public void testOnPacket() {
127 |         final TestTransport transport = Mockito.spy(new TestTransport());
128 |         final Packet<?> testPacket = new Packet<>(Packet.MESSAGE, "test");
129 | 
130 |         transport.onPacket(testPacket);
131 |         Mockito.verify(transport, Mockito.times(1)).emit("packet", testPacket);
132 |     }
133 | 
134 |     @Test
135 |     public void testOnData() {
136 |         final TestTransport transport = Mockito.spy(new TestTransport());
137 | 
138 |         final Packet<?> testPacket = new Packet<>(Packet.MESSAGE, "test");
139 |         Parser.PROTOCOL_V4.encodePacket(testPacket, false, data -> {
140 |             String packetData = (String) data;
141 | 
142 |             transport.onData(packetData);
143 |             Mockito.verify(transport, Mockito.times(1)).onPacket(Mockito.any(Packet.class));
144 |         });
145 |     }
146 | 
147 |     @Test
148 |     public void testOnClose() {
149 |         final TestTransport transport = Mockito.spy(new TestTransport());
150 | 
151 |         transport.onClose();
152 |         assertEquals(transport.getState(), ReadyState.CLOSED);
153 |         Mockito.verify(transport, Mockito.times(1)).emit("close");
154 |     }
155 | }


--------------------------------------------------------------------------------
/engine.io-server/src/test/java/io/socket/engineio/server/transport/WebSocketTest.java:
--------------------------------------------------------------------------------
  1 | package io.socket.engineio.server.transport;
  2 | 
  3 | import io.socket.engineio.server.Emitter;
  4 | import io.socket.engineio.server.EngineIoWebSocket;
  5 | import io.socket.engineio.server.parser.Packet;
  6 | import io.socket.engineio.server.parser.Parser;
  7 | import jakarta.servlet.http.HttpServletRequest;
  8 | import jakarta.servlet.http.HttpServletResponse;
  9 | import org.junit.Test;
 10 | import org.mockito.Mockito;
 11 | 
 12 | import java.io.IOException;
 13 | import java.nio.charset.StandardCharsets;
 14 | import java.util.ArrayList;
 15 | import java.util.HashMap;
 16 | import java.util.List;
 17 | import java.util.Map;
 18 | 
 19 | import static org.junit.Assert.assertEquals;
 20 | import static org.junit.Assert.assertTrue;
 21 | 
 22 | public final class WebSocketTest {
 23 | 
 24 |     private static final class EngineIoWebSocketStub extends EngineIoWebSocket {
 25 | 
 26 |         @Override
 27 |         public Map<String, String> getQuery() {
 28 |             return new HashMap<>();
 29 |         }
 30 | 
 31 |         @Override
 32 |         public Map<String, List<String>> getConnectionHeaders() {
 33 |             return new HashMap<>();
 34 |         }
 35 | 
 36 |         @Override
 37 |         public void write(String message) {
 38 |         }
 39 | 
 40 |         @Override
 41 |         public void write(byte[] message) {
 42 |         }
 43 | 
 44 |         @Override
 45 |         public void close() {
 46 |         }
 47 |     }
 48 | 
 49 |     @Test
 50 |     public void testName() {
 51 |         final WebSocket webSocket = new WebSocket(Mockito.mock(EngineIoWebSocket.class), Parser.PROTOCOL_V4);
 52 | 
 53 |         assertEquals(WebSocket.NAME, webSocket.getName());
 54 |     }
 55 | 
 56 |     @Test
 57 |     public void testWritable() {
 58 |         final WebSocket webSocket = new WebSocket(Mockito.mock(EngineIoWebSocket.class), Parser.PROTOCOL_V4);
 59 | 
 60 |         assertTrue(webSocket.isWritable());
 61 |     }
 62 | 
 63 |     @Test
 64 |     public void testOnRequest() {
 65 |         final WebSocket webSocket = new WebSocket(Mockito.mock(EngineIoWebSocket.class), Parser.PROTOCOL_V4);
 66 |         webSocket.onRequest(Mockito.mock(HttpServletRequest.class), Mockito.mock(HttpServletResponse.class));
 67 |     }
 68 | 
 69 |     @Test
 70 |     public void testClose() {
 71 |         final EngineIoWebSocket webSocketConnection = Mockito.mock(EngineIoWebSocket.class);
 72 |         final WebSocket webSocket = Mockito.spy(new WebSocket(webSocketConnection, Parser.PROTOCOL_V4));
 73 | 
 74 |         webSocket.close();
 75 | 
 76 |         Mockito.verify(webSocket, Mockito.times(1))
 77 |                 .doClose();
 78 |         Mockito.verify(webSocketConnection, Mockito.times(1))
 79 |                 .close();
 80 |     }
 81 | 
 82 |     @Test
 83 |     public void testSend_string() {
 84 |         final EngineIoWebSocket webSocketConnection = Mockito.mock(EngineIoWebSocket.class);
 85 |         final WebSocket webSocket = Mockito.spy(new WebSocket(webSocketConnection, Parser.PROTOCOL_V4));
 86 | 
 87 |         final String stringData = "Test string";
 88 |         final Packet<?> packet = new Packet<>(Packet.MESSAGE, stringData);
 89 |         webSocket.send(new ArrayList<Packet<?>>() {{
 90 |             add(packet);
 91 |         }});
 92 | 
 93 |         Mockito.verify(webSocket, Mockito.times(1)).send(Mockito.anyList());
 94 | 
 95 |         Parser.PROTOCOL_V4.encodePacket(packet, true, data -> {
 96 |             try {
 97 |                 Mockito.verify(webSocketConnection, Mockito.times(1))
 98 |                         .write(Mockito.eq((String) data));
 99 |             } catch (IOException ignore) {
100 |             }
101 |         });
102 |     }
103 | 
104 |     @Test
105 |     public void testSend_binary() {
106 |         final EngineIoWebSocket webSocketConnection = Mockito.mock(EngineIoWebSocket.class);
107 |         final WebSocket webSocket = Mockito.spy(new WebSocket(webSocketConnection, Parser.PROTOCOL_V4));
108 | 
109 |         final byte[] binaryData = "Test string".getBytes(StandardCharsets.UTF_8);
110 |         final Packet<?> packet = new Packet<>(Packet.MESSAGE, binaryData);
111 |         webSocket.send(new ArrayList<Packet<?>>() {{
112 |             add(packet);
113 |         }});
114 | 
115 |         Mockito.verify(webSocket, Mockito.times(1)).send(Mockito.anyList());
116 | 
117 |         Parser.PROTOCOL_V4.encodePacket(packet, true, data -> {
118 |             try {
119 |                 Mockito.verify(webSocketConnection, Mockito.times(1))
120 |                         .write(Mockito.eq((byte[]) data));
121 |             } catch (IOException ignore) {
122 |             }
123 |         });
124 |     }
125 | 
126 |     @Test
127 |     public void testSend_error() throws IOException {
128 |         final EngineIoWebSocket webSocketConnection = Mockito.mock(EngineIoWebSocket.class);
129 |         final WebSocket webSocket = Mockito.spy(new WebSocket(webSocketConnection, Parser.PROTOCOL_V4));
130 | 
131 |         Mockito.doThrow(new IOException()).when(webSocketConnection).write(Mockito.anyString());
132 |         webSocket.on("error", args -> { });
133 | 
134 |         final String stringData = "Test string";
135 |         final Packet<?> packet = new Packet<>(Packet.MESSAGE, stringData);
136 |         webSocket.send(new ArrayList<Packet<?>>() {{
137 |             add(packet);
138 |         }});
139 | 
140 |         Mockito.verify(webSocket, Mockito.times(1))
141 |                 .send(Mockito.anyList());
142 |         Mockito.verify(webSocket, Mockito.times(1))
143 |                 .emit(Mockito.eq("error"), Mockito.eq("write error"), Mockito.isNull());
144 |     }
145 | 
146 |     @Test
147 |     public void testConnection_close() {
148 |         final EngineIoWebSocket webSocketConnection = new EngineIoWebSocketStub();
149 |         final WebSocket webSocket = Mockito.spy(new WebSocket(webSocketConnection, Parser.PROTOCOL_V4));
150 | 
151 |         final Emitter.Listener closeListener = Mockito.mock(Emitter.Listener.class);
152 |         webSocket.on("close", closeListener);
153 |         webSocketConnection.emit("close");
154 | 
155 |         Mockito.verify(closeListener, Mockito.times(1))
156 |                 .call();
157 |     }
158 | 
159 |     @Test
160 |     public void testConnection_error() {
161 |         final EngineIoWebSocket webSocketConnection = Mockito.spy(new EngineIoWebSocketStub());
162 |         final WebSocket webSocket = Mockito.spy(new WebSocket(webSocketConnection, Parser.PROTOCOL_V4));
163 | 
164 |         final Emitter.Listener errorListener = Mockito.mock(Emitter.Listener.class);
165 |         webSocket.on("error", errorListener);
166 |         webSocketConnection.emit("error", "test", null);
167 | 
168 |         Mockito.verify(errorListener, Mockito.times(1))
169 |                 .call(Mockito.eq("test"), Mockito.isNull());
170 |     }
171 | 
172 |     @Test
173 |     public void testConnection_message() {
174 |         final EngineIoWebSocket webSocketConnection = Mockito.spy(new EngineIoWebSocketStub());
175 |         final WebSocket webSocket = Mockito.spy(new WebSocket(webSocketConnection, Parser.PROTOCOL_V4));
176 | 
177 |         final Packet<String> packet = new Packet<>(Packet.MESSAGE, "Test Message");
178 |         final Emitter.Listener packetListener = Mockito.mock(Emitter.Listener.class);
179 |         Mockito.doAnswer(invocation -> {
180 |             final Object[] args = invocation.getArguments();
181 |             @SuppressWarnings("unchecked") final Packet<?> argPacket = (Packet<Object>) args[0];
182 |             assertEquals(packet.type, argPacket.type);
183 |             assertEquals(packet.data, argPacket.data);
184 |             return null;
185 |         }).when(packetListener).call(Mockito.any());
186 |         webSocket.on("packet", packetListener);
187 | 
188 |         Parser.PROTOCOL_V4.encodePacket(packet, true, data -> {
189 |             webSocketConnection.emit("message", data);
190 | 
191 |             Mockito.verify(packetListener, Mockito.times(1))
192 |                     .call(Mockito.any(Packet.class));
193 |         });
194 |     }
195 | }


--------------------------------------------------------------------------------
/engine.io-server/src/test/resources/helpers.js:
--------------------------------------------------------------------------------
 1 | /* Helper methods */
 2 | 
 3 | module.exports = {};
 4 | 
 5 | module.exports.toArrayBuffer = function (buf) {
 6 |     var ab = new ArrayBuffer(buf.length);
 7 |     var view = new Uint8Array(ab);
 8 |     for (var i = 0; i < buf.length; ++i) {
 9 |         view[i] = buf[i];
10 |     }
11 |     return ab;
12 | };


--------------------------------------------------------------------------------
/engine.io-server/src/test/resources/parser_v3/package-lock.json:
--------------------------------------------------------------------------------
  1 | {
  2 |   "name": "parser_v3",
  3 |   "lockfileVersion": 2,
  4 |   "requires": true,
  5 |   "packages": {
  6 |     "": {
  7 |       "dependencies": {
  8 |         "engine.io-parser": "^2.2.1",
  9 |         "get-stdin": "^6.0.0"
 10 |       }
 11 |     },
 12 |     "node_modules/after": {
 13 |       "version": "0.8.2",
 14 |       "resolved": "https://registry.npmjs.org/after/-/after-0.8.2.tgz",
 15 |       "integrity": "sha1-/ts5T58OAqqXaOcCvaI7UF+ufh8="
 16 |     },
 17 |     "node_modules/arraybuffer.slice": {
 18 |       "version": "0.0.7",
 19 |       "resolved": "https://registry.npmjs.org/arraybuffer.slice/-/arraybuffer.slice-0.0.7.tgz",
 20 |       "integrity": "sha512-wGUIVQXuehL5TCqQun8OW81jGzAWycqzFF8lFp+GOM5BXLYj3bKNsYC4daB7n6XjCqxQA/qgTJ+8ANR3acjrog=="
 21 |     },
 22 |     "node_modules/base64-arraybuffer": {
 23 |       "version": "0.1.4",
 24 |       "resolved": "https://registry.npmjs.org/base64-arraybuffer/-/base64-arraybuffer-0.1.4.tgz",
 25 |       "integrity": "sha1-mBjHngWbE1X5fgQooBfIOOkLqBI=",
 26 |       "engines": {
 27 |         "node": ">= 0.6.0"
 28 |       }
 29 |     },
 30 |     "node_modules/blob": {
 31 |       "version": "0.0.5",
 32 |       "resolved": "https://registry.npmjs.org/blob/-/blob-0.0.5.tgz",
 33 |       "integrity": "sha512-gaqbzQPqOoamawKg0LGVd7SzLgXS+JH61oWprSLH+P+abTczqJbhTR8CmJ2u9/bUYNmHTGJx/UEmn6doAvvuig=="
 34 |     },
 35 |     "node_modules/engine.io-parser": {
 36 |       "version": "2.2.1",
 37 |       "resolved": "https://registry.npmjs.org/engine.io-parser/-/engine.io-parser-2.2.1.tgz",
 38 |       "integrity": "sha512-x+dN/fBH8Ro8TFwJ+rkB2AmuVw9Yu2mockR/p3W8f8YtExwFgDvBDi0GWyb4ZLkpahtDGZgtr3zLovanJghPqg==",
 39 |       "dependencies": {
 40 |         "after": "0.8.2",
 41 |         "arraybuffer.slice": "~0.0.7",
 42 |         "base64-arraybuffer": "0.1.4",
 43 |         "blob": "0.0.5",
 44 |         "has-binary2": "~1.0.2"
 45 |       }
 46 |     },
 47 |     "node_modules/get-stdin": {
 48 |       "version": "6.0.0",
 49 |       "resolved": "https://registry.npmjs.org/get-stdin/-/get-stdin-6.0.0.tgz",
 50 |       "integrity": "sha512-jp4tHawyV7+fkkSKyvjuLZswblUtz+SQKzSWnBbii16BuZksJlU1wuBYXY75r+duh/llF1ur6oNwi+2ZzjKZ7g==",
 51 |       "engines": {
 52 |         "node": ">=4"
 53 |       }
 54 |     },
 55 |     "node_modules/has-binary2": {
 56 |       "version": "1.0.3",
 57 |       "resolved": "https://registry.npmjs.org/has-binary2/-/has-binary2-1.0.3.tgz",
 58 |       "integrity": "sha512-G1LWKhDSvhGeAQ8mPVQlqNcOB2sJdwATtZKl2pDKKHfpf/rYj24lkinxf69blJbnsvtqqNU+L3SL50vzZhXOnw==",
 59 |       "dependencies": {
 60 |         "isarray": "2.0.1"
 61 |       }
 62 |     },
 63 |     "node_modules/isarray": {
 64 |       "version": "2.0.1",
 65 |       "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.1.tgz",
 66 |       "integrity": "sha1-o32U7ZzaLVmGXJ92/llu4fM4dB4="
 67 |     }
 68 |   },
 69 |   "dependencies": {
 70 |     "after": {
 71 |       "version": "0.8.2",
 72 |       "resolved": "https://registry.npmjs.org/after/-/after-0.8.2.tgz",
 73 |       "integrity": "sha1-/ts5T58OAqqXaOcCvaI7UF+ufh8="
 74 |     },
 75 |     "arraybuffer.slice": {
 76 |       "version": "0.0.7",
 77 |       "resolved": "https://registry.npmjs.org/arraybuffer.slice/-/arraybuffer.slice-0.0.7.tgz",
 78 |       "integrity": "sha512-wGUIVQXuehL5TCqQun8OW81jGzAWycqzFF8lFp+GOM5BXLYj3bKNsYC4daB7n6XjCqxQA/qgTJ+8ANR3acjrog=="
 79 |     },
 80 |     "base64-arraybuffer": {
 81 |       "version": "0.1.4",
 82 |       "resolved": "https://registry.npmjs.org/base64-arraybuffer/-/base64-arraybuffer-0.1.4.tgz",
 83 |       "integrity": "sha1-mBjHngWbE1X5fgQooBfIOOkLqBI="
 84 |     },
 85 |     "blob": {
 86 |       "version": "0.0.5",
 87 |       "resolved": "https://registry.npmjs.org/blob/-/blob-0.0.5.tgz",
 88 |       "integrity": "sha512-gaqbzQPqOoamawKg0LGVd7SzLgXS+JH61oWprSLH+P+abTczqJbhTR8CmJ2u9/bUYNmHTGJx/UEmn6doAvvuig=="
 89 |     },
 90 |     "engine.io-parser": {
 91 |       "version": "2.2.1",
 92 |       "resolved": "https://registry.npmjs.org/engine.io-parser/-/engine.io-parser-2.2.1.tgz",
 93 |       "integrity": "sha512-x+dN/fBH8Ro8TFwJ+rkB2AmuVw9Yu2mockR/p3W8f8YtExwFgDvBDi0GWyb4ZLkpahtDGZgtr3zLovanJghPqg==",
 94 |       "requires": {
 95 |         "after": "0.8.2",
 96 |         "arraybuffer.slice": "~0.0.7",
 97 |         "base64-arraybuffer": "0.1.4",
 98 |         "blob": "0.0.5",
 99 |         "has-binary2": "~1.0.2"
100 |       }
101 |     },
102 |     "get-stdin": {
103 |       "version": "6.0.0",
104 |       "resolved": "https://registry.npmjs.org/get-stdin/-/get-stdin-6.0.0.tgz",
105 |       "integrity": "sha512-jp4tHawyV7+fkkSKyvjuLZswblUtz+SQKzSWnBbii16BuZksJlU1wuBYXY75r+duh/llF1ur6oNwi+2ZzjKZ7g=="
106 |     },
107 |     "has-binary2": {
108 |       "version": "1.0.3",
109 |       "resolved": "https://registry.npmjs.org/has-binary2/-/has-binary2-1.0.3.tgz",
110 |       "integrity": "sha512-G1LWKhDSvhGeAQ8mPVQlqNcOB2sJdwATtZKl2pDKKHfpf/rYj24lkinxf69blJbnsvtqqNU+L3SL50vzZhXOnw==",
111 |       "requires": {
112 |         "isarray": "2.0.1"
113 |       }
114 |     },
115 |     "isarray": {
116 |       "version": "2.0.1",
117 |       "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.1.tgz",
118 |       "integrity": "sha1-o32U7ZzaLVmGXJ92/llu4fM4dB4="
119 |     }
120 |   }
121 | }
122 | 


--------------------------------------------------------------------------------
/engine.io-server/src/test/resources/parser_v3/package.json:
--------------------------------------------------------------------------------
1 | {
2 |   "dependencies": {
3 |     "engine.io-parser": "^2.2.1",
4 |     "get-stdin": "^6.0.0"
5 |   }
6 | }
7 | 


--------------------------------------------------------------------------------
/engine.io-server/src/test/resources/parser_v3/testEncodePacket_base64.js:
--------------------------------------------------------------------------------
 1 | var helpers = require('../helpers');
 2 | var getStdin = require('get-stdin');
 3 | var parser = require('engine.io-parser');
 4 | 
 5 | var stdout = process.stdout;
 6 | 
 7 | getStdin.buffer().then(function (stdin) {
 8 |     stdin = helpers.toArrayBuffer(stdin);
 9 |     parser.encodePacket({ type: 'message', data: stdin }, false, function (encodedValue) {
10 |         stdout.write(encodedValue);
11 |     });
12 | });
13 | 


--------------------------------------------------------------------------------
/engine.io-server/src/test/resources/parser_v3/testEncodePacket_binary.js:
--------------------------------------------------------------------------------
 1 | var helpers = require('../helpers');
 2 | var getStdin = require('get-stdin');
 3 | var parser = require('engine.io-parser');
 4 | 
 5 | var stdout = process.stdout;
 6 | 
 7 | getStdin.buffer().then(function (stdin) {
 8 |     stdin = helpers.toArrayBuffer(stdin);
 9 |     parser.encodePacket({ type: 'message', data: stdin }, true, function (encodedValue) {
10 |         stdout.write(encodedValue);
11 |     });
12 | });
13 | 


--------------------------------------------------------------------------------
/engine.io-server/src/test/resources/parser_v3/testEncodePacket_string.js:
--------------------------------------------------------------------------------
 1 | var helpers = require('../helpers');
 2 | var getStdin = require('get-stdin');
 3 | var parser = require('engine.io-parser');
 4 | 
 5 | var stdout = process.stdout;
 6 | 
 7 | getStdin().then(function (stdin) {
 8 |     parser.encodePacket({ type: 'message', data: stdin }, false, function (encodedValue) {
 9 |         stdout.write(encodedValue);
10 |     });
11 | });
12 | 


--------------------------------------------------------------------------------
/engine.io-server/src/test/resources/parser_v3/testEncodePayload_base64.js:
--------------------------------------------------------------------------------
 1 | var helpers = require('../helpers');
 2 | var getStdin = require('get-stdin');
 3 | var parser = require('engine.io-parser');
 4 | 
 5 | var stdout = process.stdout;
 6 | 
 7 | getStdin.buffer().then(function (stdin) {
 8 |     var inputMessages = JSON.parse(stdin);
 9 |     var packets = [];
10 |     for (var i = 0; i < inputMessages.length; i++) {
11 |         packets.push({
12 |             type: 'message',
13 |             data: typeof inputMessages[i] === 'string' ? inputMessages[i] : helpers.toArrayBuffer(inputMessages[i])
14 |         });
15 |     }
16 | 
17 |     parser.encodePayload(packets, function (encodedValue) {
18 |         stdout.write(encodedValue);
19 |     });
20 | });
21 | 


--------------------------------------------------------------------------------
/engine.io-server/src/test/resources/parser_v3/testEncodePayload_binary.js:
--------------------------------------------------------------------------------
 1 | var helpers = require('../helpers');
 2 | var getStdin = require('get-stdin');
 3 | var parser = require('engine.io-parser');
 4 | 
 5 | var stdout = process.stdout;
 6 | 
 7 | getStdin.buffer().then(function (stdin) {
 8 |     var inputMessages = JSON.parse(stdin);
 9 |     var packets = [];
10 |     for (var i = 0; i < inputMessages.length; i++) {
11 |         packets.push({
12 |             type: 'message',
13 |             data: typeof inputMessages[i] === 'string' ? inputMessages[i] : helpers.toArrayBuffer(inputMessages[i])
14 |         });
15 |     }
16 | 
17 |     parser.encodePayload(packets, true, function (encodedValue) {
18 |         stdout.write(encodedValue);
19 |     });
20 | });
21 | 


--------------------------------------------------------------------------------
/engine.io-server/src/test/resources/parser_v3/testEncodePayload_string.js:
--------------------------------------------------------------------------------
 1 | var helpers = require('../helpers');
 2 | var getStdin = require('get-stdin');
 3 | var parser = require('engine.io-parser');
 4 | 
 5 | var stdout = process.stdout;
 6 | 
 7 | getStdin().then(function (stdin) {
 8 |     var inputMessages = JSON.parse(stdin);
 9 |     var packets = [];
10 |     for (var i = 0; i < inputMessages.length; i++) {
11 |         packets.push({ type: 'message', data: inputMessages[i] });
12 |     }
13 | 
14 |     parser.encodePayload(packets, function (encodedValue) {
15 |         stdout.write(encodedValue);
16 |     });
17 | });
18 | 


--------------------------------------------------------------------------------
/engine.io-server/src/test/resources/parser_v4/package-lock.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "parser_v4",
 3 |   "lockfileVersion": 2,
 4 |   "requires": true,
 5 |   "packages": {
 6 |     "": {
 7 |       "dependencies": {
 8 |         "engine.io-parser": "^4.0.2",
 9 |         "get-stdin": "^6.0.0"
10 |       }
11 |     },
12 |     "node_modules/base64-arraybuffer": {
13 |       "version": "0.1.4",
14 |       "resolved": "https://registry.npmjs.org/base64-arraybuffer/-/base64-arraybuffer-0.1.4.tgz",
15 |       "integrity": "sha1-mBjHngWbE1X5fgQooBfIOOkLqBI=",
16 |       "engines": {
17 |         "node": ">= 0.6.0"
18 |       }
19 |     },
20 |     "node_modules/engine.io-parser": {
21 |       "version": "4.0.2",
22 |       "resolved": "https://registry.npmjs.org/engine.io-parser/-/engine.io-parser-4.0.2.tgz",
23 |       "integrity": "sha512-sHfEQv6nmtJrq6TKuIz5kyEKH/qSdK56H/A+7DnAuUPWosnIZAS2NHNcPLmyjtY3cGS/MqJdZbUjW97JU72iYg==",
24 |       "dependencies": {
25 |         "base64-arraybuffer": "0.1.4"
26 |       },
27 |       "engines": {
28 |         "node": ">=8.0.0"
29 |       }
30 |     },
31 |     "node_modules/get-stdin": {
32 |       "version": "6.0.0",
33 |       "resolved": "https://registry.npmjs.org/get-stdin/-/get-stdin-6.0.0.tgz",
34 |       "integrity": "sha512-jp4tHawyV7+fkkSKyvjuLZswblUtz+SQKzSWnBbii16BuZksJlU1wuBYXY75r+duh/llF1ur6oNwi+2ZzjKZ7g==",
35 |       "engines": {
36 |         "node": ">=4"
37 |       }
38 |     }
39 |   },
40 |   "dependencies": {
41 |     "base64-arraybuffer": {
42 |       "version": "0.1.4",
43 |       "resolved": "https://registry.npmjs.org/base64-arraybuffer/-/base64-arraybuffer-0.1.4.tgz",
44 |       "integrity": "sha1-mBjHngWbE1X5fgQooBfIOOkLqBI="
45 |     },
46 |     "engine.io-parser": {
47 |       "version": "4.0.2",
48 |       "resolved": "https://registry.npmjs.org/engine.io-parser/-/engine.io-parser-4.0.2.tgz",
49 |       "integrity": "sha512-sHfEQv6nmtJrq6TKuIz5kyEKH/qSdK56H/A+7DnAuUPWosnIZAS2NHNcPLmyjtY3cGS/MqJdZbUjW97JU72iYg==",
50 |       "requires": {
51 |         "base64-arraybuffer": "0.1.4"
52 |       }
53 |     },
54 |     "get-stdin": {
55 |       "version": "6.0.0",
56 |       "resolved": "https://registry.npmjs.org/get-stdin/-/get-stdin-6.0.0.tgz",
57 |       "integrity": "sha512-jp4tHawyV7+fkkSKyvjuLZswblUtz+SQKzSWnBbii16BuZksJlU1wuBYXY75r+duh/llF1ur6oNwi+2ZzjKZ7g=="
58 |     }
59 |   }
60 | }
61 | 


--------------------------------------------------------------------------------
/engine.io-server/src/test/resources/parser_v4/package.json:
--------------------------------------------------------------------------------
1 | {
2 |   "private": true,
3 |   "dependencies": {
4 |     "engine.io-parser": "^4.0.2",
5 |     "get-stdin": "^6.0.0"
6 |   }
7 | }
8 | 


--------------------------------------------------------------------------------
/engine.io-server/src/test/resources/parser_v4/testEncodePacket_base64.js:
--------------------------------------------------------------------------------
 1 | var helpers = require('../helpers');
 2 | var getStdin = require('get-stdin');
 3 | var parser = require('engine.io-parser');
 4 | 
 5 | var stdout = process.stdout;
 6 | 
 7 | getStdin.buffer().then(function (stdin) {
 8 |     stdin = helpers.toArrayBuffer(stdin);
 9 |     parser.encodePacket({ type: 'message', data: stdin }, false, function (encodedValue) {
10 |         stdout.write(encodedValue);
11 |     });
12 | });
13 | 


--------------------------------------------------------------------------------
/engine.io-server/src/test/resources/parser_v4/testEncodePacket_binary.js:
--------------------------------------------------------------------------------
 1 | var helpers = require('../helpers');
 2 | var getStdin = require('get-stdin');
 3 | var parser = require('engine.io-parser');
 4 | 
 5 | var stdout = process.stdout;
 6 | 
 7 | getStdin.buffer().then(function (stdin) {
 8 |     stdin = helpers.toArrayBuffer(stdin);
 9 |     parser.encodePacket({ type: 'message', data: stdin }, true, function (encodedValue) {
10 |         stdout.write(encodedValue);
11 |     });
12 | });
13 | 


--------------------------------------------------------------------------------
/engine.io-server/src/test/resources/parser_v4/testEncodePacket_string.js:
--------------------------------------------------------------------------------
 1 | var helpers = require('../helpers');
 2 | var getStdin = require('get-stdin');
 3 | var parser = require('engine.io-parser');
 4 | 
 5 | var stdout = process.stdout;
 6 | 
 7 | getStdin().then(function (stdin) {
 8 |     parser.encodePacket({ type: 'message', data: stdin }, false, function (encodedValue) {
 9 |         stdout.write(encodedValue);
10 |     });
11 | });
12 | 


--------------------------------------------------------------------------------
/engine.io-server/src/test/resources/parser_v4/testEncodePayload_base64.js:
--------------------------------------------------------------------------------
 1 | var helpers = require('../helpers');
 2 | var getStdin = require('get-stdin');
 3 | var parser = require('engine.io-parser');
 4 | 
 5 | var stdout = process.stdout;
 6 | 
 7 | getStdin.buffer().then(function (stdin) {
 8 |     var inputMessages = JSON.parse(stdin);
 9 |     var packets = [];
10 |     for (var i = 0; i < inputMessages.length; i++) {
11 |         packets.push({
12 |             type: 'message',
13 |             data: typeof inputMessages[i] === 'string' ? inputMessages[i] : helpers.toArrayBuffer(inputMessages[i])
14 |         });
15 |     }
16 | 
17 |     parser.encodePayload(packets, function (encodedValue) {
18 |         stdout.write(encodedValue);
19 |     });
20 | });
21 | 


--------------------------------------------------------------------------------
/engine.io-server/src/test/resources/parser_v4/testEncodePayload_binary.js:
--------------------------------------------------------------------------------
 1 | var helpers = require('../helpers');
 2 | var getStdin = require('get-stdin');
 3 | var parser = require('engine.io-parser');
 4 | 
 5 | var stdout = process.stdout;
 6 | 
 7 | getStdin.buffer().then(function (stdin) {
 8 |     var inputMessages = JSON.parse(stdin);
 9 |     var packets = [];
10 |     for (var i = 0; i < inputMessages.length; i++) {
11 |         packets.push({
12 |             type: 'message',
13 |             data: typeof inputMessages[i] === 'string' ? inputMessages[i] : helpers.toArrayBuffer(inputMessages[i])
14 |         });
15 |     }
16 | 
17 |     parser.encodePayload(packets, function (encodedValue) {
18 |         stdout.write(encodedValue);
19 |     });
20 | });
21 | 


--------------------------------------------------------------------------------
/engine.io-server/src/test/resources/parser_v4/testEncodePayload_string.js:
--------------------------------------------------------------------------------
 1 | var helpers = require('../helpers');
 2 | var getStdin = require('get-stdin');
 3 | var parser = require('engine.io-parser');
 4 | 
 5 | var stdout = process.stdout;
 6 | 
 7 | getStdin().then(function (stdin) {
 8 |     var inputMessages = JSON.parse(stdin);
 9 |     var packets = [];
10 |     for (var i = 0; i < inputMessages.length; i++) {
11 |         packets.push({ type: 'message', data: inputMessages[i] });
12 |     }
13 | 
14 |     parser.encodePayload(packets, function (encodedValue) {
15 |         stdout.write(encodedValue);
16 |     });
17 | });
18 | 


--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8"?>
  2 | <project xmlns="http://maven.apache.org/POM/4.0.0">
  3 |     <modelVersion>4.0.0</modelVersion>
  4 | 
  5 |     <groupId>io.socket</groupId>
  6 |     <artifactId>engine.io-server-bom</artifactId>
  7 |     <version>6.3.2</version>
  8 |     <packaging>pom</packaging>
  9 |     <name>engine.io</name>
 10 |     <description>Engine.IO server library for Java</description>
 11 |     <url>https://github.com/socketio/engine.io-server-java</url>
 12 | 
 13 |     <modules>
 14 |         <module>engine.io-server</module>
 15 |         <module>engine.io-server-test</module>
 16 |         <module>engine.io-server-coverage</module>
 17 |     </modules>
 18 | 
 19 |     <properties>
 20 |         <github.global.server>github</github.global.server>
 21 |         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 22 |         <maven.compiler.source>11</maven.compiler.source>
 23 |         <maven.compiler.target>11</maven.compiler.target>
 24 | 
 25 |         <jetty.version>11.0.15</jetty.version>
 26 |     </properties>
 27 | 
 28 |     <licenses>
 29 |         <license>
 30 |             <name>Apache License Version 2.0, January 2004</name>
 31 |             <url>https://www.apache.org/licenses/LICENSE-2.0.txt</url>
 32 |             <distribution>repo</distribution>
 33 |         </license>
 34 |     </licenses>
 35 | 
 36 |     <scm>
 37 |         <url>https://github.com/socketio/engine.io-server-java</url>
 38 |         <connection>scm:git:https://github.com/socketio/engine.io-server-java.git</connection>
 39 |         <developerConnection>scm:git:https://github.com/socketio/engine.io-server-java.git</developerConnection>
 40 |         <tag>HEAD</tag>
 41 |     </scm>
 42 | 
 43 |     <developers>
 44 |         <developer>
 45 |             <id>trinopoty</id>
 46 |             <name>Trinopoty Biswas</name>
 47 |             <email>trinopoty@gmail.com</email>
 48 |         </developer>
 49 |     </developers>
 50 | 
 51 |     <distributionManagement>
 52 |         <snapshotRepository>
 53 |             <id>ossrh</id>
 54 |             <url>https://oss.sonatype.org/content/repositories/snapshots</url>
 55 |         </snapshotRepository>
 56 |         <repository>
 57 |             <id>ossrh</id>
 58 |             <url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
 59 |         </repository>
 60 |     </distributionManagement>
 61 | 
 62 |     <dependencyManagement>
 63 |         <dependencies>
 64 |             <dependency>
 65 |                 <groupId>io.socket</groupId>
 66 |                 <artifactId>engine.io-server</artifactId>
 67 |                 <version>${project.version}</version>
 68 |             </dependency>
 69 |         </dependencies>
 70 |     </dependencyManagement>
 71 | 
 72 |     <profiles>
 73 |         <profile>
 74 |             <id>release-sign-artifacts</id>
 75 |             <activation>
 76 |                 <property>
 77 |                     <name>performRelease</name>
 78 |                     <value>true</value>
 79 |                 </property>
 80 |             </activation>
 81 |             <build>
 82 |                 <plugins>
 83 |                     <plugin>
 84 |                         <groupId>org.apache.maven.plugins</groupId>
 85 |                         <artifactId>maven-gpg-plugin</artifactId>
 86 |                         <version>3.1.0</version>
 87 |                         <executions>
 88 |                             <execution>
 89 |                                 <id>sign-artifacts</id>
 90 |                                 <phase>verify</phase>
 91 |                                 <goals>
 92 |                                     <goal>sign</goal>
 93 |                                 </goals>
 94 |                                 <configuration>
 95 |                                     <keyname>${gpg.keyname}</keyname>
 96 |                                 </configuration>
 97 |                             </execution>
 98 |                         </executions>
 99 |                     </plugin>
100 |                 </plugins>
101 |             </build>
102 |         </profile>
103 |     </profiles>
104 | 
105 |     <build>
106 |         <plugins>
107 |             <plugin>
108 |                 <groupId>org.apache.maven.plugins</groupId>
109 |                 <artifactId>maven-compiler-plugin</artifactId>
110 |                 <version>3.11.0</version>
111 |                 <configuration>
112 |                     <source>1.8</source>
113 |                     <target>1.8</target>
114 |                     <encoding>UTF-8</encoding>
115 |                     <compilerArgs>
116 |                         <arg>-Xlint:unchecked</arg>
117 |                     </compilerArgs>
118 |                     <showWarnings>true</showWarnings>
119 |                     <showDeprecation>true</showDeprecation>
120 |                 </configuration>
121 |             </plugin>
122 |             <plugin>
123 |                 <groupId>org.apache.maven.plugins</groupId>
124 |                 <artifactId>maven-javadoc-plugin</artifactId>
125 |                 <version>3.5.0</version>
126 |                 <executions>
127 |                     <execution>
128 |                         <id>aggregate</id>
129 |                         <goals>
130 |                             <goal>aggregate</goal>
131 |                         </goals>
132 |                         <phase>site</phase>
133 |                     </execution>
134 |                 </executions>
135 |                 <configuration>
136 |                     <additionalOptions>-Xdoclint:none</additionalOptions>
137 |                 </configuration>
138 |             </plugin>
139 |             <!-- JaCoCo Plugin -->
140 |             <plugin>
141 |                 <groupId>org.jacoco</groupId>
142 |                 <artifactId>jacoco-maven-plugin</artifactId>
143 |                 <version>0.8.10</version>
144 |                 <executions>
145 |                     <execution>
146 |                         <id>prepare-agent</id>
147 |                         <goals>
148 |                             <goal>prepare-agent</goal>
149 |                         </goals>
150 |                     </execution>
151 |                 </executions>
152 |             </plugin>
153 |         </plugins>
154 |     </build>
155 |     <reporting>
156 |         <plugins>
157 |             <plugin>
158 |                 <groupId>org.apache.maven.plugins</groupId>
159 |                 <artifactId>maven-javadoc-plugin</artifactId>
160 |                 <version>3.0.1</version>
161 |                 <reportSets>
162 |                     <reportSet>
163 |                         <id>aggregate</id>
164 |                         <reports>
165 |                             <report>aggregate</report>
166 |                         </reports>
167 |                     </reportSet>
168 |                 </reportSets>
169 |             </plugin>
170 |         </plugins>
171 |     </reporting>
172 | </project>
173 | 


--------------------------------------------------------------------------------