File: 037_msc.cpp

package info (click to toggle)
doxygen 1.8.8-3
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 21,204 kB
  • ctags: 30,799
  • sloc: cpp: 234,372; lex: 34,822; xml: 8,057; python: 2,566; perl: 1,592; ansic: 913; sh: 868; tcl: 594; makefile: 584; php: 445; yacc: 235; objc: 14; java: 1
file content (33 lines) | stat: -rw-r--r-- 952 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
// objective: test the \msc and \endmsc commands
// check: class_sender.xml
// check: class_receiver.xml

/** Sender class. Can be used to send a command to the server.
 *  The receiver will acknowledge the command by calling Ack().
 *  \msc
 *    Sender,Receiver;
 *    Sender->Receiver [label="Command()", URL="\ref Receiver::Command()"];
 *    Sender<-Receiver [label="Ack()", URL="\ref Ack()", ID="1"];
 *  \endmsc
 */
class Sender
{
  public:
    /** Acknowledgement from server */
    void Ack(bool ok);
};

/** Receiver class. Can be used to receive and execute commands.
 *  After execution of a command, the receiver will send an acknowledgement
 *  \msc
 *    Receiver,Sender;
 *    Receiver<-Sender [label="Command()", URL="\ref Command()"];
 *    Receiver->Sender [label="Ack()", URL="\ref Sender::Ack()", ID="1"];
 *  \endmsc
 */
class Receiver
{
  public:
    /** Executable a command on the server */
    void Command(int commandId);
};