4Links EtherSpaceLink Series, User Manual

Page: 64 / 110

EtherSpaceLink-RG408
EtherSpaceLink family User Manual
14. 6 .1 0 .
EtherSpaceLink_read_packet()
S ynops i s
int EtherSpaceLink_read_packet ( EtherSpaceLink ESL_unit,
void * buffer,
int length,
int * terminator
)
D esc ri pt i on
EtherSpaceLink_read_packet()
r e
c
e iv es d
a
t
a f
r
o
m t
h
e S
p ac
e
W
ir e
l
i n
k
vi
a
t
h
e
E
t
h
e rS
p ac
eL i n
k
u n i t. Th e b u ff e r m a y c o nt a i n a ll , o r p a r t , o f a p ac k et , a s i nd i ca ted b y t h e f i n a l p a r a mete r,
terminator
.
S p e c i a l p ac k ets a r e ne v e r r et u r ned b y t h i s i nte r fac e.
U se
EtherSpaceLink_read_packet_full()
i
f
you w i s
h
t o r e
c
e iv e s p e
c
i
a
l p
ac
k ets.
Th
e
po
ss i b
l
e v
a lu
es
f o
r
terminator
a
r e:
EtherSpaceLink_EOP
Th i s i s t h e l a st p a r t , o r a ll , o f a p ac k et; a n end - o f- p ac k et
( E O P ) w a s r e c e iv ed.
EtherSpaceLink_EEP
Th i s i s t h e l a st p a r t , o r a ll , o f a p ac k et c o nt a i n i n g a n
e rr o r ; a n e rr o r end - o f- p ac k et ( EEP ) w a s r e c e iv ed.
EtherSpaceLink_PART_EOP_EEP
Th e p ac k et w a s l a rg e r t ha n t h e a v a i l a b l e b u ff e r .
A n o t h e r r e a d w i ll r et ri e v e m o r e d a t a f r o m t h e s a me
p ac k et.
I nput p ara mete r s
ESL_unit
t
h
e
ha
nd
l
e r et
u
r ned b
y a
s
u cc
ess
f ul
EtherSpaceLink_open()
c o
mm
a
nd.
buffer
a b u ff e r t o c o nt a i n r e c e iv ed d a t a .
length
t
h
e s i
z
e o
f
t
h
e r e
c
e iv e b u
ff
e r .
Output p ara mete r s
terminator
i nd i
ca
tes
w ha
t te r m i n
a
t
o
r, i
f a
n
y
,
w a
s r e
c
e iv ed
Retu r ns
≥ 0 Th e n u mbe r o f d a t a b y tes ac t u a lly i n t h e r e c e iv e b u ff e r .
-
1
A
n e rr o r o
cc
u rr ed.
4Links Limited
www.4Links.co.uk
support@4Links.co.uk
page 64 of 110
T +44 1908 642001; F +44 1908 363463
Milton Keynes MK3 6EB, UK
Suite EU2, Bletchley Park