IMuSession

require_once IMu::$lib . '/Session.php';

Depuis : 1.0

Description

Gère une connexion à un serveur IMu.

Le nom d’hôte du serveur et son port peuvent être spécifiés en définissant des propriétés sur l’objet ou en définissant des propriétés par défaut au niveau de la classe.

Exemples

Connectez-vous à un serveur par défaut.

$session = new IMuSession();
$session->connect();

Propriétés de classe

Propriété	Détails
`defaultHost`	L’hôte par défaut auquel se connecter si aucun hôte spécifique à l’objet n’a été fourni. Type : string Getter: string getDefaultHost() Setter: setDefaultHost(string $value)
`defaultPort`	Le numéro du port utilisé pour créer une connexion si aucun port spécifique à l’objet n’a été fourni. Type : int Getter: int getDefaultPort() Setter: setDefaultPort(int $value)
`defaultTimeout`	La valeur par défaut du délai d’expiration (en secondes). Ce délai d’expiration est utilisé si le constructeur est appelé sans argument de délai d’expiration. Type : int Getter: int getDefaultTimeout() Setter: setDefaultTimeout(int $value)

Propriété

Détails

defaultHost

L’hôte par défaut auquel se connecter si aucun hôte spécifique à l’objet n’a été fourni.

Type :

string

Getter:

string getDefaultHost()

Setter:

setDefaultHost(string $value)

defaultPort

Le numéro du port utilisé pour créer une connexion si aucun port spécifique à l’objet n’a été fourni.

Type :

int

Getter:

int getDefaultPort()

Setter:

setDefaultPort(int $value)

defaultTimeout

La valeur par défaut du délai d’expiration (en secondes). Ce délai d’expiration est utilisé si le constructeur est appelé sans argument de délai d’expiration.

Type :

int

Getter:

int getDefaultTimeout()

Setter:

setDefaultTimeout(int $value)

Constructeurs

Constructeur

Détails

__construct($host, $port, $timeout)

__construct([string $host = null [, string $port = null [, int $timeout = null]]])

Crée un objet Session avec l'host et le port spécifiés.

Paramètres :

`$host` (string)	Le port de serveur par défaut. La valeur par défaut est `null` si elle n'est pas fournie.
`$port` (string)	Le port de serveur par défaut. La valeur par défaut est `null` si elle n'est pas fournie.
`$timeout` (int)	La valeur par défaut du délai d’expiration (en secondes). La valeur par défaut est `null` si elle n'est pas fournie.

Propriétés

Propriété	Détails
`close`	Un indicateur permettant de déterminer si la connexion au serveur doit être fermée après la requête suivante. Cet indicateur est transmis au serveur dans le cadre de la requête suivante afin de lui permettre d’effectuer le nettoyage nécessaire. Type : bool Getter: bool getClose() Setter: setClose(bool $value)
`context`	L’identifiant unique attribué par le serveur à la session en cours. Type : string Getter: string getContext() Setter: setContext(string $value)
`host`	Nom de l’hôte utilisé pour créer la connexion. La définition de cette propriété après l’établissement de la connexion n’a aucun effet. Type : string Getter: string getHost() Setter: setHost(string $value)
`port`	Le numéro du port utilisé pour créer la connexion. La définition de cette propriété après l’établissement de la connexion n’a aucun effet. Type : int Getter: int getPort() Setter: setPort(int $value)
`suspend`	Indicateur permettant de déterminer si le processus serveur gérant cette session doit commencer à écouter sur un port distinct et spécifique au processus afin de garantir qu’une nouvelle session se connecte au même processus serveur. Cela fait partie du mécanisme de maintien de l’état d’IMu. Si cet indicateur est défini à `true`, après l’envoi de la prochaine requête au serveur, la propriété `port` de `IMuSession` sera remplacée par le numéro du port spécifique au processus. Type : bool Getter: bool getSuspend() Setter: setSuspend(bool $value)
`timeout`	Type : int Getter: int getTimeout() Setter: setTimeout(int $value)

Méthodes

Méthode

Détails

connect()

connect()

Ouvre une connexion à un serveur IMu.

Retourne :

Lancers :

IMuException

La connexion n’a pas pu être ouverte.

disconnect()

disconnect()

Ferme la connexion au serveur IMu.

Retourne :

login($login, $password, $spawn)

login(string $login [, string $password = null [, bool $spawn = true]])

Se connecte en tant que l’utilisateur indiqué avec le mot de passe correspondant.

Si le paramètre $spawn est réglé sur true, le serveur créera un nouveau processus enfant spécifiquement pour traiter les demandes de l’utilisateur nouvellement connecté.

Paramètres :

$login (string)

Le nom d’utilisateur avec lequel se connecter.

$password (string)

Le mot de passe de l’utilisateur pour l’authentification. La valeur par défaut est null si elle n'est pas fournie.

$spawn (bool)

Un indicateur indiquant si le processus doit créer un nouveau processus enfant spécifiquement pour traiter les demandes de l’utilisateur nouvellement connecté. Cette valeur par défaut est true.

La valeur par défaut est true si elle n'est pas fournie.

Retourne :

Lancers :

`IMuException`	La demande de connexion a échoué.
`Exception`	Une erreur de communication de socket de bas niveau s’est produite.

logout()

logout()

Déconnecte l’utilisateur du serveur.

Retourne :

request($request)

array request(array $request)

Envoie une requête de bas niveau au serveur IMu.

Paramètres :

$request (array)

Un tableau associatif contenant les paramètres de la requête.

Retourne :

array

Un tableau associatif contenant la réponse du serveur.

Lancers :

IMuException

Une erreur côté serveur s'est produite.