readme + filename convention for diags
parent
42658c5e5f
commit
2487bd6ad9
|
@ -0,0 +1,8 @@
|
|||
# writing convention
|
||||
|
||||
Each diagram filename should be formatted as:
|
||||
|
||||
seq-service.diag: message sequence diagram
|
||||
pkt-service-info.pktdiag: message format
|
||||
|
||||
See the currently available files as examples.
|
|
@ -7,9 +7,10 @@ fi
|
|||
|
||||
echo "font : $FONT"
|
||||
|
||||
for i in *\.diag
|
||||
DIAG=diag
|
||||
for i in *\.$DIAG
|
||||
do
|
||||
PNG=$(echo ${i} | sed "s/diag$/pdf/")
|
||||
PNG=$(echo ${i} | sed "s/$DIAG$/pdf/")
|
||||
|
||||
if [ ! -f ${PNG} ] || [ $(stat -c "%X" ${PNG}) -lt $(stat -c "%X" ${i}) ]
|
||||
then
|
||||
|
|
|
@ -7,38 +7,6 @@ This service creates a path on the relevent remote location, going through anyth
|
|||
* authorizations
|
||||
* code the -d option
|
||||
|
||||
# Connection
|
||||
|
||||
Client -> Remoted: service to contact (ex: pongd)
|
||||
|
||||
format: [u8 (action); u16 (length); XXX (options)]
|
||||
|
||||
Client -> Remoted: action (connect|listen) + options
|
||||
|
||||
format: [u8 (action); u16 (length); XXX (options)]
|
||||
|
||||
example 1: action = connect => options = uri (ex: udp://example.com:5000)
|
||||
format: [u8 (1); u16 (22); udp://example.com:5000]
|
||||
|
||||
example 2: action = listen => options = uri (ex: tcp://localhost:9000)
|
||||
format: [u8 (2); u16 (20); tcp://localhost:9000]
|
||||
|
||||
(optional) Client -> Remoted: options (environement variables)
|
||||
|
||||
example: action = options => option = VAR=X
|
||||
format: [u8 (4); u16 (20); VAR=X]
|
||||
|
||||
The client sends all options this way, one at a time.
|
||||
This sequence of messages is ended with the following message.
|
||||
|
||||
Client -> Remoted: END
|
||||
|
||||
format: [u8 (5)]
|
||||
|
||||
Remoted -> Client: unix socket
|
||||
|
||||
In the case the application has environement variables to pass to the remoted service,
|
||||
|
||||
### authorizations
|
||||
|
||||
The idea is to have a simple configuration file for authentication of remote connections, such as:
|
||||
|
|
Reference in New Issue