Download the PHP package php-websocket-rpc/rpc without Composer

On this page you can find all versions of the php package php-websocket-rpc/rpc. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Example code of php-websocket-rpc/rpc

Informations about the package rpc

php-websocket-rpc/rpc

Shared data model, serialization, middleware pipeline, and contract system for RPC over WebSocket.

This is the foundation library — both rpc-client and rpc-server depend on it.

Install

Requires PHP 8.5+ and the msgpack extension.

Features

Contract Attributes

Attribute Target Purpose
#[RpcSubscribe] Method Subscribe to a named channel (receives push data)
#[RpcStream] Method Stream data as an async iterable
#[RpcPublish] Method Publish data to a named channel
#[NeedAuthorization] Method/Class Require authentication to access a method or entire interface

Authentication

AuthService Contract

A built-in contract that all clients can use to authenticate:

WebsocketUserInterface

User (built-in value object)

Error Codes

Exception Code Meaning
AuthenticationException -32010 Invalid/expired/missing token
AuthorizationException -32011 Insufficient permissions

Both extend RpcDispatchException and carry the error code in getRpcCode().

Key Classes

Class Purpose
PhpWebsocketRpc\Rpc\Payload\Payload Base class for all wire payloads
PhpWebsocketRpc\Rpc\Serialization\Serializer Msgpack serialization
PhpWebsocketRpc\Rpc\Contract\ContractSerializer Object encoding/decoding for contract data
PhpWebsocketRpc\Rpc\Contract\Attribute\RpcSubscribe Mark a method as subscribe pattern
PhpWebsocketRpc\Rpc\Contract\Attribute\RpcStream Mark a method as stream pattern
PhpWebsocketRpc\Rpc\Contract\Attribute\RpcPublish Mark a method as publish pattern
PhpWebsocketRpc\Rpc\Contract\Attribute\NeedAuthorization Mark a method/interface as requiring auth
PhpWebsocketRpc\Rpc\Contract\AuthService Built-in authentication contract
PhpWebsocketRpc\Rpc\Auth\WebsocketUserInterface Interface for authenticated user data
PhpWebsocketRpc\Rpc\Auth\User Value object implementing WebsocketUserInterface
PhpWebsocketRpc\Rpc\Exception\AuthenticationException Auth failure (-32010)
PhpWebsocketRpc\Rpc\Exception\AuthorizationException Forbidden (-32011)
PhpWebsocketRpc\Rpc\Middleware\MiddlewarePipeline Middleware chain

All versions of rpc with dependencies

PHP Build Version
Package Version
Requires php Version >=8.5
ext-msgpack Version *
amphp/websocket Version ^2
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package php-websocket-rpc/rpc contains the following files

Loading the files please wait ...