Download the PHP package rtckit/esl without Composer
On this page you can find all versions of the php package rtckit/esl. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package esl
Short Description FreeSWITCH Event Socket Layer (ESL) Library
License MIT
Homepage https://github.com/rtckit/php-esl
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package esl
FreeSWITCH Event Socket Layer library for PHP
Quickstart
FreeSWITCH's Event Socket Layer is a TCP control interface enabling the development of complex dynamic dialplans/workflows. You can learn more about its inbound mode as well as its outbound mode on the FreeSWITCH website.
This library provides an I/O agnostic implementation of the ESL protocol.
ESL Message Parsing
The authentication stage of an ESL connection can be summarized as follows:
ESL Message Rendering
The reverse procedure, rendering to string, is straightforward:
ESL Connection
Although this library is I/O independent, a Connection base class are being provided; since ESL runs over TCP, a stream oriented transport, it behooves to handle the message framing in a higher level library. An implementing project would simply invoke the ConnectionInterface::consume() method when input is available and would implement a ConnectionInterface::emitBytes() method which performs the corresponding I/O-specific write operations.
The Connection constructor requires a $role argument, which must be one of the following:
ConnectionInterface::INBOUND_CLIENTto be used by ESL clients connecting to FreeSWITCH ESL servers;ConnectionInterface::OUTBOUND_SERVERto be used by ESL servers FreeSWITCH connects to in outbound mode;
The other two options are less common:
ConnectionInterface::INBOUND_SERVERto impersonate a FreeSWITCH ESL server;ConnectionInterface::OUTBOUND_CLIENTto impersonate FreeSWITCH connecting to a remote ESL endpoint in outbound mode;
The latter two roles can be useful in test suites, implementing message relays, security research etc. Please note the inbound and outbound terms are relative to the FreeSWITCH endpoint (matching the mod_event_socket nomenclature).
Requirements
RTCKit\ESL is compatible with PHP 7.4+ and has no external library and extension dependencies.
Installation
You can add the library as project dependency using Composer:
If you only need the library during development, for instance when used in your test suite, then you should add it as a development-only dependency:
Tests
To run the test suite, clone this repository and then install dependencies via Composer:
Then, go to the project root and run:
Static Analysis
In order to ensure high code quality, RTCKit\ESL uses PHPStan and Psalm:
License
MIT, see LICENSE file.
Acknowledgments
- FreeSWITCH, FreeSWITCH is a registered trademark of Anthony Minessale II
Contributing
Bug reports (and small patches) can be submitted via the issue tracker. Forking the repository and submitting a Pull Request is preferred for substantial patches.
