Description

Le SHIPHarbourL’API n’autorise finalement la transmission que d’un seul type de message, appelé message générique. Ce type de message contient les champs obligatoires de tous les messages, ainsi que toutes les charges utiles de message possibles.

Champs de message

version

Doit être défini sur le VersionCode du protocole actuellement utilisé.

error

Doit être défini sur NONE lors de l’envoi d’une nouvelle demande à SHIPHarbour Master. Si une demande échoue, ce champ est défini sur le code d’erreur le plus descriptif pour tous les messages de réponse.

payload

Contient exactement l’un des types suivants :

• open – Ces messages sont utilisés pour établir une nouvelle connexion entre SHIPHarbour Master et un client.
• close – Ces messages sont utilisés pour mettre fin à une connexion active avec SHIPHarbour Master.
• pluginInfo – Ces messages sont envoyés spontanément par SHIPHarbour Master afin d’informer les clients des interfaces de communication disponibles.
• moduleInfo – Ces messages sont envoyés spontanément par SHIPHarbour Master afin d’informer les clients des connexions et des déconnexions des Endpoints.
• routine – Toutes les demandes qui visent directement à interagir avec un module intégré SERIOUS sont encapsulées dans ce type de message.