> For the complete documentation index, see [llms.txt](https://docs.edgegap.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.edgegap.com/docs.edgegap.com-fr/unity/server-browser.md). # Server Browser Ce SDK est un kit de démarrage optionnel pour les utilisateurs de Unity, qui peut être étendu et personnalisé par la suite. ## 💡 Fonctionnalités Accédez à des fonctionnalités automatisées prêtes à l'emploi en installant notre SDK : {% columns %} {% column %} * Exemples complets * Gestion du cycle de vie * Gestion de capacité {% endcolumn %} {% column width="33.33333333333333%" %} * Compilateur de requêtes de filtre * Définitions de types (C#) * Test local de développement {% endcolumn %} {% column width="33.33333333333333%" %} * Multiplateforme * Facile à personnaliser * Nouvelle tentative automatisée {% endcolumn %} {% endcolumns %} ## ✔️ Préparation ## 🍀 Démarrage Ce guide suppose une connaissance de base des [Server Browser](/docs.edgegap.com-fr/learn/server-browser.md) concepts et d'un Server Browser opérationnel. {% hint style="success" %} **Nous vous recommandons vivement d'importer notre exemple d'auto-attribution** pour suivre le code au fil de la lecture de 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 inclus dans 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 de points de terminaison, gestion des erreurs et automatisations de journalisation. * Compilateur de filtres - utilitaires fortement typés pour construire 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") - des gestionnaires d'exemple avec réservations auto-attribuées, * [#custom-search](#custom-search "mention") - des gestionnaires d'exemple avec choix manuel de l'instance. ### Agent serveur **La gestion du cycle de vie du serveur et de la capacité** est assurée par l'Agent serveur. Une fois instancié, le **MonoBehaviour parent (gestionnaire) de l'agent doit initialiser l'agent** et fournir : * `onMonitorUpdate` callback - observer 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 des validations et connectera les observateurs de journalisation, pour terminer par un simple appel au point de terminaison de l'API de surveillance 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 moment : * `DiscoverInstance` pour créer l'instance serveur initiale et les slots, puis lancer le heartbeat, * `DeleteInstance` une fois la partie terminée / 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 (lors de l'arrivée du joueur ou de son abandon) 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 de slot/instance sont **en file d'attente et effectuées par lots par défaut** (mode Heartbeat) afin de maximiser la scalabilité. 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 supprimer les clés non indexées, omettez-les simplement. {% endhint %} L'agent maintient automatiquement un heartbeat pour garder le serveur découvrable pendant son fonctionnement. Si l'agent ne peut 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 de 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 le nombre de sièges disponibles pour tout slot avec des réservations confirmées, * accepter ou refuser la connexion à l'aide de méthodes spécifiques au netcode. Lorsqu'un joueur abandonne la partie, le gestionnaire est censé augmenter le nombre de sièges disponibles pour ce slot. {% hint style="info" %} Laissez un court délai aux joueurs pour se reconnecter avant l'abandon en cas de plantage inattendu. {% 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 - observer les changements de santé du service, * `onInstancesUpdate` callback - observer et réagir aux changements de la liste des instances. Une fois initialisé, cet agent fournira automatiquement des validations et connectera les observateurs de journalisation, pour terminer par un simple appel au point de terminaison de l'API de surveillance 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 moment : * `ReserveSeats` pour créer une réservation de capacité pour une instance/slot particulière ou une auto-attribution, * `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 de l'instance et les informations sur les slots pour une instance spécifique, * `Status` pour vérifier l'état de santé du service Server Browser. Lorsqu'une nouvelle connexion de 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 afin de 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-attribution Utilise des réservations auto-attribué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 disposant d'un nombre de sièges suffisant. ### Recherche personnalisée Inclut une implémentation complète démontrant comment rechercher des instances et des slots, connecter les éléments d'interface utilisateur et laisser le joueur choisir manuellement où il souhaite réserver de la capacité. ## ⚙️ Personnalisation Ce SDK est destiné à être étendu et modifié, bien que certaines modifications puissent être risquées : ✅ Gestionnaire - connectez en toute sécurité les observateurs de l'interface utilisateur et effectuez de petites ajouts ou modifications, ⚠️ Agent - modifiez le cycle de vie et la gestion de capacité à vos risques et périls, ⚠️ API - écrivez votre propre intégration depuis zéro, en utilisant des utilitaires sélectionnés. 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 bien vous familiariser avec les concepts de [Server Browser en profondeur](/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. Aperçu des événements émis par l'observable `Surveillance` :
Type d'actionMessage d'événementDescription
🟢 Mise à jour sainTous les systèmes sont opérationnels.
🟢 Mise à jour non sainProblème inattendu.
🔴 Erreuréchec de récupération de la surveillanceMauvaise configuration ou problème inattendu.
🟡 Avertissementle délai d'attente de la requête a été plafonné au heartbeat [{timeout}]Empêche les conditions de concurrence.
Aperçu des événements (actions) émis par l'observable `Instance`:
Type d'actionMessage d'événementDescription
🟢 Mise à jour découverteDécouverte d'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.
🔴 Erreurdécouverte en doubleUne instance avec cet ID de requête est déjà découverte.
🔴 Erreuréchec de 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 atteindre 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 nouvelle tentativeÉchec de la mise à jour de l'instance, possiblement en raison 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 en raison 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}]Capacité de sièges du slot et/ou métadonnées mises à jour avec succès.
🟡 Avertissementl'agent a limité la mise à jour concurrente des slotsTentative de mise à jour concurrente empêchée (condition de concurrence).
🔴 Erreuréchec de mise à jour du slot (introuvable) [{slot}]Un slot avec ce nom n'est pas encore défini pour cette instance.
🔴 Erreuréchec de mise à jour du slot (sièges insuffisants) [{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 nouvelle tentative [{slot}]Échec de la mise à jour du slot, possiblement en raison d'une limitation de débit ou d'une erreur.
Aperçu des événements (actions) émis par l'observable `Confirmations`:
Type d'actionMessage d'é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 aussi les ID de joueurs expirés et inconnus que le gestionnaire doit résoudre (accepter/exclure).
🔴 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. Aperçu des événements émis par l'observable `Surveillance` :
Type d'actionMessage d'événementDescription
🟢 Mise à jour sainTous les systèmes sont opérationnels.
🟢 Mise à jour non sainProblème inattendu.
🔴 Erreuréchec de récupération de la surveillanceMauvaise configuration ou problème inattendu.
Aperçu des événements émis par l'observable `Instances`:
Type d'actionMessage d'événementDescription
🔵 Notificationsièges réservésRéservation de sièges réussie.
🔴 Erreuréchec de réservation de sièges (introuvable)#auto-assign - nom de politique introuvable (supprimée ou inactive).
#custom-search - instance ou slot introuvable.
🔴 Erreuréchec de réservation de sièges (capacité atteinte)#auto-assign - politique a atteint la capacité maximale.
#custom-search - slot a atteint la capacité maximale.
🔴 Erreuréchec de réservation de siègesÉchec de la réservation de sièges, politique, ID de requête ou ID de slot probablement 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 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 des instancesÉchec de récupération de la page suivante, probablement en raison 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, ajout en têteDétails d'une instance hors de la liste actuelle récupérés.
🔴 Erreuréchec de récupération des détails de l'instanceÉchec de récupération des détails, probablement en raison d'un ID de requête invalide.
[^1]: Objet de transfert de données --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## 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.