Socket.php

Go to the documentation of this file.

<?php
 
namespace Rsi\Fred;
 
class Socket extends Component{
 
  public $clientHost = null; //!< Host the WebSocket server is running on (for public connections; empty = same as HTTP).
  public $clientPort = null; //!< Port client websockets can connect to (empty = no connection allowed).
  public $clientPrefix = null; //!< Prefix for websocket requests (for example when tunneling WSS traffic).
  public $clientLocalPort = null; //!< When the WebSocket server should listen on another local port then the client connects
    // to (for example when tunneling WSS traffic).
  public $clientOrigins = []; //!< Allowed origins (empty = all).
  public $tokenTtl = 30; //!< Time a request token is valid (seconds).
 
  public $localHost = 'localhost'; //!< Host the WebSocket server is running on (for local connections).
  public $localPort = 6871; //!< Port for local connections (HTTP server <-> WebSocket server).
  public $localClients = ['127.0.0.1','::1']; //!< Allowed clients for a local connection.
 
  protected $_server = null; //!< WebSocket server.
 
  /**
   * Request an action from the HTTP Server on the WebSocket server.
   * @param string $controller_name  Controler to apply the action on (empty = local action).
   * @param string $action  Requested action.
   * @param mixed $params  Parameters for the action.
   * @param int $read_length  Maximum number of bytes to read.
   * @return string  Response from the WebSocket server (false on error).
   * @see http://php.net/socket_last_error
   */
  public function action($controller_name,$action,$params = null,$read_length = 1024){
    $result = false;
    if($this->localPort && ($socket = socket_create(AF_INET,SOCK_STREAM,SOL_TCP))) try{
      if(
        socket_connect($socket,$this->localHost,$this->localPort) &&
        (socket_write($socket,serialize(array_merge($params ?: [],['controller' => $controller_name,'action' => $action]))) !== false)
      ) $result = socket_read($socket,$read_length);
      socket_close($socket);
    }
    catch(\Exception $e){
      $this->component('log')->emergency('Can not connect to socket server: ' . $e->getMessage(),__FILE__,__LINE__);
    }
    return $result ? unserialize($result) : $result;
  }
  /**
   * Create a WebSocket access token.
   * @param array $params  Parameters to pass to the WebSocket server (this is used as the session - read-only).
   * @return string  Token (false on error; null = not available).
   */
  public function token($params = null){
    if(!$this->clientPort) return null;
    $params = array_merge($params ?: [],['token' => $token = \Rsi\Str::random(),'sessionId' => session_id()]);
    return $this->action(null,'token',$params) === false ? false : $token;
  }
 
  protected function getServer(){
    if(!$this->_server) $this->_server = new Socket\Server($this);
    return $this->_server;
  }
 
}