UDAP Socket Protocol

UDAP Socket Protocol

Udap has several primary socket based systems:

• Network Device Monitoring
• Endpoint Data Synchronization
• Haptic feedback
• Module Sensors, etc.

At the time of writing this, only the Endpoint system has a robust runtime. This page serves to project a set of guidelines to be used in orchestrating sockets in the future within this project.

Server

The server will host on an appropriate port behind an authenticated endpoint.

Here are some previously defined ports and services:

SERVICE	PORT
UDAP	8327
WS	5058
Monitor	3021
Haptic	80

Authentication & Connection

Endpoint:

POST /ws

Headers:

Authorization: Bearer <token>

Types

Sending Data

Regardless of the source of a data transmission, both sides should be able to read the following structure:

Key	Type	Description
id	string	Id of the targeted element
target	string	Type of the targeted element
operator	string	The intent of the packet (Update/Delete/Etc)
requested	number	The millisecond the request was sent
data	any	The payload of the packet (undefined or data)

An example is provided below in the required format: application/json:

{
    "id": "",
    "target": "metadata",
    "operator": "update",
    "requested": "0",
    "data": null
}