aboutsummaryrefslogtreecommitdiffstats
path: root/LIBAXL_ERROR_REQUEST.3
blob: 2cecb83ede8d011b5360c941043f3368b9d42580 (plain) (blame)
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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
.TH LIBAXL_ERROR_REQUEST 3 libaxl
.SH NAME
LIBAXL_ERROR_REQUEST - Invalid request operation code
.SH SYNOPSIS
.nf
#include <libaxl.h>

#define LIBAXL_ERROR_REQUEST 1
struct libaxl_error_request {
        uint8_t  \fI__zero\fP;
        uint8_t  \fIcode\fP;
        uint16_t \fIsequence_number\fP;
        uint32_t \fI__unused1\fP;
        uint16_t \fIminor_opcode\fP;
        uint8_t  \fImajor_opcode\fP;
        uint8_t  \fI__unused\fP[21];
};
.fi
.SH DESCRIPTION
The major or minor operation code in the request
does not specify a valid request.
.PP
The value of the
.I __zero
field is 0
.RI ( LIBAXL_ERROR ),
which signifies that the received message is an
error message. The value of the
.I code
field is
.I LIBAXL_ERROR_REQUEST
to signify that the error is of the error type
described in this document.
.PP
The value of the
.I sequence_number
field is the sequence number returned by the
.BR libaxl_send_request (3)
function for the failed request.
.PP
The value of the
.I major_opcode
and
.I minor_opcode
fields are the major and minor (if any) operation
codes in the failed request.
.PP
Other fields are unused and may have any value.
.SH SEE ALSO
.BR LIBAXL_ERROR (3)