Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yggverse/nex-php
PHP / Composer Library for Nex Protocol
https://github.com/yggverse/nex-php
1900 altweb client composer library nex nex-client nex-library nex-php nex-protocol nex-protocol-client nex-protocol-php nex-protocol-server nex-server php server smallweb tinyweb
Last synced: about 1 month ago
JSON representation
PHP / Composer Library for Nex Protocol
- Host: GitHub
- URL: https://github.com/yggverse/nex-php
- Owner: YGGverse
- License: mit
- Created: 2024-04-21T11:19:02.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-04-25T11:57:22.000Z (9 months ago)
- Last Synced: 2024-04-25T13:17:43.869Z (9 months ago)
- Topics: 1900, altweb, client, composer, library, nex, nex-client, nex-library, nex-php, nex-protocol, nex-protocol-client, nex-protocol-php, nex-protocol-server, nex-server, php, server, smallweb, tinyweb
- Language: PHP
- Homepage:
- Size: 14.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nex-php
PHP 8 Library for NEX Protocol (see also [nps-php](https://github.com/YGGverse/nps-php))
## Usage
```
composer require yggverse/nex
```
## Client
PHP interface for NEX protocol queries
``` php
$client = new \Yggverse\Nex\Client;
```
#### Client::request
Request data from URL | URI if constructed by URL
``` php
var_dump(
$client->request(
'nex://nightfall.city/nex/'
)
);
```
#### Client::setHost
#### Client::getHost
#### Client::setPort
#### Client::getPort
#### Client::setPath
#### Client::getPath
#### Client::setQuery
#### Client::getQuery
#### Client::getOptions
#### Client::setOptions
## Server
Build interactive server instance to listen NEX protocol connections!
``` php
$server = new \Yggverse\Nex\Server;
```
Provide optional `host`, `port` and `size` arguments in constructor or use available setters after object initiation.
``` php
$server = new \Yggverse\Nex\Server('127.0.0.1', 1900);
```
#### Server::setHost
#### Server::getHost
#### Server::setPort
#### Server::getPort
#### Server::setSize
#### Server::getSize
#### Server::setLive
#### Server::getLive
#### Server::start
Run server object using this method.
Define handler function as the argument to process application logic dependent of client request.
``` php
$server->start(
function (
string $request,
string $connect
): ?string
{
printf(
'connection: %s request: %s',
$connect,
$request
);
return null; // null|string response
}
);
```
#### Server::stop
Stop server instance.
Same to `Server::setLive(false)`
## Integrations
* [next](https://github.com/YGGverse/next) - PHP 8 Server for NEX Protocol