| Holger Hans Peter Freyther | e024869 | 2016-08-05 15:47:08 +0200 | [diff] [blame] | 1 | ZeroMQ data protocol v1 |
| 2 | ======================= |
| 3 | |
| 4 | The osmo-pcap-server can be configured to publish PCAP data to |
| 5 | zero to many subscribers. The following document describes the |
| 6 | data format used. |
| 7 | |
| 8 | Multiple clients might be connected to the osmo-pcap-server and |
| 9 | use different link headers depending on the underlying device |
| 10 | data is being captured from. |
| 11 | |
| 12 | The messages published are in two categories. These are client |
| 13 | events and client data. Client events are generated on connect, |
| 14 | disconnect, link type change and client data is sent for each |
| 15 | frame. |
| 16 | |
| 17 | Client Events |
| 18 | ^^^^^^^^^^^^^ |
| 19 | |
| 20 | A multi-part message with event.v1.<EVENT_NAME>.<CLIENT_NAME> |
| 21 | as the first part followed by textual data will be generated. |
| 22 | <CLIENT_NAME> is the configured name and <EVENT_NAME> can be |
| 23 | any of: |
| 24 | |
| 25 | * connect |
| 26 | * disconnect |
| 27 | * closingtracefile |
| 28 | |
| 29 | It might contain more information, such as the filename of the |
| 30 | tracefile that was closed. There is no guarantee for the order |
| 31 | and amount of connect/disconnect messages. |
| 32 | |
| 33 | |
| 34 | Client Data |
| 35 | ^^^^^^^^^^^ |
| 36 | |
| 37 | A multi-part message with data.v1.<CLIENT_NAME> to allow to |
| 38 | filter for data and a specific client if wanted. |
| 39 | |
| 40 | It is followed by the pcap_file_header structure as the second |
| 41 | part and then the data as third part. |