Aim AFDX / ARINC 664, Справочное руководство

Страница: 180 / 252

168 Reference Manual AFDX / ARINC 664 Application Interface Library
Section 4 – Function Reference: Receiver Functions
Output:
T
T
Y
Y
_
_
F
F
D
D
X
X
_
_
U
U
D
D
P
P
_
_
B
B
L
L
O
O
C
C
K
K
_
_
R
R
E
E
A
A
D
D
_
_
O
O
U
U
T
T
* * p p x x _ _ U U d d p p B B l l o o c c k k R R e e a a d d O O u u t t
A pointer to an array of structures. Each structure contains result information about
an individual UDP read operation. The array contains ul_PortCount elements.
typedef struct {
AiUInt32 ul_PortCount;
TY_FDX_BLOCK_READ_OUT_PORT* px_UdpBlockReadOutPortArray;
}TY_FDX_UDP_BLOCK_READ_OUT;
Note: The maximum size of the number of bytes to be returned is limited. The limit is system
dependent. If the maximum was exceeded the ul_PortCount of the output structure will
be less than the ul_PortCount of the input structure.
u
u
l
l
_
_
P
P
o
o
r
r
t
t
C
C
o
o
u
u
n
n
t
t
Number of UDP ports of which data are read from.
T T Y Y _ _ F F D D X X _ _ B B L L O O C C K K _ _ R R E E A A D D _ _ O O U U T T _ _ P P O O R R T T
*
*
p
p
x
x
_
_
U
U
d
d
p
p
B
B
l
l
o
o
c
c
k
k
R
R
e
e
a
a
d
d
O
O
u
u
t
t
P
P
o
o
r
r
t
t
A
A
r
r
r
r
a
a
y
y
typedef struct {
AiUInt32 ul_UdpHandle;
AiReturn st_ResultCode;
AiUInt32 ul_MsgRead;
void *pv_ReadBuffer;
} TY_FDX_BLOCK_READ_OUT_PORT;
u
u
l
l
_
_
U
U
d
d
p
p
H
H
a
a
n
n
d
d
l
l
e
e
The handle of the associated UDP port. This may be a handle to either a Sampling or
Queuing port.
s
s
t
t
_
_
R
R
e
e
s
s
u
u
l
l
t
t
C
C
o
o
d
d
e
e
The result of the individual read operation for the associated UDP port.
u
u
l
l
_
_
M
M
s
s
g
g
R
R
e
e
a
a
d
d
Number of Messages actually read (0 or 1).
For APX-GNET this field is misused to indicate to the downlayered software the size of
the provided buffer which is provided with pv_ReadBuffer. So it is recommended to set
this field with a call to APX-GNET board.
v
v
o
o
i
i
d
d
*
*
p
p
v
v
_
_
R
R
e
e
a
a
d
d
B
B
u
u
f
f
f
f
e
e
r
r
Pointer to the data buffer the Entries should be stored. Required size of buffer can be
calculated: ul_UdpMaxMessageSize + sizeof(TY_FDX_UDP_HEADER).
The ul_UdpMaxMessageSize is defined with function FdxCmdRxUDPCreatePort.
One Entry specifies one Message, which means one complete sampling or queuing
message. For special system information and administration a Fix sized Header is
preceded.
For layout of such an entry refer to definition in function FdxCmdRxUDPRead.
Return Value
Returns FDX_OK on success or a negative error code on error.
Error Codes: FDX_ERR