Session

Session

IMu.Session

IMu.Session

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

  1. Connectez-vous au serveur par défaut.

    using IMu;
    Session session = new Session();
    session.Connect();

  2. Définissez l’hôte et le port par défaut, puis connectez-vous.

    using IMu;
    Session.DefaultHost = "server.com"; Session.DefaultPort = 40136; Session session = new Session(); session.Connect();

Propriétés de classe

Propriété de classe

Détails

DefaultHost

string DefaultHost

Le nom de l’hôte utilisé pour créer une connexion si aucun hôte spécifique à l’objet n’a été fourni.

DefaultPort

int DefaultPort

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

Constructeurs

Constructeur

Détails

Session(host, port)

Session(string host, int port)

Crée un objet Session avec l’hôte et le port spécifiés.

Paramètres :

host (string)

L'hôte de serveur par défaut.

port (int)

Le port de serveur par défaut.

Session(host)

Session(string host)

Crée un objet Session avec l’hôte spécifié.

Le port utilisé pour la connexion sera obtenu à partir de la propriété de classe DefaultPort.

Paramètres :

host (string)

L'hôte de serveur par défaut.

Session(port)

Session(int port)

Crée un objet Session avec le port spécifié.

L’hôte auquel se connecter sera obtenu à partir de la propriété de classe DefaultHost.

Paramètres :

port (int)

Le port de serveur par défaut.

Session()

Session()

Crée un objet Session.

L’hôte auquel se connecter sera obtenu à partir de la propriété de classe DefaultHost.

Le port utilisé pour la connexion sera obtenu à partir de la propriété de classe DefaultPort.

Propriétés

Propriété

Détails

Close

bool 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.

Context

string Context

L’identifiant unique attribué par le serveur à la session en cours.

Host

string 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.

Port

int 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.

Suspend

bool 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 Session sera remplacée par le numéro du port spécifique au processus.

Méthodes

Méthode

Détails

Connect()

void Connect()

Ouvre une connexion à un serveur IMu.

Retourne :

void

 

Lancers :

IMuException

La connexion n’a pas pu être ouverte.

Disconnect()

void Disconnect()

Ferme la connexion au serveur IMu.

Retourne :

void

 

Login(login, password, spawn)

Map Login(string login, string password, bool spawn)

Se connecte avec l’utilisateur spécifié et le mot de passe correspondant.

Le paramètre password peut être null. Cela amènera le serveur à utiliser l’authentification côté serveur (telle que l’authentification .rhosts) pour authentifier l’utilisateur.

Paramètres :

login (string)

Le nom d’utilisateur avec lequel se connecter.

password (string)

Le mot de passe de l’utilisateur pour l’authentification.

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.

Retourne :

Map  

Lancers :

IMuException

La demande de connexion a échoué.

Exception

Une erreur de communication de socket de bas niveau s’est produite.

Login(login, password)

Map Login(string login, string password)

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

Le paramètre password peut être null. Cela amènera le serveur à utiliser l’authentification côté serveur (telle que l’authentification .rhosts) pour authentifier l’utilisateur.

spawn prend par défaut la valeur true, ce qui amène le serveur à créer 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.

Retourne :

Map  

Lancers :

IMuException

La demande de connexion a échoué.

Exception

Une erreur de communication de socket de bas niveau s’est produite.

Login(login)

Map Login(string login)

Se connecte en tant que l’utilisateur indiqué. Utilise l’authentification côté serveur (telle que l’authentification .rhosts) pour authentifier l’utilisateur.

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.

Retourne :

Map  

Lancers :

IMuException

La demande de connexion a échoué.

Exception

Une erreur de communication de socket de bas niveau s’est produite.

Logout()

Map Logout()

Déconnecte l’utilisateur du serveur.

Retourne :

Map  

Request(request)

Map Request(Map request)

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

Paramètres :

request (Map)

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

Retourne :

Map

Un objet Map contenant la réponse du serveur.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.