Regroupement de fonctions d’API

Article
06/13/2023

L’API de regroupement utilise les fonctions suivantes :

Fonctions d’initialisation et de nettoyage de groupe

Fonction	Description
PeerGroupShutdown	Ferme un groupe d’homologues créé avec PeerGroupStartup et supprime toutes les ressources allouées.
PeerGroupStartup	Lance un groupe d’homologues à l’aide d’une version demandée de l’infrastructure homologue.

Fonctions de création et d’accès de groupe

Fonction	Description
PeerGroupClose	Invalide le handle de groupe d’homologues obtenu par un appel précédent à la fonction PeerGroupCreate, PeerGroupJoin ou PeerGroupOpen .
PeerGroupConnect	Lance une recherche PNRP pour un groupe d’homologues et tente de s’y connecter. Une fois cette fonction appelée avec succès, un homologue peut communiquer avec d’autres membres du groupe d’homologues.
PeerGroupConnectByAddress	Tente de se connecter au groupe d’homologues auquel d’autres homologues avec des adresses IPv6 connues participent.
PeerGroupCreate	Crée un groupe d’homologues.
PeerGroupCreateInvitation	Retourne une chaîne XML qui peut être utilisée par l’homologue spécifié pour joindre un groupe.
PeerGroupCreatePasswordInvitation	Retourne une chaîne XML qui peut être utilisée par l’homologue spécifié pour joindre un groupe avec un mot de passe correspondant.
PeerGroupDelete	Supprime les données locales et le certificat associés à un groupe d’homologues.
PeerGroupGetStatus	Récupère la status actuelle d’un groupe.
PeerGroupIssueCredentials	Émet des informations d’identification, y compris une console GMC, pour une identité spécifique et retourne éventuellement une chaîne XML d’invitation que l’homologue invité peut utiliser pour rejoindre un groupe d’homologues.
PeerGroupJoin	Permet à un homologue avec une invitation de rejoindre un groupe d’homologues existant.
PeerGroupOpen	Ouvre un groupe d’homologues qu’un homologue a créé ou joint.
PeerGroupParseInvitation	Retourne une structure PEER_INVITATION_INFO avec les détails d’une invitation spécifique.
PeerGroupPasswordJoin	Permet à un homologue disposant d’une invitation et du mot de passe correct de rejoindre un groupe d’homologues protégé par mot de passe.

Fonctions d’informations sur les groupes et les membres

Fonction	Description
PeerGroupEnumMembers	Crée une énumération des membres du groupe d’homologues disponibles et les informations d’appartenance associées.
PeerGroupGetProperties	Récupère des informations sur les propriétés d’un groupe spécifié.
PeerGroupSetProperties	Définit les propriétés actuelles du groupe d’homologues. Dans la version 1.0 de cette API, seul le créateur du groupe d’homologues peut effectuer cette opération.

Fonctions de gestion des enregistrements et des enregistrements

Fonction	Description
PeerGroupAddRecord	Ajoute un nouvel enregistrement au groupe d’homologues, qui est propagé à tous les homologues participants.
PeerGroupDeleteRecord	Supprime un enregistrement d’un groupe d’homologues. Seul le créateur d’un enregistrement peut le supprimer.
PeerGroupEnumRecords	Crée une énumération d’enregistrements de groupe d’homologues.
PeerGroupGetRecord	Récupère un enregistrement de groupe spécifique.
PeerGroupSearchRecords	Recherche dans la base de données du groupe d’homologues local les enregistrements qui correspondent aux critères fournis.
PeerGroupUpdateRecord	Mises à jour un enregistrement dans un groupe d’homologues spécifique.

Fonctions d’importation/exportation de base de données de groupe

Fonction	Description
PeerGroupExportDatabase	Exporte une base de données de groupe d’homologues vers un fichier spécifique, qui peut être transportée vers un autre ordinateur et importée avec la fonction PeerGroupImportDatabase .
PeerGroupImportDatabase	Importe une base de données de groupe d’homologues à partir d’un fichier local.

Fonctions de connexion directe

Fonction	Description
PeerGroupCloseDirectConnection	Ferme une connexion directe spécifique entre deux homologues.
PeerGroupEnumConnections	Crée une énumération des connexions actuellement actives sur l’homologue.
PeerGroupOpenDirectConnection	Établit une connexion directe avec un autre homologue dans un groupe d’homologues.
PeerGroupSendData	Envoie des données à un membre via un voisin ou une connexion directe.

Infrastructure des événements de groupe

Fonction	Description
PeerGroupGetEventData	Permet à une application de récupérer les données retournées par un événement de regroupement.
PeerGroupRegisterEvent	Inscrit un homologue pour des événements de groupe d’homologues spécifiques.
PeerGroupUnregisterEvent	Annule l’inscription d’un homologue de la notification des événements homologues associés au handle d’événement fourni.

Fonctions de conversion de temps de groupe

Fonction	Description
PeerGroupPeerTimeToUniversalTime	Convertit la valeur d’heure de référence gérée par le groupe d’homologues en une valeur de temps localisée appropriée pour l’affichage sur un ordinateur homologue.
PeerGroupUniversalTimeToPeerTime	Convertit une valeur d’heure locale de l’ordinateur d’un homologue en valeur de temps de groupe d’homologues commune.

Fonctions de configuration de groupe

Fonction	Description
PeerGroupExportConfig	Exporte la configuration de groupe pour un homologue sous la forme d’une chaîne XML qui contient l’identité, le nom du groupe et la console GMC de l’identité.
PeerGroupImportConfig	Importe une configuration de groupe d’homologues pour une identité en fonction des paramètres spécifiques d’une chaîne de configuration XML fournie.