Download the PHP package arthurkushman/php-wss without Composer

php-wss

Web-socket server/client with multi-process and parse templates support on server and send/receive options on client

Library comes with several main options

Server:

• it`s a web-socket server for multiple connections with decoding/encoding for all events out of the box (with Dependency Injected MessageHandler)
• it has GET uri parser, so you can easily use any templates
• multiple process per user connections support, so you can fork processes to speed up performance deciding how many client-connections should be there
• broadcasting message(s) to all clients
• origin check
• ssl server run

Client:

• You have the ability to handshake (which is performed automatically) and send messages to server
• Receive a response from the server
• Initiate connection via proxy

How do I get set up?

Preferred way to install is with Composer.

perform command in shell

OR

just add

to your projects composer.json.

Implement your WebSocket handler class - ex.:

To save clients with their unique ids - use getUniqueSocketId() which returns (type-casted to int) socketConnection resource id.

Then put code bellow to Your CLI/Console script and run

How do I set WebSocket Client connection?

That`s it, client is just sending any text content (message) to the Server.

Server reads all the messages and push them to Handler class, for further custom processing.

How to pass an optional timeout, headers, fragment size etc?

You can pass optional configuration to WebSocketClient's constructor e.g.:

If it is of need to send ssl requests just set wss scheme to constructors url param of WebSocketClient - it will be passed and used as ssl automatically.

You can also set particular context options for stream_context_create to provide them to stream_socket_client, for instance:

or any other available options see - https://www.php.net/manual/en/context.php.

BroadCasting

You may wish to broadcast messages by simply calling broadCast method on Connection object in any method of your ServerHandler class:

Origin check

To let server check the Origin header with n hosts provided:

Server will automatically check those hosts proceeding to listen for other connections even if some failed to pass check.

SSL Server run options

Avoid high CPU usage

How to test

To run the Server - execute from the root of a project:

To run the Client - execute in another console:

PHP7 support since version 1.3 - with types, returns and better function implementations.

Benchmarks:

As you may have been noticed, average time to send msg is 4.427μs which is roughly rounded to 4 microseconds within 10 000 have been sent 3 times in a row.

PS U'll see the processes increase named "php-wss" as CPP (Connections Per-Process) will grow and decrease while stack will lessen. For instance, if set 100 CPP and there are 128 connections - You will be able to see 2 "php-wss" processes with for ex.: ps aux | grep php-wss

Used by:

Supporters gratitude: