Cisco Cisco Firepower Management Center 2000 开发者指南

下载
页码 536
 
2-8
FireSIGHT eStreamer Integration Guide
 
Chapter 2      Understanding the eStreamer Application Protocol 
  Error Message Format
Tip
In data structure diagrams in this book, integers in parentheses such as (
1
) or (
115
) represent constant 
field values. For example, Header Version (
1
) means that the field in the data structure under discussion 
always has a value of 
1
.
The Null message format is shown below. The only non-zero value in the message is the header version.
An example of a null message in binary format follows. Notice that the only non-zero value is in the 
second byte, signifying a header version value of 
1
. The message type and length fields (shaded) each 
have a value of 
0
.
Tip
Examples in this guide appear in binary format to clearly display which bits are set. This is important 
for some messages, such as the event request message and event impact fields.
Error Message Format
Both the client application and the eStreamer service use error messages. Error messages have a message 
type of 1 and contain a header, an error code, an error text length, and the actual error text. Error text can 
contain between 0 and 65,535 bytes. 
When you create custom error messages for your client application, Cisco recommends using 
-1
 as the 
error code.
Byte
0
1
2
3
Bit
0 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
Header Version (1)
Message Type (0)
Message Length (0)
Byte
0
1
2
3
Bit
0 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
0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0