4Links EtherSpaceLink Series, User Manual

Page: 59 / 110

EtherSpaceLink-RG408
EtherSpaceLink family User Manual
14. 6 . 6 .
EtherSpaceLink_write_packet()
S ynops i s
int EtherSpaceLink_write_packet ( EtherSpaceLink ESL_unit,
void * buffer,
int length,
int terminator
)
D esc ri pt i on
EtherSpaceLink_write_packet()
sends d
a
t
a
vi
a
t
h
e
E
t
h
e rS
p ac
eL i n
k u
n i t t
o
t
h
e S
p ac
e
W
ir e
l i n k . 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
.
Acc e p t a 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 d a t a p ac k et; a n end - o f-
p ac k et ( E O P ) i s a dded.
EtherSpaceLink_EEP
Th i s i s t h e l a st p a r t , o r a ll , o f a d a t a p ac k et; a n e rr o r end -
o f- p ac k et ( EEP ) i s a dded.
EtherSpaceLink_PART_EOP_EEP
Th i s i s p a r t o f a d a t a p ac k et; n o end - o f- p ac k et i s a dded.
EtherSpaceLink_SPECIAL
Th
i s i s
a c
o m pl ete “s p e
c
i
a
l” p
ac
k et.
EEP woul d n o t n o r m a lly be u sed t o te r m i n a te a p ac k et b u t i s a v a i l a b l e h e r e t o a ss i st w i t h test i n g w h e r e
a
n e rr
o
ne
ou
s
p ac k
et m
a y u
se
f ully
be g ene r
a
ted.
D a
t
a i
s
q u
e
u
ed
i
n b
u ff
e
r
s
i
n t
h
e
A P
I
i
n
o r
de
r
t
o
m
a k
e best
u
se
o f
t
h
e
TC P/
I
P
st
r
e
a
m
a
nd m
a y
n
o
t be
sent i mmed i
a
te ly .
EtherSpaceLink_flush()
s
h
oul d be u sed t o ens u r e t
h
e i mmed i
a
te
t
r a
nsm
i
ss
i o
n
o f a
n
y
b
u ff
e
r
ed d
a
t
a
.
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
c o
nt
a
i n i n g t
h
e d
a
t
a
t
o
be sent
length
t h e n u mbe r o f b y tes o f d a t a t o send.
terminator
i nd i
ca
tes w
h
et
h
e r t
h
i s i s p
a
r t o
f a
p
ac
k et ,
a
n o r m
a
l p
ac
k et o r
a
n e rr o r
Retu r ns
z
e r
o
d
a
t
a w a
s s
u cc
ess
f ully q u
e
u
ed
f o
r t r
a
nsm i ss i
o
n t
o
t
h
e
E
t
h
e rS
p ac
eL i n
k u
n i t.
n o n -z e r o a n e rr o r o cc u rr ed; d a t a m a y n o t ha v e been sent t o t h e u n i t.
4Links Limited
www.4Links.co.uk
support@4Links.co.uk
page 59 of 110
T +44 1908 642001; F +44 1908 363463
Milton Keynes MK3 6EB, UK
Suite EU2, Bletchley Park