Control Protocol

Enhanced PTP User Guide (UG1602)

Document ID
UG1602
Release Date
2022-10-18
Revision
1.0 English

The client connects to the control server address. The version of the protocol is included in the address. The current version is 1 and the address is:

/var/run/sfptpd-control-v1.sock

The client will only succeed in connecting to the server if it has write permissions to the server socket and the server socket is created using the umask the server process inherited, therefore normally it will be necessary for the client to be run as root.

A command is sent as plain text in a Unix Domain datagram, for example:

<command string>

There is no return channel and it does not matter to what address, if any, the client's socket is bound.

Two example implementations of the client are included, both of which are suitable to invoke from the command line or to incorporate in custom scripts or operations code.