Documentation
¶
Overview ¶
Package main
The `relay` package contains the implementation of the Relay server and client. The Relay server can be used to relay messages between peers on a single network channel. In this implementation the transport layer is the WebSocket protocol.
Between the server and client communication has been design a custom protocol and message format. These messages are transported over the WebSocket connection. Optionally the server can use TLS to secure the communication.
The service can support multiple Relay server instances. For this purpose the peers must know the server instance URL. This URL will be sent to the target peer to choose the common Relay server for the communication via Signal service.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package auth manages the authentication process with the relay server.
|
Package auth manages the authentication process with the relay server. |
|
Package client contains the implementation of the Relay client.
|
Package client contains the implementation of the Relay client. |
|
Package messages provides the message types that are used to communicate between the relay and the client.
|
Package messages provides the message types that are used to communicate between the relay and the client. |
|
address
Deprecated: This package is deprecated and will be removed in a future release.
|
Deprecated: This package is deprecated and will be removed in a future release. |
|
auth
Deprecated: This package is deprecated and will be removed in a future release.
|
Deprecated: This package is deprecated and will be removed in a future release. |
Click to show internal directories.
Click to hide internal directories.