5 unstable releases
0.3.2 | Oct 3, 2023 |
---|---|
0.3.1 | Oct 3, 2023 |
0.3.0 | Mar 19, 2022 |
0.2.2 | Nov 2, 2021 |
0.1.0 | Jun 27, 2021 |
#113 in #connection
71KB
1.5K
SLoC
Client library for creating integrations against DDMW.
Establishing connections & basic communication
Connections can be established to the DDMW server's client interfaces using
the connect
function in the conn
module. This
module also provides functions for:
- sending commands and receiving replies.
- ask the server who owns the connection.
The connect
method supports optionally authenticating the connection, but
this can also be performed explicitly after the connection has been
established using the authenticate()
method
in the auth
module.
Application configuration
Most, if not all, DDMW applications will require a few common configuration
parameters. To this end a common configuration format is specified in the
conf
module. There's a helper function for loading and parsing such a
configuration file.
The configuration file is entirely optional, but it provides a common configuration file structure for applications to use.
Probing the server
The DDMW servers' client interfaces support a few common commands which
are typically used to simply for low-level availability checks and for
quering the servers for static information. The probe
module contains
helper functions for accessing this type of data.
Data transfers
The primary role of integrations such as native DDMW applications or
proxies is to send and receiver messages or streams. The [msg
] and
strm
modules provide functions for sending and receiving messages and
streams.
Management
To create management clients the mgmt
module wrapper contains helper
functions for management commands.
Dependencies
~5–13MB
~156K SLoC