Cluster — API

localzet\Cluster\Business

function __construct($socket_name = '', $context_option = array())

function run(): void

function connectToRegister()

function onRegisterConnectionMessage($register_connection, $data)

function onGatewayMessage($connection, $data)

function onGatewayClose($connection)

function tryToConnectGateway($addr)

function checkGatewayConnections($addresses_list)

function onConnectGateway($connection)

function onGatewayError($connection, $error_no, $error_msg)

function getAllGatewayAddresses()

const PERSISTENCE_CONNECTION_PING_INTERVAL

localzet\Cluster\Client

src/Client.php

static function sendToAll($message, $client_id_array = null, $exclude_client_id = null, $raw = false)

static function sendToClient($client_id, $message, $raw = false)

static function sendToCurrentClient($message, $raw = false)

static function isUidOnline($uid)

static function isOnline($client_id)

static function getAllClientSessions($group = '')

static function getClientSessionsByGroup($group)

static function getAllClientCount()

static function getClientCountByGroup($group = '')

static function getClientIdListByGroup($group)

static function getAllClientIdList()

static function getClientIdByUid($uid)

static function getUidListByGroup($group)

static function getUidCountByGroup($group)

static function getAllUidList()

static function getAllUidCount()

static function getUidByClientId($client_id)

static function getAllGroupIdList()

static function getAllGroupUidCount()

static function getAllGroupUidList()

static function getAllGroupClientIdList()

static function getAllGroupClientIdCount()

static function closeClient($client_id, $message = null)

static function closeCurrentClient($message = null)

static function destoryClient($client_id)

static function destoryCurrentClient()

static function bindUid($client_id, $uid)

static function unbindUid($client_id, $uid)

static function joinGroup($client_id, $group)

static function leaveGroup($client_id, $group)

static function ungroup($group)

static function sendToUid($uid, $message, $raw = false)

static function sendToGroup($group, $message, $exclude_client_id = null, $raw = false)

static function setSocketSession($client_id, $session_str)

static function setSession($client_id, array $session)

static function updateSession($client_id, array $session)

static function getSession($client_id)

static function setBusiness($business_server_instance)

localzet\Cluster\Gateway

src/Gateway.php

function __construct(?string $socketName = null, array $socketContext = [], public ?string $secretKey = null)

function run(): void

function onWebsocketConnect($connection, $request)

static function routerRand($server_connections, $client_connection, $cmd, $buffer)

static function routerBind($server_connections, $client_connection, $cmd, $buffer)

function onServerStart()

function onServerConnect($connection)

function onServerMessage($connection, $data)

function onServerClose($connection)

function registerAddress()

function ping()

function pingBusiness()

function onServerStop()

static function log(mixed $msg, bool $decorated = true): void

const PERSISTENCE_CONNECTION_PING_INTERVAL

localzet\Cluster\Gateway\ClientTrait

src/Gateway/ClientTrait.php

function onClientMessage(TcpConnection $connection, mixed $data): void

function onClientConnect(TcpConnection $connection): void

function onClientClose(TcpConnection $connection): void

localzet\Cluster\Lib\Context

src/Lib/Context.php

static function sessionEncode($session_data = '')

static function sessionDecode($session_buffer)

static function clear()

static function addressToClientId($local_ip, $local_port, $connection_id)

static function clientIdToAddress($client_id)

localzet\Cluster\Lib\Gateway

src/Lib/Gateway.php

static function sendToAll($message, $client_id_array = null, $exclude_client_id = null, $raw = false)

static function sendToClient($client_id, $message, $raw = false)

static function sendToCurrentClient($message, $raw = false)

static function isUidOnline($uid)

static function isOnline($client_id)

static function getAllClientSessions($group = '')

static function getClientSessionsByGroup($group)

static function getAllClientIdCount()

static function getAllClientCount()

static function getClientIdCountByGroup($group = '')

static function getClientCountByGroup($group = '')

static function getClientIdListByGroup($group)

static function getAllClientIdList()

static function getClientIdByUid($uid)

static function getUidListByGroup($group)

static function getUidCountByGroup($group)

static function getAllUidList()

static function getAllUidCount()

static function getUidByClientId($client_id)

static function getAllGroupIdList()

static function getAllGroupUidCount()

static function getAllGroupUidList()

static function getAllGroupClientIdList()

static function getAllGroupClientIdCount()

static function closeClient($client_id, $message = null)

static function closeCurrentClient($message = null)

static function destoryClient($client_id)

static function destoryCurrentClient()

static function bindUid($client_id, $uid)

static function unbindUid($client_id, $uid)

static function joinGroup($client_id, $group)

static function leaveGroup($client_id, $group)

static function ungroup($group)

static function sendToUid($uid, $message, $raw = false)

static function sendToGroup($group, $message, $exclude_client_id = null, $raw = false)

static function setSocketSession($client_id, $session_str)

static function setSession($client_id, array $session)

static function updateSession($client_id, array $session)

static function getSession($client_id)

static function setBusiness($business_server_instance)

localzet\Cluster\Protocols\Cluster

src/Protocols/Cluster.php

static function input($buffer)

static function encode($data)

static function decode($buffer)

const CMD_ON_CONNECT

const CMD_ON_MESSAGE

const CMD_ON_CLOSE

const CMD_SEND_TO_ONE

const CMD_SEND_TO_ALL

const CMD_KICK

const CMD_DESTROY

const CMD_UPDATE_SESSION

const CMD_GET_ALL_CLIENT_SESSIONS

const CMD_IS_ONLINE

const CMD_BIND_UID

const CMD_UNBIND_UID

const CMD_SEND_TO_UID

const CMD_GET_CLIENT_ID_BY_UID

const CMD_JOIN_GROUP

const CMD_LEAVE_GROUP

const CMD_SEND_TO_GROUP

const CMD_GET_CLIENT_SESSIONS_BY_GROUP

const CMD_GET_CLIENT_COUNT_BY_GROUP

const CMD_SELECT

const CMD_GET_GROUP_ID_LIST

const CMD_UNGROUP

const CMD_SERVER_CONNECT

const CMD_PING

const CMD_GATEWAY_CLIENT_CONNECT

const CMD_GET_SESSION_BY_CLIENT_ID

const CMD_SET_SESSION

const CMD_ON_WEBSOCKET_CONNECT

const FLAG_BODY_IS_SCALAR

const FLAG_NOT_CALL_ENCODE

const HEAD_LEN

localzet\Cluster\Register

src/Register.php

function __construct(?string $socketName = null, array $socketContext = [], public ?string $secretKey = null)

function run(): void

function onConnect(TcpConnection $connection): void

function onMessage(TcpConnection $connection, string $buffer): void

function onClose(TcpConnection $connection): void

function broadcastAddresses(?TcpConnection $connection = null): void