FreeCalypso > hg > fc-selenite
comparison cdg-hybrid/sap/tcpip.pdf @ 9:6da1d56a96a3
cdg-hybrid: import from Magnetite
author | Mychaela Falconia <falcon@freecalypso.org> |
---|---|
date | Sun, 15 Jul 2018 21:08:11 +0000 |
parents | |
children |
comparison
equal
deleted
inserted
replaced
8:ed162c9cd29f | 9:6da1d56a96a3 |
---|---|
1 ;******************************************************************************** | |
2 ;*** File : tcpip.pdf | |
3 ;*** Creation : Wed Mar 11 09:57:43 CST 2009 | |
4 ;*** XSLT Processor : Apache Software Foundation / http://xml.apache.org/xalan-j / supports XSLT-Ver: 1 | |
5 ;*** Copyright : (c) Texas Instruments AG, Berlin Germany 2002 | |
6 ;******************************************************************************** | |
7 ;*** Document Type : Service Access Point Specification | |
8 ;*** Document Name : tcpip | |
9 ;*** Document No. : 8462.000.03.005 | |
10 ;*** Document Date : 2003-09-05 | |
11 ;*** Document Status: BEING_PROCESSED | |
12 ;*** Document Author: NI | |
13 ;******************************************************************************** | |
14 | |
15 | |
16 | |
17 PRAGMA SRC_FILE_TIME "Thu Nov 29 09:55:14 2007" | |
18 PRAGMA LAST_MODIFIED "2003-09-05" | |
19 PRAGMA ID_AND_VERSION "8462.000.03.005" | |
20 | |
21 | |
22 | |
23 CONST TCPIP_HNAMELEN 256 ; Maximum length of the full-qualified domain name of an Internet host (as defined in [RFC 1034]) plus one byte for the zero termination. | |
24 CONST TCPIP_DEFAULT_MTU_SIZE 1500 ; Default size of the maximum transfer unit of the network connection. To be used if no other information is available. | |
25 CONST TCPIP_UNSPECIFIED_IPADDR 0 ; The unspecified IP address (0.0.0.0) | |
26 CONST TCPIP_UNSPECIFIED_PORT 0 ; The unspecified port number. | |
27 | |
28 | |
29 | |
30 VALTAB VAL_ipproto | |
31 VAL 6 TCPIP_IPPROTO_TCP "Value for TCP" | |
32 VAL 17 TCPIP_IPPROTO_UDP "Value for UDP" | |
33 | |
34 VALTAB VAL_event_type | |
35 VAL 1 TCPIP_EVT_CREATE_CNF "Result of TCPIP_CREATE_REQ" | |
36 VAL 2 TCPIP_EVT_CLOSE_CNF "Result of TCPIP_CLOSE_REQ" | |
37 VAL 3 TCPIP_EVT_BIND_CNF "Result of TCPIP_BIND_REQ" | |
38 VAL 4 TCPIP_EVT_LISTEN_CNF "Result of TCPIP_LISTEN_REQ" | |
39 VAL 5 TCPIP_EVT_CONNECT_CNF "Result of TCPIP_CONNECT_REQ" | |
40 VAL 6 TCPIP_EVT_SOCKNAME_CNF "Result of TCPIP_SOCKNAME_REQ" | |
41 VAL 7 TCPIP_EVT_PEERNAME_CNF "Result of TCPIP_PEERNAME_REQ" | |
42 VAL 8 TCPIP_EVT_HOSTINFO_CNF "Result of TCPIP_HOSTINFO_REQ" | |
43 VAL 9 TCPIP_EVT_MTU_SIZE_CNF "Result of TCPIP_MTU_SIZE_REQ" | |
44 VAL 10 TCPIP_EVT_RECV_IND "Indication of incoming data" | |
45 VAL 11 TCPIP_EVT_CONNECT_IND "Indication of incoming connection" | |
46 VAL 12 TCPIP_EVT_CONN_CLOSED_IND "Indication of remotely closed connection" | |
47 VAL 13 TCPIP_EVT_ERROR_IND "Indication of asynchronous error" | |
48 VAL 14 TCPIP_EVT_FLOW_READY_IND "Flow Control: application can send again (not used by a TCPIP primitive!)" | |
49 | |
50 VALTAB VAL_result | |
51 VAL 0 TCPIP_RESULT_OK "Operation was successful." | |
52 VAL 1 TCPIP_RESULT_INVALID_PARAMETER "A parameter was invalid." | |
53 VAL 2 TCPIP_RESULT_INTERNAL_ERROR "An internal error has happened." | |
54 VAL 3 TCPIP_RESULT_ADDR_IN_USE "The address or port is already in use." | |
55 VAL 4 TCPIP_RESULT_OUT_OF_MEMORY "There is not enough memory to fulfill the request." | |
56 VAL 5 TCPIP_RESULT_NOT_SUPPORTED "The socket is not of a type that can support this operation." | |
57 VAL 6 TCPIP_RESULT_UNREACHABLE "The specified host cannot be reached." | |
58 VAL 7 TCPIP_RESULT_CONN_REFUSED "The connection to the specified address was refused by the remote host." | |
59 VAL 8 TCPIP_RESULT_TIMEOUT "The connection attempt timed out without establishing a connection." | |
60 VAL 9 TCPIP_RESULT_IS_CONNECTED "The request could not be fulfilled because the socket is already connected." | |
61 VAL 10 TCPIP_RESULT_HOST_NOT_FOUND "The specified host could not be found in the DNS." | |
62 VAL 11 TCPIP_RESULT_DNS_TEMP_ERROR "A temporary DNS error has occurred. Retrying the query may be successful." | |
63 VAL 12 TCPIP_RESULT_DNS_PERM_ERROR "A permanent DNS error has occurred." | |
64 VAL 13 TCPIP_RESULT_NO_IPADDR "The specified name has been found in the DNS, but no IP address is available." | |
65 VAL 14 TCPIP_RESULT_NOT_CONNECTED "The socket has not been connected yet." | |
66 VAL 15 TCPIP_RESULT_MSG_TOO_BIG "The size of the data buffer is too large for a UDP socket." | |
67 VAL 16 TCPIP_RESULT_CONN_RESET "The connection has been reset by the remote peer." | |
68 VAL 17 TCPIP_RESULT_CONN_ABORTED "The connection was aborted due to timeout or some other error condition." | |
69 VAL 18 TCPIP_RESULT_NO_BUFSPACE "Sending failed temporarily because the space to buffer the message was exhausted. The application should wait for a TCPIP_FLOW_READY_IND event to retry the operation." | |
70 VAL 19 TCPIP_RESULT_NETWORK_LOST "The operation failed because TCP/IP's network connection has been disconnected." | |
71 VAL 20 TCPIP_RESULT_NOT_READY "The operation failed because the TCP/IP entity was not yet initialised." | |
72 | |
73 VALTAB VAL_if_up | |
74 VAL 0 TCPIP_IFCONFIG_DOWN "Interface going down" | |
75 VAL 1 TCPIP_IFCONFIG_UP "Interface coming up" | |
76 | |
77 VALTAB VAL_dti_direction | |
78 VAL 0 TCPIP_DTI_TO_HIGHER_LAYER "Connect to higher layer, i. e. an application" | |
79 VAL 1 TCPIP_DTI_TO_LOWER_LAYER "Connect to lower layer, i. e. to protocol stack" | |
80 | |
81 VALTAB VAL_dti_conn | |
82 VAL 0 TCPIP_CONNECT_DTI "Connect the DTI link" | |
83 VAL 1 TCPIP_DISCONNECT_DTI "Disconnect the DTI link" | |
84 | |
85 | |
86 | |
87 | |
88 VAR app_handle "Application communication handle" L | |
89 | |
90 | |
91 VAR ipproto "IP protocol identifier" B | |
92 | |
93 VAL @p_tcpip - VAL_ipproto@ | |
94 | |
95 VAR request_id "Request ID" L | |
96 | |
97 | |
98 VAR event_type "Type of the event" L | |
99 | |
100 VAL @p_tcpip - VAL_event_type@ | |
101 | |
102 VAR result "Result code" B | |
103 | |
104 VAL @p_tcpip - VAL_result@ | |
105 | |
106 VAR socket "Socket descriptor" L | |
107 | |
108 | |
109 VAR port "Port number" S | |
110 | |
111 | |
112 VAR ipaddr "IP address" L | |
113 | |
114 | |
115 VAR hostname "Name of the host" B | |
116 | |
117 | |
118 VAR new_socket "Socket descriptor" L | |
119 | |
120 | |
121 VAR mtu_size "MTU size" S | |
122 | |
123 | |
124 VAR if_up "Interface Configuration direction" B | |
125 | |
126 VAL @p_tcpip - VAL_if_up@ | |
127 | |
128 VAR dnsaddr1 "IP address of first DNS server" L | |
129 | |
130 | |
131 VAR dnsaddr2 "IP address of second DNS server" L | |
132 | |
133 | |
134 VAR link_id "DTI link identifier" L | |
135 | |
136 | |
137 VAR entity_name "DTI neighbor entity name" L | |
138 | |
139 | |
140 VAR dti_direction "Direction of DTI connection" B | |
141 | |
142 VAL @p_tcpip - VAL_dti_direction@ | |
143 | |
144 VAR dti_conn "Indicates to connect or disconnect DTI link" B | |
145 | |
146 VAL @p_tcpip - VAL_dti_conn@ | |
147 | |
148 VAR data "Address of payload data" L | |
149 | |
150 | |
151 VAR window "Flow control window size" L | |
152 | |
153 | |
154 VAR buflen "Data buffer length" S | |
155 | |
156 | |
157 VAR msg_p "Message pointer" L | |
158 | |
159 | |
160 VAR msg_id "Message ID" L | |
161 | |
162 | |
163 | |
164 | |
165 | |
166 | |
167 | |
168 | |
169 ; TCPIP_INITIALIZE_REQ 0x80000048 | |
170 ; TCPIP_INITIALIZE_CNF 0x80004048 | |
171 ; TCPIP_SHUTDOWN_REQ 0x80010048 | |
172 ; TCPIP_SHUTDOWN_CNF 0x80014048 | |
173 ; TCPIP_IFCONFIG_REQ 0x80020048 | |
174 ; TCPIP_IFCONFIG_CNF 0x80024048 | |
175 ; TCPIP_DTI_REQ 0x80030048 | |
176 ; TCPIP_DTI_CNF 0x80034048 | |
177 ; TCPIP_CREATE_REQ 0x80040048 | |
178 ; TCPIP_CREATE_CNF 0x80044048 | |
179 ; TCPIP_CLOSE_REQ 0x80050048 | |
180 ; TCPIP_CLOSE_CNF 0x80054048 | |
181 ; TCPIP_BIND_REQ 0x80060048 | |
182 ; TCPIP_BIND_CNF 0x80064048 | |
183 ; TCPIP_LISTEN_REQ 0x80070048 | |
184 ; TCPIP_LISTEN_CNF 0x80074048 | |
185 ; TCPIP_CONNECT_REQ 0x80080048 | |
186 ; TCPIP_CONNECT_CNF 0x80084048 | |
187 ; TCPIP_DATA_REQ 0x80090048 | |
188 ; TCPIP_DATA_CNF 0x80094048 | |
189 ; TCPIP_DATA_IND 0x800A4048 | |
190 ; TCPIP_DATA_RES 0x800A0048 | |
191 ; TCPIP_SOCKNAME_REQ 0x800B0048 | |
192 ; TCPIP_SOCKNAME_CNF 0x800B4048 | |
193 ; TCPIP_PEERNAME_REQ 0x800C0048 | |
194 ; TCPIP_PEERNAME_CNF 0x800C4048 | |
195 ; TCPIP_HOSTINFO_REQ 0x800D0048 | |
196 ; TCPIP_HOSTINFO_CNF 0x800D4048 | |
197 ; TCPIP_MTU_SIZE_REQ 0x800E0048 | |
198 ; TCPIP_MTU_SIZE_CNF 0x800E4048 | |
199 ; TCPIP_CONNECT_IND 0x800F4048 | |
200 ; TCPIP_CONN_CLOSED_IND 0x80104048 | |
201 ; TCPIP_ERROR_IND 0x80114048 | |
202 ; TCPIP_INTERNAL_IND 0x800F0048 | |
203 | |
204 | |
205 | |
206 PRIM TCPIP_INITIALIZE_REQ 0x80000048 | |
207 { | |
208 } | |
209 | |
210 | |
211 | |
212 | |
213 | |
214 | |
215 PRIM TCPIP_INITIALIZE_CNF 0x80004048 | |
216 { | |
217 result ; Result code | |
218 } | |
219 | |
220 | |
221 | |
222 | |
223 | |
224 | |
225 PRIM TCPIP_SHUTDOWN_REQ 0x80010048 | |
226 { | |
227 } | |
228 | |
229 | |
230 | |
231 | |
232 | |
233 | |
234 PRIM TCPIP_SHUTDOWN_CNF 0x80014048 | |
235 { | |
236 result ; Result code | |
237 } | |
238 | |
239 | |
240 | |
241 | |
242 | |
243 | |
244 PRIM TCPIP_IFCONFIG_REQ 0x80020048 | |
245 { | |
246 if_up ; Direction of interface transition (coming up or going down) | |
247 mtu_size ; MTU size of interface (unused when interface goes down) | |
248 ipaddr ; IP address of interface (unused when interface goes down) | |
249 dnsaddr1 ; First DNS address (unused when interface goes down) | |
250 dnsaddr2 ; Second DNS address (unused when interface goes down) | |
251 } | |
252 | |
253 | |
254 | |
255 | |
256 | |
257 | |
258 PRIM TCPIP_IFCONFIG_CNF 0x80024048 | |
259 { | |
260 result ; Result code | |
261 } | |
262 | |
263 | |
264 | |
265 | |
266 | |
267 | |
268 PRIM TCPIP_DTI_REQ 0x80030048 | |
269 { | |
270 dti_conn ; DTI connect | |
271 entity_name ; Neighbor entity name | |
272 link_id ; DTI link identifier | |
273 dti_direction ; DTI link direction | |
274 } | |
275 | |
276 | |
277 | |
278 | |
279 | |
280 | |
281 PRIM TCPIP_DTI_CNF 0x80034048 | |
282 { | |
283 dti_conn ; DTI connect | |
284 link_id ; DTI link identifier | |
285 } | |
286 | |
287 | |
288 | |
289 | |
290 | |
291 | |
292 PRIM TCPIP_CREATE_REQ 0x80040048 | |
293 { | |
294 app_handle ; Application communication handle | |
295 ipproto ; IP protocol type | |
296 request_id ; Request ID (arbitrary value chosen by the application) | |
297 } | |
298 | |
299 | |
300 | |
301 | |
302 | |
303 | |
304 PRIM TCPIP_CREATE_CNF 0x80044048 | |
305 { | |
306 event_type ; Type of the event as passed to the application (TCPIP_CREATE_CNF) | |
307 result ; Result code | |
308 socket ; Descriptor of new socket (if result is TCPIP_RESULT_OK) | |
309 request_id ; Request ID as passed in TCPIP_CREATE_REQ | |
310 } | |
311 | |
312 | |
313 | |
314 | |
315 | |
316 | |
317 PRIM TCPIP_CLOSE_REQ 0x80050048 | |
318 { | |
319 app_handle ; Application communication handle | |
320 socket ; Socket descriptor | |
321 } | |
322 | |
323 | |
324 | |
325 | |
326 | |
327 | |
328 PRIM TCPIP_CLOSE_CNF 0x80054048 | |
329 { | |
330 event_type ; Type of the event as passed to the application (TCPIP_CLOSE_CNF) | |
331 result ; Result code | |
332 socket ; Socket descriptor | |
333 } | |
334 | |
335 | |
336 | |
337 | |
338 | |
339 | |
340 PRIM TCPIP_BIND_REQ 0x80060048 | |
341 { | |
342 app_handle ; Application communication handle | |
343 socket ; Socket descriptor | |
344 port ; Port number to bind the socket to | |
345 } | |
346 | |
347 | |
348 | |
349 | |
350 | |
351 | |
352 PRIM TCPIP_BIND_CNF 0x80064048 | |
353 { | |
354 event_type ; Type of the event as passed to the application (TCPIP_BIND_CNF) | |
355 result ; Result code | |
356 socket ; Socket descriptor | |
357 } | |
358 | |
359 | |
360 | |
361 | |
362 | |
363 | |
364 PRIM TCPIP_LISTEN_REQ 0x80070048 | |
365 { | |
366 app_handle ; Application communication handle | |
367 socket ; Socket descriptor | |
368 } | |
369 | |
370 | |
371 | |
372 | |
373 | |
374 | |
375 PRIM TCPIP_LISTEN_CNF 0x80074048 | |
376 { | |
377 event_type ; Type of the event as passed to the application (TCPIP_LISTEN_CNF) | |
378 result ; Result code | |
379 socket ; Socket descriptor | |
380 } | |
381 | |
382 | |
383 | |
384 | |
385 | |
386 | |
387 PRIM TCPIP_CONNECT_REQ 0x80080048 | |
388 { | |
389 app_handle ; Application communication handle | |
390 socket ; Socket descriptor | |
391 ipaddr ; IP address of remote peer to connect to | |
392 port ; Port number of remote peer to connect to | |
393 } | |
394 | |
395 | |
396 | |
397 | |
398 | |
399 | |
400 PRIM TCPIP_CONNECT_CNF 0x80084048 | |
401 { | |
402 event_type ; Type of the event as passed to the application (TCPIP_CONNECT_CNF) | |
403 result ; Result code | |
404 socket ; Socket descriptor | |
405 } | |
406 | |
407 | |
408 | |
409 | |
410 | |
411 | |
412 PRIM TCPIP_DATA_REQ 0x80090048 | |
413 { | |
414 app_handle ; Application communication handle | |
415 socket ; Socket descriptor | |
416 ipaddr ; Destination IP address | |
417 port ; Destination port number | |
418 buflen ; Data buffer length | |
419 data ; Payload data | |
420 } | |
421 | |
422 | |
423 | |
424 | |
425 | |
426 | |
427 PRIM TCPIP_DATA_CNF 0x80094048 | |
428 { | |
429 event_type ; Type of the event as passed to the application (TCPIP_DATA_CNF) | |
430 result ; Result code | |
431 socket ; Socket descriptor | |
432 window ; Flow control window size | |
433 } | |
434 | |
435 | |
436 | |
437 | |
438 | |
439 | |
440 PRIM TCPIP_DATA_IND 0x800A4048 | |
441 { | |
442 event_type ; Type of the event as passed to the application (TCPIP_DATA_IND) | |
443 result ; Result code | |
444 socket ; Socket descriptor | |
445 ipaddr ; Source IP address | |
446 port ; Source port number | |
447 buflen ; Data buffer length | |
448 data ; Payload data | |
449 } | |
450 | |
451 | |
452 | |
453 | |
454 | |
455 | |
456 PRIM TCPIP_DATA_RES 0x800A0048 | |
457 { | |
458 app_handle ; Application communication handle | |
459 socket ; Socket descriptor | |
460 window ; Flow control window size | |
461 } | |
462 | |
463 | |
464 | |
465 | |
466 | |
467 | |
468 PRIM TCPIP_SOCKNAME_REQ 0x800B0048 | |
469 { | |
470 app_handle ; Application communication handle | |
471 socket ; Socket descriptor | |
472 } | |
473 | |
474 | |
475 | |
476 | |
477 | |
478 | |
479 PRIM TCPIP_SOCKNAME_CNF 0x800B4048 | |
480 { | |
481 event_type ; Type of the event as passed to the application (TCPIP_SOCKNAME_CNF) | |
482 result ; Result code | |
483 socket ; Socket descriptor | |
484 ipaddr ; IP address of socket | |
485 port ; Port number of socket | |
486 } | |
487 | |
488 | |
489 | |
490 | |
491 | |
492 | |
493 PRIM TCPIP_PEERNAME_REQ 0x800C0048 | |
494 { | |
495 app_handle ; Application communication handle | |
496 socket ; Socket descriptor | |
497 } | |
498 | |
499 | |
500 | |
501 | |
502 | |
503 | |
504 PRIM TCPIP_PEERNAME_CNF 0x800C4048 | |
505 { | |
506 event_type ; Type of the event as passed to the application (TCPIP_PEERNAME_CNF) | |
507 result ; Result code | |
508 socket ; Socket descriptor | |
509 ipaddr ; IP address of remote peer | |
510 port ; Port number of remote peer | |
511 } | |
512 | |
513 | |
514 | |
515 | |
516 | |
517 | |
518 PRIM TCPIP_HOSTINFO_REQ 0x800D0048 | |
519 { | |
520 app_handle ; Application communication handle | |
521 ipaddr ; IP address of the host | |
522 hostname [TCPIP_HNAMELEN] ; Full-qualified domain name of the host | |
523 request_id ; Request ID (arbitrary value chosen by the application) | |
524 } | |
525 | |
526 | |
527 | |
528 | |
529 | |
530 | |
531 PRIM TCPIP_HOSTINFO_CNF 0x800D4048 | |
532 { | |
533 event_type ; Type of the event as passed to the application (TCPIP_SOCKNAME_CNF) | |
534 result ; Result code | |
535 socket ; Socket descriptor (unused) | |
536 hostname [TCPIP_HNAMELEN] ; Full-qualified domain name of the host | |
537 ipaddr ; IP address of the host | |
538 request_id ; Request ID as passed by in TCPIP_HOSTINFO_REQ | |
539 } | |
540 | |
541 | |
542 | |
543 | |
544 | |
545 | |
546 PRIM TCPIP_MTU_SIZE_REQ 0x800E0048 | |
547 { | |
548 app_handle ; Application communication handle | |
549 socket ; Socket descriptor | |
550 } | |
551 | |
552 | |
553 | |
554 | |
555 | |
556 | |
557 PRIM TCPIP_MTU_SIZE_CNF 0x800E4048 | |
558 { | |
559 event_type ; Type of the event as passed to the application (TCPIP_MTU_SIZE_CNF) | |
560 result ; Result code | |
561 socket ; Socket descriptor | |
562 mtu_size ; MTU size | |
563 } | |
564 | |
565 | |
566 | |
567 | |
568 | |
569 | |
570 PRIM TCPIP_CONNECT_IND 0x800F4048 | |
571 { | |
572 event_type ; Type of the event as passed to the application (TCPIP_CONNECT_IND) | |
573 result ; Result code (TCPIP_RESULT_OK) | |
574 socket ; Socket on which the connection has been accepted | |
575 new_socket ; New socket allocated for the connection | |
576 ipaddr ; IP address of the remote peer | |
577 port ; Port number on the remote side | |
578 } | |
579 | |
580 | |
581 | |
582 | |
583 | |
584 | |
585 PRIM TCPIP_CONN_CLOSED_IND 0x80104048 | |
586 { | |
587 event_type ; Type of the event as passed to the application (TCPIP_CONN_CLOSED_IND) | |
588 result ; Result code (TCPIP_RESULT_OK) | |
589 socket ; Socket of the connection that has been closed | |
590 } | |
591 | |
592 | |
593 | |
594 | |
595 | |
596 | |
597 PRIM TCPIP_ERROR_IND 0x80114048 | |
598 { | |
599 event_type ; Type of the event as passed to the application (TCPIP_ERROR_IND) | |
600 result ; Result code (one of TCPIP_RESULT_CONN_RESET, TCPIP_RESULT_CONN_ABORTED, or TCPIP_RESULT_UNREACHABLE) | |
601 socket ; Socket for which the error occured | |
602 } | |
603 | |
604 | |
605 | |
606 | |
607 | |
608 | |
609 PRIM TCPIP_INTERNAL_IND 0x800F0048 | |
610 { | |
611 msg_p ; Message pointer | |
612 msg_id ; Message ID | |
613 } | |
614 | |
615 | |
616 | |
617 | |
618 | |
619 | |
620 | |
621 | |
622 |