# Server Browser Ce SDK est un kit de démarrage optionnel pour les utilisateurs de Unity, qui peut être étendu et personnalisé ultérieurement. ## 💡 Fonctionnalités Accédez à des fonctionnalités automatisées préconstruites en installant notre SDK : {% columns %} {% column %} * Exemples complets * Gestion du cycle de vie * Gestion de la capacité {% endcolumn %} {% column width="33.33333333333333%" %} * Compilateur de requêtes de filtre * Définitions de types (C#) * Tests en développement local {% endcolumn %} {% column width="33.33333333333333%" %} * Multiplateforme * Facile à personnaliser * Nouvelle tentative automatique {% endcolumn %} {% endcolumns %} ## ✔️ Préparation ## 🍀 Premiers pas Ce guide suppose une connaissance de base des [Server Browser](/docs.edgegap.com-fr/learn/server-browser.md) concepts et d’un Server Browser fonctionnel. {% hint style="success" %} **Nous recommandons vivement d’importer notre exemple d’auto-assignation** pour suivre le code au fur et à mesure que vous lisez ce document. Vous pouvez le faire dans `Unity Package Manager > Edgegap SDK > Samples` . {% endhint %} ### Aperçu Ce package comprend : * Fichiers d’exécution - seront compilés et intégrés à vos builds client et serveur : * Utilitaires spécifiques au service : * [#server-agent](#server-agent "mention") - une intégration serveur complète à réutiliser/étendre, * [#client-agent](#client-agent "mention") - une intégration client complète à réutiliser/étendre. * Fonctions API - définitions des points de terminaison, gestion des erreurs et automatisations de journalisation. * Filter Compiler - utilitaires fortement typés pour créer des requêtes de filtre. * Spécifique au service DTO[^1] - conteneurs de données typés pour l’API Server Browser. * Utilitaires partagés - journalisation, HTTP, ping, observables, etc... * Partagé DTO[^1] - utilisé par plusieurs services Edgegap pour faire circuler les données. * Fichiers d’exemple - inclus et compilés UNIQUEMENT s’ils sont importés dans votre projet : * [#auto-assign](#auto-assign "mention") - exemples de gestionnaires avec réservations auto-assignées, * [#custom-search](#custom-search "mention") - exemples de gestionnaires avec choix manuel de l’instance. ### Agent serveur **La gestion du cycle de vie et de la capacité du serveur** est effectuée par l’agent serveur. Une fois instancié, **le MonoBehaviour parent (gestionnaire) de l’agent doit initialiser l’agent** et fournir : * `onMonitorUpdate` callback - surveiller les changements de santé du service, * `onInstanceUpdate` callback - observer et réagir aux changements d’instance et de slot, * `onConfirmationsUpdate` callback - observer et réagir à l’authentification fédérée. Une fois initialisé, cet agent fournira automatiquement les validations et branchera les observateurs de journalisation, pour finir par un appel unique au point de terminaison de l’API de monitoring afin d’indiquer l’état de santé du service. Le gestionnaire de l’agent est censé prendre le contrôle et appeler les fonctions de l’agent à partir de ce point : * `DiscoverInstance` pour créer l’Instance serveur initiale et les slots, et lancer le heartbeat, * `DeleteInstance` une fois le match terminé / pour empêcher de nouveaux joueurs de rejoindre, * `ConfirmReservation` lorsque des joueurs rejoignent, afin de vérifier leur identité et l’attribution du slot, * `UpdateSlot` pour mettre à jour la capacité du slot (à l’arrivée / au départ d’un joueur) ou modifier les métadonnées, * `UpdateInstance` pour modifier les métadonnées de l’instance, * `Status` pour vérifier l’état de santé du service Server Browser. {% hint style="success" %} Les confirmations et les mises à jour des slots/de l’instance sont **placées en file d’attente et exécutées par lots par défaut** (mode Heartbeat) afin de maximiser l’évolutivité. Pour itérer plus rapidement pendant les tests de développement, utilisez le mode Greedy. {% endhint %} {% hint style="warning" %} **Lors de la mise à jour des métadonnées, tous les indices doivent être définis.** Pour désactiver les clés non indexées, omettez-les simplement. {% endhint %} L’agent maintient automatiquement un heartbeat pour conserver la découvrabilité du serveur pendant son exécution. Si l’agent ne parvient pas à joindre votre Server Browser pendant plusieurs heartbeats consécutifs (configurable) : * moins que le maximum - l’instance sera automatiquement redécouverte, * plus que le maximum - l’instance sera automatiquement supprimée. Lorsqu’une nouvelle connexion joueur est établie, le joueur est censé envoyer son ID de réservation (ID joueur tiers) au serveur de jeu en utilisant votre netcode, afin d’effectuer la confirmation de réservation. Une fois `onConfirmationsUpdate` déclenché, le gestionnaire doit effectuer des actions supplémentaires : * appeler `UpdateSlot` pour réduire les sièges disponibles pour tout slot avec des réservations confirmées, * accepter ou refuser la connexion à l’aide des méthodes spécifiques au netcode. Lorsqu’un joueur quitte la partie, le gestionnaire est censé augmenter le nombre de sièges disponibles pour ce slot. {% hint style="info" %} Accordez un court délai aux joueurs pour se reconnecter avant de considérer qu’ils ont abandonné en cas de plantages inattendus. {% endhint %} ### Agent client **La recherche d’instances, la pagination, le filtrage et les réservations** sont effectués par l’agent client. Une fois instancié, **le MonoBehaviour parent (gestionnaire) de l’agent doit initialiser l’agent** et fournir : * `onMonitorUpdate` callback - surveiller les changements de santé du service, * `onInstancesUpdate` callback - observer et réagir aux changements de la liste d’instances. Une fois initialisé, cet agent fournira automatiquement les validations et branchera les observateurs de journalisation, pour finir par un appel unique au point de terminaison de l’API de monitoring afin d’indiquer l’état de santé du service. Le gestionnaire de l’agent est censé prendre le contrôle et appeler les fonctions de l’agent à partir de ce point : * `ReserveSeats` pour créer une réservation de capacité pour une instance/slot particulière ou en auto-assignation, * `ListInstances` pour lister les instances avec un filtre, un ordre, un curseur et une taille de page spécifiques, * `GetNextPage` pour récupérer davantage d’instances avec les paramètres actuels (filtres, etc.), * `RefreshList` pour vider le cache et recharger la première page, ou actualiser avec un curseur spécifique, * `GetInstanceDetails` pour récupérer les métadonnées et les informations de slots d’une instance spécifique, * `Status` pour vérifier l’état de santé du service Server Browser. Lorsqu’une nouvelle connexion joueur est établie, le joueur est censé envoyer son ID de réservation (ID joueur tiers) au serveur de jeu en utilisant votre netcode, afin d’effectuer la confirmation de réservation. {% hint style="success" %} Enregistrez les détails de connexion dans le client ou le backend du jeu pour vous reconnecter en cas de plantage inattendu. {% endhint %} ## 🧪 Exemples Commencez avec des exemples incluant une intégration complète et fonctionnelle pour le serveur et le client. ### Auto-Assign Utilise des réservations auto-assignées, le client ne spécifiant que le nom de la politique. Le Server Browser choisit automatiquement une instance correspondant au filtre de la politique et un slot avec suffisamment de places. ### Recherche personnalisée Comprend une implémentation complète démontrant comment rechercher des instances et des slots, connecter les éléments de l’interface utilisateur, et laisser le joueur choisir manuellement où il souhaite réserver de la capacité. ## ⚙️ Personnalisation Ce SDK est conçu pour être étendu et modifié, bien que certaines modifications puissent être risquées : ✅ Gestionnaire - connecter en toute sécurité les observateurs de l’interface et effectuer de petites additions ou modifications, ⚠️ Agent - modifier la gestion du cycle de vie et de la capacité à vos risques et périls, ⚠️ API - écrire votre propre intégration de zéro, en utilisant des utilitaires triés sur le volet. Les gestionnaires peuvent observer tous les événements émis par les agents serveur et client comme décrit ci-dessous. {% hint style="warning" %} Assurez-vous de vous familiariser avec les concepts de [Server Browser approfondi](/docs.edgegap.com-fr/learn/server-browser.md) avant d’apporter des personnalisations. {% endhint %} ### Événements serveur L’agent serveur émet des événements (actions) que le gestionnaire parent doit observer et consommer. Prévisualiser les événements émis par l’observable `Monitor` :
Type d’actionMessage de l’événementDescription
🟢 Mise à jour sainTous les systèmes sont opérationnels.
🟢 Mise à jour malsainProblème inattendu.
🔴 Erreuréchec de récupération du monitorMauvaise configuration ou problème inattendu.
🟡 Avertissementdélai d’attente de la requête limité au heartbeat [{timeout}]Empêche les conditions de concurrence.
Prévisualiser les événements (actions) émis par l’observable `Instance`:
Type d’actionMessage de l’événementDescription
🟢 Mise à jour découverteDécouverte de l’instance terminée avec succès. Peut être déclenchée si l’instance a perdu la connexion en raison d’une condition temporaire puis a été redécouverte.
🔴 Erreurdoublon de découverteUne instance avec cet ID de requête est déjà découverte.
🔴 Erreuréchec de la découverteProblème inattendu lors de la découverte.
🔵 Notificationheartbeat OKHeartbeat terminé avec succès.
🟡 Avertissementéchec du heartbeat [{consecutive}/{maximum}]Échec du heartbeat, le serveur n’a pas pu joindre le Server Browser.
🔵 Notificationmise à jour de l’instance mise en file d’attenteMise à jour de l’instance mise en file d’attente pour le prochain lot (heartbeat/greedy).
🟢 Mise à jour instance mise à jourMétadonnées de l’instance mises à jour avec succès.
🔴 Erreuréchec de mise à jour de l’instance, mise en file d’attente pour réessaiÉchec de la mise à jour de l’instance, possiblement à cause d’une limitation de débit ou d’une erreur.
🟢 Mise à jour instance suppriméeL’instance n’est plus découvrable par les joueurs.
🟢 Mise à jour échec de suppression de l’instance (introuvable)L’instance a peut-être expiré en raison d’un trop grand nombre de heartbeats manqués.
🔴 Erreuréchec de suppression de l’instanceÉchec de la suppression de l’instance, possiblement à cause d’une limitation de débit ou d’une erreur.
🔵 Notificationmise à jour du slot mise en file d’attente [{slot}]Mise à jour du slot mise en file d’attente pour le prochain lot (heartbeat/greedy).
🟢 Mise à jour slot mis à jour [{slot}]La capacité en sièges du slot et/ou ses métadonnées ont été mises à jour avec succès.
🟡 Avertissementl’agent a limité en concurrent la mise à jour du slotTentative de mise à jour concurrente empêchée (condition de concurrence).
🔴 Erreuréchec de mise à jour du slot (introuvable) [{slot}]Aucun slot de ce nom n’est encore défini pour cette instance.
🔴 Erreuréchec de mise à jour du slot (pas assez de sièges) [{slot}]La mise à jour du slot a tenté de réduire le nombre de sièges disponibles en dessous de zéro.
🔴 Erreuréchec de mise à jour du slot, mise en file d’attente pour réessai [{slot}]Échec de la mise à jour du slot, possiblement à cause d’une limitation de débit ou d’une erreur.
Prévisualiser les événements (actions) émis par l’observable `Confirmations`:
Type d’actionMessage de l’événementDescription
🔵 Notificationmis en file d’attente [{player}]Confirmation mise en file d’attente pour le prochain lot (heartbeat/greedy).
🟡 Avertissementdoublon [{player}]Tentative de confirmation en double empêchée (déjà en file d’attente).
🟢 Mise à jour confirméRéservations confirmées pour des slots individuels, inclut également les ID de joueurs expirés et inconnus que le gestionnaire doit traiter (accepter/expulser).
🔴 ErreuréchecProblème inattendu avec les confirmations. Vérifiez l’état du service.
### Événements client L’agent client émet des événements (actions) que le gestionnaire parent doit observer et consommer. Prévisualiser les événements émis par l’observable `Monitor` :
Type d’actionMessage de l’événementDescription
🟢 Mise à jour sainTous les systèmes sont opérationnels.
🟢 Mise à jour malsainProblème inattendu.
🔴 Erreuréchec de récupération du monitorMauvaise configuration ou problème inattendu.
Prévisualiser les événements émis par l’observable `Instances`:
Type d’actionMessage de l’événementDescription
🔵 Notificationsièges réservésRéservation de sièges réussie.
🔴 Erreuréchec de réservation des sièges (introuvable)#auto-assign - nom de politique introuvable (supprimée ou inactive). #custom-search - instance ou slot introuvable.
🔴 Erreuréchec de réservation des sièges (capacité atteinte)#auto-assign - la politique a atteint sa capacité maximale. #custom-search - le slot a atteint sa capacité maximale.
🔴 Erreuréchec de réservation des siègesÉchec de la réservation des sièges, possiblement en raison d’une politique, d’un ID de requête ou d’un ID de slot invalide.
🟢 Mise à jour liste des instances récupéréeListe des instances récupérée avec succès.
🟢 Mise à jour page suivante de la liste des instances récupéréePage suivante des instances récupérée avec succès.
🔴 Erreurdernière page de la liste des instances atteinteÉchec de la récupération de la page suivante, essayez d’actualiser ou de modifier les filtres.
🔴 Erreuréchec de récupération de la page suivante de la liste d’instancesÉchec de la récupération de la page suivante, possiblement à cause d’un curseur invalide.
🟢 Mise à jour détails de l’instance récupérésDétails d’une instance listée récupérés avec succès.
🟢 Mise à jour instance non mise en cache, insertion au débutDétails récupérés d’une instance hors de la liste actuelle.
🔴 Erreuréchec de récupération des détails de l’instanceÉchec de récupération des détails, possiblement à cause d’un ID de requête invalide.
[^1]: Objet de transfert de données --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.edgegap.com/docs.edgegap.com-fr/unity/server-browser.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.